Squadcast Support

The Squadcast support Developer Hub

Welcome to the Squadcast support developer hub. You'll find comprehensive guides and documentation to help you start working with Squadcast support as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Event Tagging

Event tagging can help you add relevant information to incoming incidents to make it more context-rich for the user

Event tagging can help you add relevant information to incoming incidents to make it more context-rich for the user.

Auto Tagging Events

For each service, you can define your rule for event tagging.

You can set this up by going to app.squadcast.com.

  • Go to the relevant service
  • Click on the options dropdown
  • Choose Tagging Rules

You can add your tagging rule expression in the field "Tagging rule" and then add the tag key value pairs. You can select a colour of your choice for a tag key value by clicking on the circular colour button at the start of the map row. You can add as many tags by clicking on the "Add new mapping" button.

You can also add as many rules and configure as many key value mappings for each of these rules.

The tags will be visible against an incident in the incident dashboard and the incident details page.

Rule Evaluation Method

Every rule will be evaluated and all the tags of the matching rules will be attached to the incident.

Syntax for rules

The rule engine supports expressions with parameters, arithmetic, logical, and string operations.

  • Basic expression: 10 > 0, 1+2, 100/3
  • Parameterized expression: payload.metric == "disk"
    The available parameters are payload
    • payload : This parameter contains the JSON payload of an incident which will be the same as the JSON payload format for the future events.
  • Regular expression: re(payload.metric, "disk.*")
    This can be used to check if a particular JSON payload field matches a regular expression.
    • Parsing JSON content: jsonPath(payload.message, "a.b.c")
      This can be used to parse JSON formatted strings and get the jsonPath from the resulting JSON object.

Example

For a sample content shown in the right panel of the configuration space

{
    "payload" : {
        "metric" : "disk usage",
        "value" : 34,
        "host" : "sq-172-16-12-11",
        "alerting" : true,
        "tags" :  "{\"state\":\"alerting\", \"context\": {\"value\":\"disk_monitor\", \"metric\":34}}"
    }
}

Use Case: Setting Severity as a Tag

Assuming a case where disk usage events need to be prioritised:

When the disk usage is greater than 90% - critical and state tag is alerting
When the disk usage is between 60 - 90% - high
When the disk usage is less than 60% - low

Create 3 rules with the following configuration

Rules

Critical: payload.value > 90 && jsonPath(payload.tags, "state") == "alerting"
High: payload.value > 60 && payload.value < 90
Low: payload.value < 60

Manual Tagging

Adding Tags to a Manually Triggered Incident

When you create an incident manually via the + button, by default, you will have the option to add Tags to an incident. You can do so by assigning the tag name and tag value in the text fields provided and you can also change the tag color by clicking on the blue circle. You can also add multiple tags by clicking on the Add Tag option provided on the screen.

Updating Tags to an Existing Incident

You can choose to update tags for an existing incidents as well.

In order to do this, go to the Incident details page and click on the More Icon (three dots) against the Incident Message space of the page and click on Update Tags.

You can then assign the tag name and tag value in the text fields provided and you can also change the tag color by clicking on the color circle. You can also add multiple tags by clicking on the Add Tag option provided on the screen.

The updated tags will now reflect on the Incident Details page.

How-to-Video: Update Tags Manually

Event Tagging


Event tagging can help you add relevant information to incoming incidents to make it more context-rich for the user

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.