Chaos Toolkit OpenTracing Extension
Project description
# Chaos Toolkit Extension for Open Tracing
[![Build Status](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-opentracing.svg?branch=master)](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-opentracing)
This project is an extension for the Chaos Toolkit for [OpenTracing][].
[opentracing]: https://opentracing.io/
## Install
This package requires Python 3.5+
To be used from your experiment, this package must be installed in the Python
environment where [chaostoolkit][] already lives.
[chaostoolkit]: https://github.com/chaostoolkit/chaostoolkit
```
$ pip install -U chaostoolkit-opentracing
```
## Usage
Currently, this extension only provides control support to send traces to
your provider during the execution of the experiment. It does not yet expose
any probes or actions per-se.
To use this control, add the following section to your experiment, at the
top-level:
```json
{
"configuration": {
"tracing_provider": "jaeger",
"tracing_host": "127.0.0.1",
"tracing_port": 6831
},
"controls": [
{
"name": "opentracing",
"provider": {
"type": "python",
"module": "chaostracing.control"
}
}
]
}
```
This will automatically create a [Jaeger][] client to emit traces onto the
address `127.0.0.1:6831`.
[jaeger]: https://www.jaegertracing.io/
You may also access the tracer from other extensions as follows:
```python
import opentracing
def some_function(...):
opentracing.tracer
```
## Open Tracing Provider Support
For now, only the Jaeger tracer is supported but other providers will be added
as need be in the future.
### Jaeger tracer
To install the necessary dependencies for the Jaeger tracer, please run:
```
$ pip install chaostoolkit-opentracing[jaeger]
```
Unfortunately, the Jaeger client does not yet support Open Tracing 2.0.
## Test
To run the tests for the project execute the following:
```
$ pytest
```
## Contribute
If you wish to contribute more functions to this package, you are more than
welcome to do so. Please, fork this project, make your changes following the
usual [PEP 8][pep8] code style, sprinkling with tests and submit a PR for
review.
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
The Chaos Toolkit projects require all contributors must sign a
[Developer Certificate of Origin][dco] on each commit they would like to merge
into the master branch of the repository. Please, make sure you can abide by
the rules of the DCO before submitting a PR.
[dco]: https://github.com/probot/dco#how-it-works
[![Build Status](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-opentracing.svg?branch=master)](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-opentracing)
This project is an extension for the Chaos Toolkit for [OpenTracing][].
[opentracing]: https://opentracing.io/
## Install
This package requires Python 3.5+
To be used from your experiment, this package must be installed in the Python
environment where [chaostoolkit][] already lives.
[chaostoolkit]: https://github.com/chaostoolkit/chaostoolkit
```
$ pip install -U chaostoolkit-opentracing
```
## Usage
Currently, this extension only provides control support to send traces to
your provider during the execution of the experiment. It does not yet expose
any probes or actions per-se.
To use this control, add the following section to your experiment, at the
top-level:
```json
{
"configuration": {
"tracing_provider": "jaeger",
"tracing_host": "127.0.0.1",
"tracing_port": 6831
},
"controls": [
{
"name": "opentracing",
"provider": {
"type": "python",
"module": "chaostracing.control"
}
}
]
}
```
This will automatically create a [Jaeger][] client to emit traces onto the
address `127.0.0.1:6831`.
[jaeger]: https://www.jaegertracing.io/
You may also access the tracer from other extensions as follows:
```python
import opentracing
def some_function(...):
opentracing.tracer
```
## Open Tracing Provider Support
For now, only the Jaeger tracer is supported but other providers will be added
as need be in the future.
### Jaeger tracer
To install the necessary dependencies for the Jaeger tracer, please run:
```
$ pip install chaostoolkit-opentracing[jaeger]
```
Unfortunately, the Jaeger client does not yet support Open Tracing 2.0.
## Test
To run the tests for the project execute the following:
```
$ pytest
```
## Contribute
If you wish to contribute more functions to this package, you are more than
welcome to do so. Please, fork this project, make your changes following the
usual [PEP 8][pep8] code style, sprinkling with tests and submit a PR for
review.
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
The Chaos Toolkit projects require all contributors must sign a
[Developer Certificate of Origin][dco] on each commit they would like to merge
into the master branch of the repository. Please, make sure you can abide by
the rules of the DCO before submitting a PR.
[dco]: https://github.com/probot/dco#how-it-works
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for chaostoolkit-opentracing-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a858ddb76ced374fca688f7bf84bfc9b7e79c989c5228431bb1707480fd1454 |
|
MD5 | 7357e9df78f626c59b7b9b5b0c60fcde |
|
BLAKE2b-256 | ff484889e0ad438ccd0f8ca543629253cd2a85c5f2cffd252904c706d8484429 |
Close
Hashes for chaostoolkit_opentracing-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07f6f1f9be369316a3f8be4cd21b52d6e4285103432b850d94036df5211df367 |
|
MD5 | 3c354718c5a100ece70410686f80b0ff |
|
BLAKE2b-256 | d877dba039b08d2c9ba8db1e9a8da6746ba85a55acf93a684881204a2f03261f |