Skip to content

Commit 9d0c989

Browse files
committed
Streamlining common schema docs
1 parent 6da0079 commit 9d0c989

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

articles/azure-monitor/alerts/alerts-common-schema.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,19 @@ ms.reviewer: ofmanor
88

99
# Common alert schema
1010

11-
This article describes what the common alert schema is, the benefits of using it, and how to enable it.
11+
The common alert schema standardizes the consumption experience for alert notifications in Azure. Historically, activity log, metric, and log alerts each had their own email templates and webhook schemas. The common alert schema provides one standardized consistent consistent schema for all alert notifications.
1212

13-
## What is the common alert schema?
13+
A standardized schema can help you minimize the number of integrations, which makes the process of managing and maintaining them a much simpler task. Future alert payload enrichments like customization and diagnostic enrichment will only surface in the common schema.
1414

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.
15+
The new schema also enables a richer alert consumption experience across both the Azure portal and the Azure mobile app.
1616

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:
17+
> [!NOTE]
18+
> Alerts generated by [VM insights](../vm/vminsights-overview.md) currently don't support the common schema.
1819
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+
All alert instances include information about the affected resource and the cause of the alert in these sections:
21+
- **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. For example, if you want to route alert instances to specific teams based on criteria such as a resource group, you can use the essential fields to provide standardized routing logic for all alert types. The field teams can then use the context fields for their investigation.
2022
- **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.
2123

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-
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 enrichment will only surface in the common schema.
25-
2624
## What enhancements does the common alert schema bring?
2725

2826
You'll see the benefits of using a common alert schema in your alert notifications. A common alert schema provides these benefits:
@@ -32,11 +30,11 @@ You'll see the benefits of using a common alert schema in your alert notificatio
3230
| Email | A consistent and detailed email template. You can use it 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. |
3331
| 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. |
3432

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.
33+
3634

3735
Learn more about the [schema definitions for webhooks, Logic Apps, Azure Functions, and Automation runbooks](./alerts-common-schema-definitions.md).
3836

39-
> [!NOTE]
37+
4038
> The following actions don't support the common alert schema ITSM Connector.
4139
4240
## How do I enable the common alert schema?
@@ -46,7 +44,7 @@ Use action groups in the Azure portal or use the REST API to enable the common a
4644
> [!NOTE]
4745
> Smart detection alerts support the common schema by default. No opt-in is required.
4846
>
49-
> Alerts generated by [VM insights](../vm/vminsights-overview.md) currently don't support the common schema.
47+
>
5048
>
5149
5250
### Through the Azure portal

0 commit comments

Comments
 (0)