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.4.749498.tar.gz (58.0 kB view details)

Uploaded Source

Built Distribution

ychaos-0.4.749498-py3-none-any.whl (88.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.4.749498.tar.gz
  • Upload date:
  • Size: 58.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for ychaos-0.4.749498.tar.gz
Algorithm Hash digest
SHA256 f55cb7891eb436b586684b690afb3fe3708d72c2aaa25c6e1854d00900274eb4
MD5 2aa2d2ae11f554242657f9befba2111d
BLAKE2b-256 2c737a14839afd88bbaa6c3994f00374ac79c752d5d09bca411d24ded5bb9e97

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.4.749498-py3-none-any.whl
  • Upload date:
  • Size: 88.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for ychaos-0.4.749498-py3-none-any.whl
Algorithm Hash digest
SHA256 0880073d4252b72089d40b4f85c705d9063f61663fd474173638284335f6a5db
MD5 dab64b4cb31f854aff9e3871c83ba917
BLAKE2b-256 44d3385339d15c86f64572e0f145e7f4116b267ed039d0786cf86550e94d5cdf

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