search
Reliability HubAPI DocsPlatform
githubEdit

Experiment Badges

Get a badge for your experiment to integrate the latest run state, e.g., in wikis, ticketing tools, or wherever else it is valuable for you. You can easily integrate the badge using HTML, Markdown, or just a hosted image.

We support two badges:

  • an experiment badge that shows the latest run state of a specific experiment

  • an incident badge that either creates an experiment linked to an external reference or shows the latest run as soon as it is created state

hashtag
Experiment Badges

You can reference an experiment on any external web page using badges, like this one:

Example Badge

It’s an excellent way to get a link to your experiment and view the status without navigating and logging into the Steadybit platform.

Go to an experiment that interests you, and click on the experiment badge icon on the top right.

Steadybit Experiment Editor - Create Experiment Badge

You can choose your badge's desirable format and scale and copy the resulting script.

Steadybit Experiment Editor - Configure Experiment Badge

Alternatively, below are examples to copy and adjust to create your badge manually

hashtag
Example Markdown

hashtag
Example HTML

hashtag
Tag Badges

Experiment badges always link to a single existing experiment. If you want to refer to experiments that have a common purpose, you can instead use tag badges. Example use cases for this are linking to experiments reproducing a past issue from within your post-mortem documentation, indicating whether a specific architecture requirement is fulfilled, or providing visual evidence of the outcome of your latest disaster recovery test. Unlike experiment badges, tag badges can be created even if no experiment with the chosen tag exists, allowing you to use them as a call to action for creating a new experiment. This is how they look like in different states:

Tag badge when no experiment with the chosen tag exists
Tag badge when no experiment with the chosen tag exists
Tag badge when a single experiment with the chosen tag exists
Tag badge when a single experiment with the chosen tag exists
Tag badge when multiple experiments with the chosen tag exist
Tag badge when multiple experiments with the chosen tag exist

To create a tag badge, navigate to the Steadybit dashboard and click on 'Create a Badge'.

Steadybit Dashboard - Create a Badge

You then either choose an existing tag or create a new one. That tag will be automatically added to any experiment created via the badge and used to identify experiments that should be associated with it.

You can then configure the desired format and scale for your badge and provide the text that will be shown when no experiment with the chosen tag exists.

Steadybit Dashboard - Create a Tag Badge

Alternatively, below are some examples that you can copy and adjust to create your tag badge manually:

hashtag
Markdown

hashtag
HTML

Last updated

Was this helpful?