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

Uploaded Source

Built Distribution

ychaos-0.2.726398-py3-none-any.whl (78.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.2.726398.tar.gz
  • Upload date:
  • Size: 52.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.11

File hashes

Hashes for ychaos-0.2.726398.tar.gz
Algorithm Hash digest
SHA256 3df437d232a8f2ffaa5a50b420533995e86791402ac5bb13375c915a6f4737fc
MD5 c920c249cb4cf00f2b9e97c03f65f6d4
BLAKE2b-256 d1afe22bc57242cb32c27ab3e7c0b24a3572356c6a9927ec2ec22eac7038de31

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.2.726398-py3-none-any.whl
  • Upload date:
  • Size: 78.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.11

File hashes

Hashes for ychaos-0.2.726398-py3-none-any.whl
Algorithm Hash digest
SHA256 5edd73b7e7e4a33f6aac1b5616f0f597d9198b086116ba7400c5934672585734
MD5 01e0c34786972b004171cdd36cd4daab
BLAKE2b-256 7557a54ad9b2a7532a1f8f3484e778cc604f2249475e8c16e6a42d4d3f48f038

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