Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlafeldt/chaosmonkey
Go client to the Chaos Monkey REST API
https://github.com/mlafeldt/chaosmonkey
aws chaos-engineering chaos-monkey chaos-testing golang
Last synced: 3 months ago
JSON representation
Go client to the Chaos Monkey REST API
- Host: GitHub
- URL: https://github.com/mlafeldt/chaosmonkey
- Owner: mlafeldt
- License: mpl-2.0
- Created: 2016-03-31T21:07:01.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-20T15:25:11.000Z (over 4 years ago)
- Last Synced: 2024-06-20T02:06:16.114Z (8 months ago)
- Topics: aws, chaos-engineering, chaos-monkey, chaos-testing, golang
- Language: Go
- Homepage:
- Size: 164 KB
- Stars: 57
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# chaosmonkey
[](https://github.com/mlafeldt/chaosmonkey/actions)
[](https://godoc.org/github.com/mlafeldt/chaosmonkey/lib)
Go client to the [Chaos Monkey REST API](https://github.com/Netflix/SimianArmy/wiki/REST) that can be used to trigger and retrieve chaos events.
This project was started for the purpose of controlled failure injection during GameDay events.
## Prerequisites
First of all, you need a running [Simian Army](https://github.com/Netflix/SimianArmy) that exposes its REST API via HTTP.
In order to trigger chaos events via the API, Chaos Monkey must be unleashed and on-demand termination must be enabled via these configuration properties:
```
simianarmy.chaos.leashed = false
simianarmy.chaos.terminateOndemand.enabled = true
```
If you plan to use the REST API only, you should also disable all scheduled terminations:
```
simianarmy.chaos.asg.enabled = false
```
## CLI
### Installation
If you're on Mac OS X, the easiest way to get the `chaosmonkey` command-line tool is via Homebrew:
```bash
brew tap mlafeldt/formulas
brew install chaosmonkey
```
You can also build the tool from source, provided you have Go installed:
```bash
go get -u github.com/mlafeldt/chaosmonkey
```
### Usage
Use the tool to:
* Trigger a new chaos event:
```bash
chaosmonkey -endpoint http://example.com:8080 \
-group ExampleAutoScalingGroup -strategy ShutdownInstance
```
* Trigger the same event 5 times at intervals of 10 seconds, with a probability of 20% per event:
```bash
chaosmonkey -endpoint http://example.com:8080 \
-group ExampleAutoScalingGroup -strategy ShutdownInstance \
-count 5 -interval 10s -probability 0.2
```
This is useful to terminate more than one EC2 instance of an auto scaling group.
* Get a list of past chaos events:
```bash
chaosmonkey -endpoint http://example.com:8080
```
* List available chaos strategies, which you may pass to `-strategy`:
```bash
chaosmonkey -list-strategies
```
* List all auto scaling groups for a given AWS account, which you may then pass to `-group`:
```bash
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
export AWS_REGION=...
export AWS_ROLE=...
chaosmonkey -list-groups
```
* Wipe state of Chaos Monkey by deleting its SimpleDB domain (named `SIMIAN_ARMY` by default):
```bash
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
export AWS_REGION=...
export AWS_ROLE=...
chaosmonkey -wipe-state SIMIAN_ARMY
```
Warning: Requires a restart of Chaos Monkey.
As always, invoke `chaosmonkey -h` for a list of all available options.
In addition to command-line options, the tool also understands these environment variables:
* `CHAOSMONKEY_ENDPOINT` - the same as `-endpoint`
* `CHAOSMONKEY_USERNAME` - the same as `-username`
* `CHAOSMONKEY_PASSWORD` - the same as `-password`
### Use with Docker
[This Docker image](https://github.com/mlafeldt/docker-simianarmy) allows you to deploy Chaos Monkey with a single command:
```bash
docker run -it --rm -p 8080:8080 \
-e SIMIANARMY_CLIENT_AWS_ACCOUNTKEY=$AWS_ACCESS_KEY_ID \
-e SIMIANARMY_CLIENT_AWS_SECRETKEY=$AWS_SECRET_ACCESS_KEY \
-e SIMIANARMY_CLIENT_AWS_REGION=$AWS_REGION \
-e SIMIANARMY_CHAOS_LEASHED=false \
-e SIMIANARMY_CHAOS_ASG_ENABLED=false \
-e SIMIANARMY_CHAOS_TERMINATEONDEMAND_ENABLED=true \
mlafeldt/simianarmy
```
Afterwards, you can use `chaosmonkey` to talk to the dockerized Chaos Monkey:
```bash
chaosmonkey -endpoint http://$DOCKER_HOST_IP:8080 ...
```
## Go library
In addition to the CLI tool, the project also provides the `chaosmonkey` Go library for use in other Go projects. To install it from source:
```bash
go get -u github.com/mlafeldt/chaosmonkey/lib
```
For usage and examples, see the [Godoc documentation](https://godoc.org/github.com/mlafeldt/chaosmonkey/lib).
## Further resources
* [Article: Using Chaos Monkey whenever you feel like it](https://medium.com/production-ready/using-chaos-monkey-whenever-you-feel-like-it-e5fe31257a07#.vuftpxmm://medium.com/production-ready/using-chaos-monkey-whenever-you-feel-like-it-e5fe31257a07)
* [Article: A Little Story about Amazon ECS, systemd, and Chaos Monkey](https://medium.com/production-ready/a-little-story-about-amazon-ecs-systemd-and-chaos-monkey-8bc7d1b5778)
* [Talk: Chaos Monkey for Fun and Profit](https://mlafeldt.github.io/blog/chaos-monkey-for-fun-and-profit/)
* [Talk: Embracing Failure in a Container World](https://speakerdeck.com/mlafeldt/embracing-failure-in-a-container-world)
## Author
This project is being developed by [Mathias Lafeldt](https://twitter.com/mlafeldt).