Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

For an alert rule on a metric value, when the value of a specified metric crosses a threshold assigned, the alert rule becomes active and sends a notification. For an alert rule on events, a rule can send a notification on every event or only when a certain number of events happen.

​What does the integration offer?

Azure generates alerts based on metrics and events. Compass acts as a dispatcher for the alerts generated by Azure. Compass determines the right people to notify based on on-call schedules and escalations and notifies via email, text messages (SMS), phone calls, and Android & iOS push notifications.

Info

Compass supports the new Azure metrics alerts as well. With the Azure new metric alerts, new fields are added to the new Azure payload. Hence, you can accordingly configure the integration to support them. Read more about supported resources for metric alerts in Azure Monitor.

How does the integration work?

When an alert is created in Azure, an alert is automatically created in Compass through the integration.

Set up the integration

Azure is an API-based integration. Setting it up involves the following steps:

  • Add an Azure integration in Compass

  • Configure the integration in Azure

Add an Azure integration

Info

Bidirectional integrations aren’t supported in the Standard plan. All the other integrations are supported at a team level in Standard.
If you're using the Standard plan in Compass, you can add this integration only from your team’s operations page. Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team.

To add an Azure integration in Compass, complete the following steps:

  1. Go to your team’s operations page.

  2. On the left navigation panel, select Integrations and then Add integration.

  3. Run a search and select “Azure”.

  4. On the next screen, enter aname for the integration.

  5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

  6. Select Continue.
    The integration is saved at this point.

  7. Expand the Steps to configure the integration section and copy the integration URL generated for your account. You will use it while configuring the integration in Azure later.

  8. Select Turn on integration.
    The rules you create for the integration will work only if you turn on the integration.

Configure the integration in Azure

Azure Webhook alerts are only available via the Azure Preview Portal. If you have the classic version, use the Email integration.

To configure the integration in Azure, complete the following steps:

  1. In the Azure Portal, select Browse.

  2. Select a resource for which you want to generate alerts.

  3. In the Monitor section, select Alerts.

  4. Go to the Manage actions tab.

  5. Select Add-action-group to create a new action group.
    While adding actions, select Webhook for the action type.

  6. Paste the integration URL you copied while adding the integration in Compass into URI.

  7. Save the changes.

  8. Enable the common alert schema, if required.

  9. Go to Manage alert rules.

  10. Create a rule or edit an existing rule.

  11. Add conditions against which you want to create alerts.

  12. Add the Webhook action group you created in Step 5 in the Action Group section.

  13. Save the changes.

Sample payload sent from Azure (Classic)

Create alert payload (in JSON format)

Code Block
{
  "status": "Activated",
  "context": {
    "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.insights/alertrules/Alert_1_runscope12",
    "name": "Alert_1_runscope12",
    "description": "desc",
    "conditionType": "Metric",
    "condition": {
      "metricName": "Memory available",
      "metricUnit": "Bytes",
      "metricValue": "1032190976",
      "threshold": "2",
      "windowSize": "5",
      "timeAggregation": "Average",
      "operator": "GreaterThan"
    },
    "subscriptionId": "1a66ce04-b633-4a0b-b2bc-a912ec8986a6",
    "resourceGroupName": "montest",
    "timestamp": "2015-09-18T01:02:35.8190994Z",
    "resourceName": "helixtest1",
    "resourceType": "microsoft.compute/virtualmachines",
    "resourceId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/Microsoft.Compute/virtualMachines/Helixtest1",
    "resourceRegion": "centralus",
    "portalLink": "http://portallink.com"
  },
  "properties": {
    "hello1": "World1!",
    "json_stuff": {
      "type": "critical",
      "color": "red"
    },
    "customId": "wd39ue9832ue9iuhd9iuewhd9edh",
    "send_emails_to": "someone@somewhere.com"
  }
}

Payload parsed by Compass (in JSON format)

Code Block
{
  "status": "Activated",
  "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.insights/alertrules/Alert_1_runscope12",
  "name": "Alert_1_runscope12",
  "description": "desc",
  "condition_type": "Metric",
  "condition_metric_name": "Memory available",
  "condition_metric_unit": "Bytes",
  "condition_metric_value": "1032190976",
  "condition_threshold": "2",
  "condition_window_size": "5",
  "condition_time_aggregation": "Average",
  "condition_operator": "GreaterThan",
  "subscription_id": "1a66ce04-b633-4a0b-b2bc-a912ec8986a6",
  "resource_group_name": "montest",
  "timestamp": "2015-09-18T01:02:35.8190994Z",
  "resource_name": "helixtest1",
  "resource_type": "microsoft.compute/virtualmachines",
  "resource_id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/Microsoft.Compute/virtualMachines/Helixtest1",
  "resource_region": "centralus",
  "portal_link": "http://portallink.com"
}

Sample payload sent from Azure (New)

Create alert payload (in JSON format)

Code Block
{"schemaId":"AzureMonitorMetricAlert","data":
{
  "version": "2.0",
  "status": "Activated",
  "context": {
    "timestamp": "2018-02-28T10:44:10.1714014Z",
    "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Contoso/providers/microsoft.insights/metricAlerts/StorageCheck",
    "name": "StorageCheck",
    "description": "",
    "conditionType": "SingleResourceMultipleMetricCriteria",
    "condition": {
      "windowSize": "PT5M",
      "allOf": [
        {
          "metricName": "Transactions",
          "dimensions": [
            {
              "name": "AccountResourceId",
              "value": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Contoso/providers/Microsoft.Storage/storageAccounts/diag500"
            },
            {
              "name": "GeoType",
              "value": "Primary"
            }
          ],
          "operator": "GreaterThan",
          "threshold": "0",
          "timeAggregation": "PT5M",
          "metricValue": 1.0
        }
      ]
    },
    "subscriptionId": "00000000-0000-0000-0000-000000000000",
    "resourceGroupName": "Contoso",
    "resourceName": "diag500",
    "resourceType": "Microsoft.Storage/storageAccounts",
    "resourceId": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/Contoso/providers/Microsoft.Storage/storageAccounts/diag500",
    "portalLink": "https://portal.azure.com/#resource//subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Contoso/providers/Microsoft.Storage/storageAccounts/diag500"
  },
  "properties": {
    "key1": "value1",
    "key2": "value2"
  }
}
}

Payload parsed by Compass (in JSON format)

Code Block
{
  "schemaId": "AzureMonitorMetricAlert",
  "version": "2.0",
  "status": "Activated",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Contoso/providers/microsoft.insights/metricAlerts/StorageCheck",
  "name": "StorageCheck",
  "description": "",
  "condition_type": "SingleResourceMultipleMetricCriteria",
  "condition_metric_name": "Transactions",
  "condition_dimensions" : "[{name=AccountResourceId, value=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Contoso/providers/Microsoft.Storage/storageAccounts/diag500}, {name=GeoType, value=Primary}]",
  "condition_metric_value": "1.0",
  "condition_threshold": "0",
  "condition_window_size": "PT5M",
  "condition_time_aggregation": "PT5M",
  "condition_operator": "GreaterThan",
  "subscription_id": "00000000-0000-0000-0000-000000000000",
  "resource_group_name": "Contoso",
  "timestamp": "2018-02-28T10:44:10.1714014Z",
  "resource_name": "diag500",
  "resource_type": "Microsoft.Storage/storageAccounts",
  "resource_id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/Contoso/providers/Microsoft.Storage/storageAccounts/diag500",
  "portal_link": "https://portal.azure.com/#resource//subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Contoso/providers/Microsoft.Storage/storageAccounts/diag500"
}