1. Home
  2. Transmogrifier
  3. Transmogrifier: Annotations

Transmogrifier: Annotations

An annotation is simply a bit of information or link to a resource you can add to the payload of any incident that meets the matching condition for this rule. It can be a URL, an image URL, or a Note (just a blob of plain text). You can add multiple annotations to a single rule by clicking + Add an Annotation.

Select the drop-down menu for the annotation:

AnnotationTypeDropDown

URLs

When annotating a URL, you must add a “label”, which is the text that your users will see in the payload of the incident.  Clicking on the annotation will take the user directly to the URL.

If the payload from your monitoring tool includes a URL link in a field, you can use variable expansion (explained below) to import the value of that field into the annotation as you see here.

URLwithVariableExpansion

Variable Expansion The Transmogrifier can pull the content of an alert field into the rule, thus allowing users to dynamically update any annotation or transformation with data from the alert using the following syntax: ${{field_name}}

Common Example:  Appending a URL to a Runbook to the Alert

The Rule:

The Alert:


Image URLs

Any image hosted at a URL can be rendered as an image in the payload of an incident.  Please note that VictorOps does not accept attachments and we do not store images.  Any images annotated to incidents must be hosted and available via URL link.

If the payload from your monitoring tool includes an image URL in a field, you can use variable expansion (explained below) to import the value of that field into the annotation as you see here.
TransmogImageURL

Common Example: Appending Relevant Graphs/Charts to Alerts

The Rule:

The Alert:


Notes

Annotating a note into your incidents allows you to deliver a specific message to your users in plain text. Notes will be displayed in the Alert Annotations section at the top of the alert upon clicking More Info.

Updated on October 18, 2017

Was this article helpful?

Related Articles