Skip to main content

Python module ychaos

Project description

CI Pipeline codecov Python Support PyPi Code Style Documentation License

ychaos

YChaos is a self-serving chaos testing toolkit designed to provide users with all the capabilities of doing an end to end resilience testing of your service. YChaos is designed to give users a framework to validate, verify and attack your system to simulate real life failures that might cause outages in your service.

To get started with YChaos, refer to the documentation

Table of contents

  1. Background
  2. Install
  3. Usage
  4. Maintainers
  5. License

Background

The most important aspect of maintaining a web service on cloud infrastructure is to make it resilient from failures. Most of these failures are unexpected and are not tested while development. The service which is capable of handling an unexpected failure passes the criteria of a resilient service.

YChaos provides a self-serving framework to inject these unexpected failures into your service in the form of YChaos Agents and understand if your service is equipped to handle unknown failures either within the service or from a 3rd party service dependency.

Install

To install ychaos from PyPi,

pip install ychaos[<subpackage>]

The following subpackages are available for usage

  1. agents : pip install ychaos[agents]
  2. chaos : pip install ychaos[chaos]

To know more about each subpackage and what they do, refer to the documentation

You can also install the package from the source code.

git clone https://github.com/yahoo/ychaos
cd ychaos
pip install ".[<subpackage>]"

Usage

Refer to the documentation to know about the usage.

Maintainers

The Resilience Team @yahoo

License

This project is licensed under the terms of the Apache 2.0 open source license. Please refer to LICENSE for the full terms.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ychaos-0.1.722697.tar.gz (55.0 kB view details)

Uploaded Source

Built Distribution

ychaos-0.1.722697-py3-none-any.whl (78.4 kB view details)

Uploaded Python 3

File details

Details for the file ychaos-0.1.722697.tar.gz.

File metadata

  • Download URL: ychaos-0.1.722697.tar.gz
  • Upload date:
  • Size: 55.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for ychaos-0.1.722697.tar.gz
Algorithm Hash digest
SHA256 409b3102e00c792be0ad3557da771771f2268a7abbaf77e30ae3ad12337f3b9d
MD5 0a3394e31d65f3fc9bcf5cc3655caef2
BLAKE2b-256 46f35be68335341a2c5c6074853ffc27ad2ba7bbd358280619a4ae1256e8733e

See more details on using hashes here.

File details

Details for the file ychaos-0.1.722697-py3-none-any.whl.

File metadata

  • Download URL: ychaos-0.1.722697-py3-none-any.whl
  • Upload date:
  • Size: 78.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for ychaos-0.1.722697-py3-none-any.whl
Algorithm Hash digest
SHA256 b2d413a081640e580ab2d9ddafbf05802e584e734b7067ce15c474b929daa295
MD5 1bdcd064d1fb0165838b79368b76a331
BLAKE2b-256 6a4be1f6bd1f6dade8d6be6d74347597247495a95bf7872bd120b732d98d0d29

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page