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

Uploaded Source

Built Distribution

ychaos-0.2.737361-py3-none-any.whl (86.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.2.737361.tar.gz
  • Upload date:
  • Size: 57.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 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.2.737361.tar.gz
Algorithm Hash digest
SHA256 b80c5eec6e39a5439a64ca541da1cda5030a7a23d2223431366cb0329ccb2290
MD5 527e22ff9b03a7f1a7130649ad05f034
BLAKE2b-256 b160caf737b32ff970a6a58a2451d2653fb077f2a9b8e9ed045cc9cdc9453a96

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.2.737361-py3-none-any.whl
  • Upload date:
  • Size: 86.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 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.2.737361-py3-none-any.whl
Algorithm Hash digest
SHA256 c4b316f70110dc8a54710d080152daed46e6749c40da8235d9a696b43406c9d1
MD5 0c765a058dc561389b96a4625a2ba9f6
BLAKE2b-256 f4f72bfb497e5ecb7d308f120ade06f47e095c5b8b2196cadfa2e5947c222146

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