Skip to content

Commit ebd7340

Browse files
committed
minor edits
1 parent e0f0788 commit ebd7340

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,14 @@ The new schema enables a richer alert consumption experience across both the Azu
2424
> [!NOTE]
2525
> Alerts generated by [VM insights](../vm/vminsights-overview.md) do not support the common schema.
2626
27+
## Structure of the common schema
28+
2729
The common schema includes information about the affected resource and the cause of the alert in these sections:
2830
- **Essentials**: Standardized fields, used by all alert types that describe the resource affected by the alert and common alert metadata, such as severity or description.
2931

3032
If you want to route alert instances to specific teams based on criteria such as a resource group, you can use the fields in the **Essentials** section to provide routing logic for all alert types. The teams that receive the alert notification can then use the context fields for their investigation.
3133
- **Alert context**: Fields that vary depending on the type of the alert. The alert context fields describe the cause of the alert. 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.
3234

33-
3435
## Sample alert payload
3536

3637
```json
@@ -84,7 +85,7 @@ The common schema includes information about the affected resource and the cause
8485
}
8586
```
8687

87-
## Essentials
88+
## Essentials fields
8889

8990
| Field | Description|
9091
|:---|:---|
@@ -104,7 +105,7 @@ The common schema includes information about the affected resource and the cause
104105
|alertContextVersion | The version number for the `alertContext` section. |
105106

106107

107-
## Alert context for metric alerts
108+
## Alert context fields for metric alerts
108109

109110
### Sample metric alert with a static threshold and the monitoringService = `Platform`
110111

@@ -198,7 +199,7 @@ The common schema includes information about the affected resource and the cause
198199
}
199200
```
200201

201-
## Alert context for Log alerts
202+
## Alert context fields for Log alerts
202203

203204
> [!NOTE]
204205
> When you enable the common schema, the fields in the payload are reset to the common schema fields. Therefore, log alerts have these limitations regarding the common schema:
@@ -397,7 +398,7 @@ The common schema includes information about the affected resource and the cause
397398
}
398399
```
399400

400-
## Alert context for activity log alerts
401+
## Alert context fields for activity log alerts
401402

402403
### Sample activity log alert when the monitoringService = Activity Log - Administrative
403404

@@ -589,7 +590,9 @@ The common schema includes information about the affected resource and the cause
589590
}
590591
```
591592

592-
## Alert context for Prometheus alerts
593+
## Alert context fields for Prometheus alerts
594+
595+
### Sample Prometheus alert
593596

594597
```json
595598
{

0 commit comments

Comments
 (0)