You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-monitor/alerts/alerts-common-schema.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Common alert schema for Azure Monitor alerts
3
-
description: Understanding the common alert schema, why you should use it and how to enable it
3
+
description: Understand the common alert schema, why you should use it, and how to enable it.
4
4
ms.topic: conceptual
5
5
ms.date: 03/14/2019
6
6
ms.reviewer: ofmanor
@@ -12,59 +12,59 @@ This article describes what the common alert schema is, the benefits of using it
12
12
13
13
## What is the common alert schema?
14
14
15
-
The common alert schema standardizes the consumption experience for alert notifications in Azure today. Historically, the three alert types in Azure today (metric, log, and activity log) have had their own email templates, webhook schemas, etc. With the common alert schema, you can now receive alert notifications with a consistent schema.
15
+
The common alert schema standardizes the consumption experience for alert notifications in Azure. Today, Azure has three alert types, metric, log, and activity log. Historically, they've had their own email templates and webhook schemas. With the common alert schema, you can now receive alert notifications with a consistent schema.
16
16
17
-
Any alert instance describes **the resource that was affected** and **the cause of the alert**, and these instances are described in the common schema in the following sections:
17
+
Any alert instance describes the resource that was affected and the cause of the alert. These instances are described in the common schema in the following sections:
18
18
19
-
-**Essentials**: A set of **standardized fields**, common across all alert types, which describe **what resource** the alert is on along with additional common alert metadata (for example, severity or description).
20
-
-**Alert context**: A set of fields which describe the **cause of the alert**, with fields that vary **based on the alert type**. For example, a metric alert would have fields like the metric name and metric value in the alert context, whereas an activity log alert would have information about the event that generated the alert.
19
+
-**Essentials**: Standardized fields, common across all alert types, describe what resource the alert is on along with other common alert metadata. Examples include severity or description.
20
+
-**Alert context**: These fields describe the cause of the alert, with fields that vary based on the alert type. For example, a metric alert would have fields like the metric name and metric value in the alert context. An activity log alert would have information about the event that generated the alert.
21
21
22
-
The typical integration scenarios we hear from customers involve the routing of the alert instance to the concerned team based on some pivot (for example, resource group), after which the responsible team starts working on it. With the common alert schema, you can have standardized routing logic across alert types by leveraging the essential fields, leaving the context fields as is for the concerned teams to investigate further.
22
+
You might want to route the alert instance to a specific team based on a pivot such as a resource group. The common schema uses the essential fields to provide standardized routing logic for all alert types. The team can use the context fields for their investigation.
23
23
24
-
This means that you can potentially have fewer integrations, making the process of managing and maintaining them a _much_ simpler task. Additionally, future alert payload enrichments (for example, customization, diagnostic enrichment, etc.) will only surface up in the common schema.
24
+
As a result, you can potentially have fewer integrations, which makes the process of managing and maintaining them a much simpler task. Future alert payload enrichments like customization and diagnostic enrichmentwill only surface in the common schema.
25
25
26
26
## What enhancements does the common alert schema bring?
27
27
28
-
The common alert schema will primarily manifest itself in your alert notifications. The enhancements that you will see are listed below:
28
+
You'll see the benefits of using a common alert schema in your alert notifications. A common alert schema provides these benefits:
29
29
30
30
| Action | Enhancements|
31
31
|:---|:---|
32
-
| Email | A consistent and detailed email template, allowing you to easily diagnose issues at a glance. Embedded deep-links to the alert instance on the portal and the affected resource ensure that you can quickly jump into the remediation process. |
33
-
| Webhook/Logic App/Azure Function/Automation Runbook| A consistent JSON structure for all alert types, which allows you to easily build integrations across the different alert types. |
32
+
| Email | A consistent and detailed email template. You can use it to easily diagnose issues at a glance. Embedded deeplinks to the alert instance on the portal and the affected resource ensure that you can quickly jump into the remediation process. |
33
+
| Webhook/Azure Logic Apps/Azure Functions/Azure Automation runbook| A consistent JSON structure for all alert types. You can use it to easily build integrations across the different alert types. |
34
34
35
35
The new schema will also enable a richer alert consumption experience across both the Azure portal and the Azure mobile app in the immediate future.
36
36
37
-
[Learn more about the schema definitions for Webhooks/Logic Apps/Azure Functions/Automation Runbooks.](./alerts-common-schema-definitions.md)
37
+
Learn more about the [schema definitions for webhooks, Logic Apps, Azure Functions, and Automation runbooks](./alerts-common-schema-definitions.md).
38
38
39
39
> [!NOTE]
40
-
> The following actions do not support the common alert schema: ITSM Connector.
40
+
> The following actions don't support the common alert schema ITSM Connector.
41
41
42
42
## How do I enable the common alert schema?
43
43
44
-
You can opt in or opt out to the common alert schema through Action Groups, on both the portal and through the REST API. The toggle to switch to the new schema exists at an action level. For example, you have to separately opt in for an email action and a webhook action.
44
+
Use action groups in the Azure portal or use the REST API to enable the common alert schema. You can enable a new schema at the action level. For example, you must separately opt in for an email action and a webhook action.
45
45
46
46
> [!NOTE]
47
-
> 1. The following alert types support the common schema by default (no opt-in required):
48
-
>- Smart detection alerts
49
-
> 1. The following alert types currently do not support the common schema:
50
-
>- Alerts generated by [VM insights](../vm/vminsights-overview.md)
47
+
> Smart detection alerts support the common schema by default. No opt-in is required.
48
+
>
49
+
> Alerts generated by [VM insights](../vm/vminsights-overview.md) currently don't support the common schema.

55
55
56
-
1. Open any existing or a new action in an action group.
57
-
1. Select ‘Yes’ for the toggle to enable the common alert schema as shown.
56
+
1. Open any existing action or a new action in an action group.
57
+
1. Select **Yes**to enable the common alert schema.
58
58
59
59
### Through the Action Groups REST API
60
60
61
-
You can also use the [Action Groups API](/rest/api/monitor/actiongroups) to opt in to the common alert schema. While making the [create or update](/rest/api/monitor/actiongroups/createorupdate) REST API call, you can set the flag "useCommonAlertSchema" to 'true' (to opt in) or 'false' (to opt out) for any of the following actions - email/webhook/logic app/Azure Function/automation runbook.
61
+
You can also use the [Action Groups API](/rest/api/monitor/actiongroups) to opt in to the common alert schema. While you make the [create or update](/rest/api/monitor/actiongroups/createorupdate) REST API call, you can set the flag "useCommonAlertSchema" to `true`to opt in or `false`to opt out for email, webhook, Logic Apps, Azure Functions, or Automation runbook actions.
62
62
63
-
For example, the following request body made to the [create or update](/rest/api/monitor/actiongroups/createorupdate) REST API will do the following:
63
+
For example, the following request body made to the [create or update](/rest/api/monitor/actiongroups/createorupdate) REST API will:
64
64
65
-
- Enable the common alert schema for the email action "John Doe's email"
66
-
- Disable the common alert schema for the email action "Jane Smith's email"
67
-
- Enable the common alert schema for the webhook action "Sample webhook"
65
+
- Enable the common alert schema for the email action "John Doe's email."
66
+
- Disable the common alert schema for the email action "Jane Smith's email."
67
+
- Enable the common alert schema for the webhook action "Sample webhook."
68
68
69
69
```json
70
70
{
@@ -110,5 +110,5 @@ For example, the following request body made to the [create or update](/rest/api
110
110
111
111
## Next steps
112
112
113
-
-[Common alert schema definitions for Webhooks/Logic Apps/Azure Functions/Automation Runbooks.](./alerts-common-schema-definitions.md)
114
-
-[Learn how to create a logic app that leverages the common alert schema to handle all your alerts.](./alerts-common-schema-integrations.md)
113
+
-[Learn the common alert schema definitions for webhooks, Logic Apps, Azure Functions, and Automation runbooks](./alerts-common-schema-definitions.md)
114
+
-[Learn how to create a logic app that uses the common alert schema to handle all your alerts](./alerts-common-schema-integrations.md)
0 commit comments