Git Product home page Git Product logo

chaostoolkit-instana's Introduction

Chaos Toolkit Instana Extension

Build Status Python versions Requirements Status Has wheel

This extension package provides probes and actions for Chaos Engineering experiments against a Instana instance using the Chaos Toolkit.

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.

$ pip install -U chaostoolkit-instana

Usage

To use the probes and actions from this package, add the following secrets and configuration to your environment or experiments file:

Secrets

  • INSTANA_API_TOKEN - Token for accessing the Instana API

Configuration

  • INSTANA_HOST - Host of the Instana instance that you wish to connect to

A collection of samples are provided so you can see existing probes and actions.

Discovery

You may use the Chaos Toolkit to discover the capabilities of this extension:

$ chaos discover chaostoolkit-instana --no-install

If you have logged in against a Instana environment, this will discover information about it along the way.

Configuration

Test

To run the tests for the project execute the following:

$ pip install -r requirements-dev.txt
$ 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 code style, sprinkling with tests and submit a PR for review.

The Chaos Toolkit projects require all contributors must sign a Developer Certificate of Origin 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.

Develop

If you wish to develop on this project, make sure to install the development dependencies. But first, create a virtual environment and then install those dependencies.

$ pip install -r requirements-dev.txt -r requirements.txt

Then, point your environment to this directory:

$ pip install -e .

Now, you can edit the files and they will be automatically be seen by your environment, even when running from the chaos command locally.

chaostoolkit-instana's People

Contributors

gtfisher avatar lawouach avatar russmiles avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

chaostoolkit-instana's Issues

Optional delay

Add an optional delay in probes to allow for the changes to propagate in the instana system

error status code handling on instana api

When running instana experiments the api was returning an error status code due to a malformed url in an environment variable, an error should be logged to clearly identify the error status code has occurred

Create anyWarningEvents probe

This probe would return a boolean to indicate if any critical events had been raised in the specified time window.

Parameters would be a window of time (start, end) and an optional delay parameter, defaulted to 5 seconds, as Instana's model can be up to 5 seconds behind the feeds from the target system.

Create getEventContents probe

Mostly for use inside an experiment's method to enrich the resulting journal.

API call would take the approximate form of:

curl --request GET \
  --url '.../api/events/<eventID>' \
  --header 'authorization: apiToken ********'

Create anyWarningOrCriticalEvents probe

This probe would return a boolean to indicate if any warning _or_critical events had been raised in the specified time window.

Parameters would be a window of time (start, end) and an optional delay parameter, defaulted to 5 seconds, as Instana's model can be up to 5 seconds behind the feeds from the target system.

Create getAllEvents probe

The probe's signature will likely look like:

getAllEvents: string

And simply return the full json in a string to be used to enrich an experiment's journal. This probe is unlikely to be useful to steady-state hypothesis work.

The underlying API call will implement:

> curl --request GET \
  --url '.../api/events?from=1554143400000&to=1554237055206' \
  --header 'authorization: apiToken ********' 

Create anyCriticalEvents probe

This probe would return a boolean to indicate if any critical events had been raised in the specified time window.

Parameters would be a window of time (start, end) and an optional delay parameter as Instana's model can be up to 5 seconds behind the feeds from the target system.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.