Integrate with Microsoft Azure Event Hubs

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 Event Hubs can generate alerts based on metrics. 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 and iOS push notifications.

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. Learn more about Supported resources for metric alerts in Azure Monitor - Azure Monitor.

How does the integration work?

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

Set up the integration

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

Add an Azure Event Hubs integration in Compass
Configure the integration in Azure Event Hubs

Add Azure Event Hubs integration

In this release, only incoming integrations are fully supported in the Standard plan, at a team level. To use outgoing integrations or the outgoing part of bidirectional integrations, upgrade to a higher subscription plan. There may be restrictions on how you can create and apply integration rules as well.

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 Event Hubs integration in Compass, complete the following steps:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Azure Event Hubs”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the integration URL generated for your account.
You will use this URL while configuring the integration in Azure later.
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 Event Hubs

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

In the Azure Portal, go to the Events Hubs page.
Browse the event hub namespace for which you want to add alerts.
In the Monitoring section, select Alerts.
Go to the Action Groups tab.
Select Create to create a new action group.
While adding actions, select Webhook for the action type.
Paste the integration URL previously copied from Compass into URI.
Enable the common alert schema if required.
Save the changes.
Go to the Alert rules tab.
Create a rule or edit an existing rule.
Add conditions for filtering alerts.
In the Action Group section, add the Webhook action group you created in Step 5.
Save the changes.

Sample payload sent from Azure Metric Alert

Create alert payload (in JSON format)

{
    "schemaId": "AzureMonitorMetricAlert",
    "data": {
        "version": "2.0",
        "properties": null,
        "status": "Activated",
        "context": {
            "timestamp": "2020-06-24T10:28:19.3462700Z",
            "id": "/subscriptions/25b83e19-ab0d-4579-ad81-asdas-sadasda/resourceGroups/test_eventhub_group/providers/microsoft.insights/metricalerts/test-eventhub-alerts",
            "name": "test-eventhub-alerts",
            "description": "test description for alert",
            "conditionType": "SingleResourceMultipleMetricCriteria",
            "severity": "3",
            "condition": {
                "windowSize": "PT1M",
                "allOf": [{
                    "metricName": "SuccessfulRequests",
                    "metricNamespace": "Microsoft.EventHub/namespaces",
                    "operator": "GreaterThan",
                    "threshold": "2",
                    "timeAggregation": "Total",
                    "dimensions": [{
                        "name": "ResourceId",
                        "value": "25b83e19-ab0d-4579-ad81-d0280e506bb3:test-eventhub-og"
                    }, {
                        "name": "EntityName",
                        "value": "test-eventhub"
                    }, {
                        "name": "OperationResult",
                        "value": "Success"
                    }],
                    "metricValue": 8.0,
                    "webTestName": null
                }, {
                    "metricName": "IncomingRequests",
                    "metricNamespace": "Microsoft.EventHub/namespaces",
                    "operator": "GreaterThan",
                    "threshold": "3",
                    "timeAggregation": "Total",
                    "dimensions": [{
                        "name": "ResourceId",
                        "value": "25b83e19-ab0d-4579-ad81-d0280e506bb3:test-eventhub-og"
                    }, {
                        "name": "EntityName",
                        "value": "test-eventhub"
                    }],
                    "metricValue": 8.0,
                    "webTestName": null
                }]
            },
            "subscriptionId": "25b83e19-ab0d-4579-ad81-d0280e506bb3",
            "resourceGroupName": "test_eventhub_group",
            "resourceName": "test-eventhub-og",
            "resourceType": "Microsoft.EventHub/namespaces",
            "resourceId": "/subscriptions/25b83e19-ab0d-4579-ad81-d0280e506bb3/resourceGroups/test_eventhub_group/providers/Microsoft.EventHub/namespaces/test-eventhub-og",
            "portalLink": "https://portal.azure.com/#resource/subscriptions/25b83e19-ab0d-4579-ad81-d0280e506bb3/resourceGroups/test_eventhub_group/providers/Microsoft.EventHub/namespaces/test-eventhub-og"
        }
    }
}

Sample payload sent from Azure Common Alert Schema

(in JSON format)

{
    "schemaId": "azureMonitorCommonAlertSchema",
    "data": {
        "essentials": {
            "alertId": "/subscriptions/25b83e19-ab0d-4579-ad81-d0280e506bb3/providers/Microsoft.AlertsManagement/alerts/7ccad036-8973-49e9-b628-a18350fb32bb",
            "alertRule": "test-eventhub-alerts",
            "severity": "Sev3",
            "signalType": "Metric",
            "monitorCondition": "Fired",
            "monitoringService": "Platform",
            "alertTargetIDs": ["/subscriptions/25b83e19-ab0d-4579-ad81-d0280e506bb3/resourcegroups/test_eventhub_group/providers/microsoft.eventhub/namespaces/test-eventhub-og"],
            "originAlertId": "25b83e19-ab0d-4579-ad81-d0280e506bb3_test_eventhub_group_microsoft.insights_metricalerts_test-eventhub-alerts_-121967519",
            "firedDateTime": "2020-06-29T18:41:05.7016722Z",
            "description": "",
            "essentialsVersion": "1.0",
            "alertContextVersion": "1.0"
        },
        "alertContext": {
            "properties": null,
            "conditionType": "SingleResourceMultipleMetricCriteria",
            "condition": {
                "windowSize": "PT1M",
                "allOf": [{
                    "metricName": "SuccessfulRequests",
                    "metricNamespace": "Microsoft.EventHub/namespaces",
                    "operator": "GreaterThan",
                    "threshold": "2",
                    "timeAggregation": "Total",
                    "dimensions": [{
                        "name": "ResourceId",
                        "value": "25b83e19-ab0d-4579-ad81-d0280e506bb3:test-eventhub-og"
                    }, {
                        "name": "EntityName",
                        "value": "test-eventhub"
                    }, {
                        "name": "OperationResult",
                        "value": "Success"
                    }],
                    "metricValue": 4.0,
                    "webTestName": null
                }],
                "windowStartTime": "2020-06-29T18:38:52.06Z",
                "windowEndTime": "2020-06-29T18:39:52.06Z"
            }
        }
    }
}

Operations