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

Uploaded Source

Built Distribution

ychaos-0.4.740575-py3-none-any.whl (88.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.4.740575.tar.gz
  • Upload date:
  • Size: 57.8 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.4.740575.tar.gz
Algorithm Hash digest
SHA256 7a71350b4f7b46257bd3ff12164a2d1d054290687ba3090ae9f3c315da4fa790
MD5 34a7e017a3373eaa4510297a8c0bbc60
BLAKE2b-256 09ef2a35f41f19e5822b7c5edfe578783c741a977d8b3a7387f1ec182af61b57

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.4.740575-py3-none-any.whl
  • Upload date:
  • Size: 88.6 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.4.740575-py3-none-any.whl
Algorithm Hash digest
SHA256 5b70045486beff2da7b212851d825ed05388db113618af21a1ac103ff37232ac
MD5 e5fd5871000e5ddb2bdd4c0136b79c84
BLAKE2b-256 638722f5dd9247f9b9d03b2d7ac123adf24175573727b32ee027a7a96120589a

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