Custom Tags in Events, Alerts, and Incidents

The Events API and Metrics API are designed to be flexible and generic. Both schemas include a tags field that you can use to specify custom information, for example:

"tags": {
    "jira-ticket":"RGB-2654",
    "error-code" : "x1F391",
    "default-sprint":"dazzling-wright",
    "scrum-team":"spifftacular-brainiacs"
}

Moogsoft includes all tags whenever it adds an event to an alert or an alert to an incident.

Tags can be useful for outbound integrations to external tools such as Slack, Datadog, and PagerDuty:

  • You can include a tag filter in an outbound integration to specify which alerts or incidents trigger notifications.

  • You can also include individual tag fields, or the entire tag object, in the body of the outbound notification. For example:

    { "message":"Issue # $id with severity $severity and description $description","timestamp":"$created_at","tags":"$tags"}

Tags requirements and good practices

  • Use strings or numbers for values, not lists or maps.

  • Keys and values are case-sensitive.

  • Avoid special characters except the following: + - = . _ : /

  • Do not define more than 50 tags per individual source. Each tag key should be unique and have one value.

  • Keys can be up to 128 Unicode characters (UTF-8). Values can be up to 256 Unicode characters.

  • Keys that start with aws: are reserved for AWS resources.