Skip to content

Commit 42abdc2

Browse files
amee-sumojpipkin1sumoanemaJV0812
authored
Update Azure Event Grid with Azure metrics source compatibility (#5466)
* Update azure-event-grid.md * Update docs/integrations/microsoft-azure/azure-event-grid.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/microsoft-azure/azure-event-grid.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Azure event hub doc update - updated dahsboard and screenshot link * Update azure-event-grid.md --------- Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> Co-authored-by: sumoanema <[email protected]> Co-authored-by: Jagadisha V <[email protected]> Co-authored-by: Alekh Nema <[email protected]>
1 parent 5e6c985 commit 42abdc2

File tree

1 file changed

+58
-125
lines changed

1 file changed

+58
-125
lines changed

docs/integrations/microsoft-azure/azure-event-grid.md

Lines changed: 58 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ For Azure Event Grid, you can collect the following logs and metrics:
1919
* [Microsoft.EventGrid/domains](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-eventgrid-domains-metrics)
2020
* [Microsoft.EventGrid/systemTopics](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-eventgrid-systemtopics-metrics)
2121
* [Microsoft.EventGrid/topics](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-eventgrid-topics-metrics)
22-
* [Microsoft.EventGrid/namespaces](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-eventgrid-namespaces-metrics)
23-
* [Microsoft.EventGrid/extensionTopics](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-eventgrid-extensiontopics-metrics)
24-
* [Microsoft.EventGrid/eventSubscriptions](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-eventgrid-eventsubscriptions-metrics)
2522

2623
For more information on supported dimensions, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/event-grid/monitor-push-reference#metrics).
2724

@@ -30,123 +27,23 @@ For more information on supported dimensions, refer to [Azure documentation](htt
3027
Azure service sends monitoring data to Azure Monitor, which can then [stream data to Eventhub](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/stream-monitoring-data-event-hubs). Sumo Logic supports:
3128

3229
* Logs collection from [Azure Monitor](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-get-started) using our [Azure Event Hubs source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
33-
* Metrics collection using our [HTTP Logs and Metrics source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/) via Azure Functions deployed using the ARM template.
30+
* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
3431

3532
You must explicitly enable diagnostic settings for each domain, namespace, custom topic, and system topic you want to monitor. You can forward logs to the same event hub provided they satisfy the limitations and permissions as described [here](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#destination-limitations).
3633

3734
When you configure the event hubs source or HTTP source, plan your source category to ease the querying process. A hierarchical approach allows you to make use of wildcards. For example: `Azure/EventGrid/Logs`, `Azure/EventGrid/Metrics`.
3835

39-
### Configure field in field schema
40-
41-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
42-
1. Search for the following fields:
43-
- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
44-
- `location`. The region to which the resource name belongs.
45-
- `subscription_id`. ID associated with a subscription where the resource is present.
46-
- `resource_group`. The resource group name where the Azure resource is present.
47-
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
48-
- `resource_type`. Azure resource type (for example, storage accounts).
49-
- `resource_name`. The name of the resource (for example, storage account name).
50-
- `service_type`. Type of the service that can be accessed with an Azure resource.
51-
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Event Grid service is Subscriptions).
52-
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
53-
54-
### Configure field extraction rules
55-
56-
Create the following Field Extraction Rule(s) (FER) for Azure Storage by following the instructions in [Create a Field Extraction Rule](/docs/manage/field-extractions/create-field-extraction-rule/).
57-
58-
#### Azure location extraction FER
59-
60-
```sql
61-
Rule Name: AzureLocationExtractionFER
62-
Applied at: Ingest Time
63-
Scope (Specific Data): tenant_name=*
64-
```
65-
66-
```sql title="Parse Expression"
67-
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
68-
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
69-
| if (!isBlank(resourceLocation), resourceLocation, location) as location
70-
| if (!isBlank(service_region), service_region, location) as location
71-
| if (isBlank(location), "global", location) as location
72-
| fields location
73-
```
74-
75-
#### Resource ID extraction FER
76-
77-
```sql
78-
Rule Name: AzureResourceIdExtractionFER
79-
Applied at: Ingest Time
80-
Scope (Specific Data): tenant_name=*
81-
```
82-
83-
```sql title="Parse Expression"
84-
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
85-
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
86-
| toUpperCase(resourceId) as resourceId
87-
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
88-
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
89-
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
90-
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
91-
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
92-
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
93-
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
94-
```
95-
96-
### Configure metric rules
97-
98-
Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule).
99-
100-
#### Azure observability metadata extraction service level
101-
102-
If this rule already exists, there is no need to create it again.
103-
104-
```sql
105-
Rule Name: AzureObservabilityMetadataExtractionServiceLevel
106-
```
107-
108-
```sql title="Metric match expression"
109-
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/*/*/*/* tenant_name=*
110-
```
111-
| Fields extracted | Metric rule |
112-
|------------------|----------------|
113-
| subscription_id | $resourceId._1 |
114-
| resource_group | $resourceId._2 |
115-
| provider_name | $resourceId._3 |
116-
| resource_type | $resourceId._4 |
117-
| resource_name | $resourceId._5 |
118-
| service_type | $resourceId._6 |
119-
| service_name | $resourceId._7 |
120-
121-
#### Azure observability metadata extraction event grid level
122-
123-
```sql
124-
Rule Name: AzureObservabilityMetadataExtractionAzureEventGridLevel
125-
```
126-
127-
```sql title="Metric match expression"
128-
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.EVENTGRID/*/* tenant_name=*
129-
```
130-
| Fields extracted | Metric rule |
131-
|:------------------|:--------------------|
132-
| subscription_id | $resourceId._1 |
133-
| resource_group | $resourceId._2 |
134-
| provider_name | MICROSOFT.EVENTGRID |
135-
| resource_type | $resourceId._3 |
136-
| resource_name | $resourceId._4 |
137-
13836
### Configure metrics collection
13937

140-
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, onto an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
38+
To set up the Azure Metrics source in Sumo Logic, refer to [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
39+
40+
:::note
41+
Sumo Logic Metrics source is currently in Beta, to participate, contact your Sumo Logic account executive.
42+
:::
43+
44+
1. To set up the Azure Metrics source in Sumo Logic, refer to the shared beta documentation.
45+
1. In the Sumo Logic Azure Metrics source configuration, configure namespaces as `Microsoft.EventGrid/domains`, `Microsoft.EventGrid/systemTopics` and `Microsoft.EventGrid/topics`.
14146

142-
1. Create a hosted collector and tag the `tenant_name` field. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name). <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Tenant-Name.png')} alt="Azure Tag Tenant Name" style={{border: '1px solid gray'}} width="500" />
143-
1. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
144-
1. [Configure and deploy the ARM Template](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-2-configure-azure-resources-using-arm-template).
145-
1. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Perform the steps below for each Azure Event Grid namespace that you want to monitor.
146-
1. Choose `Stream to an event hub` as the destination.
147-
1. Select `AllMetrics`.
148-
1. Use the Event Hub namespace created by the ARM template in Step 2 above. You can create a new Event Hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/send-data/azure-event-grid-metrics.png')} alt="Azure event grid metrics" style={{border: '1px solid gray'}} width="800" />
149-
1. Tag the location field in the source with the right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Event Grid Tag Location" style={{border: '1px solid gray'}} width="400" />
15047

15148
### Configure logs collection
15249

@@ -172,19 +69,31 @@ Since this source contains logs from multiple regions, make sure that you do not
17269

17370
Now that you have set up data collection, install the Azure Event Grid Sumo Logic app to use the pre-configured [dashboards](#viewing-the-azure-event-grid-dashboards) that provide visibility into your environment for real-time analysis of Azure resources.
17471

175-
import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2.md';
72+
import AppInstallIndexV2 from '../../reuse/apps/app-install-index-option.md';
17673

177-
<AppInstallNoDataSourceV2/>
74+
<AppInstallIndexV2/>
75+
76+
As part of the app installation process, the following fields will be created by default:
77+
78+
- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
79+
- `location`. The region the resource name belongs to.
80+
- `subscription_id`. ID associated with a subscription where the resource is present.
81+
- `resource_group`. The resource group name where the Azure resource is present.
82+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
83+
- `resource_type`. Azure resource type (for example, storage accounts).
84+
- `resource_name`. The name of the resource (for example, storage account name).
85+
- `service_type`. Type of the service that can be accessed with an Azure resource.
86+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).
17887

17988
## Viewing the Azure Event Grid dashboards
18089

181-
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
90+
import ViewDashboardsIndex from '../../reuse/apps/view-dashboards-index.md';
18291

183-
<ViewDashboards/>
92+
<ViewDashboardsIndex/>
18493

18594
### Overview
18695

187-
**Azure Event Grid - Overview** dashboard provides details on the performance, authentication, and delivery status of your Azure Event Grid service.
96+
The **Azure Event Grid - Overview** dashboard provides details on the performance, authentication, and delivery status of your Azure Event Grid service.
18897

18998
Use this dashboard to:
19099
* Monitor request patterns by location and network access type to optimize resource allocation and improve latency.
@@ -196,7 +105,7 @@ Use this dashboard to:
196105

197106
### Administrative Operations
198107

199-
**Azure Event Grid - Administrative Operations** dashboard provides details on the operational activities and status of your Azure Event Grid resources.
108+
The **Azure Event Grid - Administrative Operations** dashboard provides details on the operational activities and status of your Azure Event Grid resources.
200109

201110
Use this dashboard to:
202111
* Monitor the distribution of operation types and their success rates to ensure the proper functioning of your Event Grid system.
@@ -205,33 +114,57 @@ Use this dashboard to:
205114

206115
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureEventGrid/Azure-Event-Grid-Administrative-Operations.png')} alt="Azure Event Grid - Administrative Operations" style={{border: '1px solid gray'}} width="800" />
207116

208-
### Errors
117+
### Topic Errors
209118

210-
**Azure Event Grid - Errors** dashboard provides details on various error types, failed deliveries, and dropped events in your Azure Event Grid service.
119+
The **Azure Event Grid - Topic Errors** dashboard provides details on various error types, failed deliveries, and dropped events in your Azure Event Grid service for system topics and topics.
211120

212121
Use this dashboard to:
213122
* Identify the most common error types affecting event publishing and delivery, such as "NotFound" and "Cancelled" errors.
214123
* Analyze trends in delivery attempt failures and correlate them with specific resource groups or topics to pinpoint problematic areas.
215124
* Monitor dropped event counts over time and investigate the reasons behind event drops to improve system reliability.
216125
* Track the top failed topics and delivery destinations to prioritize troubleshooting efforts and optimize event routing.
217126

218-
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureEventGrid/Azure-Event-Grid-Errors.png')} alt="Azure Event Grid - Errors" style={{border: '1px solid gray'}} width="800" />
127+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureEventGrid/Azure-Event-Grid-Topic-Errors.png')} alt="Azure Event Grid - Topic Errors" style={{border: '1px solid gray'}} width="800" />
128+
129+
### Domain Errors
130+
131+
The **Azure Event Grid - Domain Errors** dashboard provides details on various error types, failed deliveries, and dropped events in your Azure Event Grid service for domains. You can filter the dashboard results for particular topic using the topic filter
132+
133+
Use this dashboard to:
134+
* Identify the most common error types affecting event publishing and delivery, such as "NotFound" and "Cancelled" errors.
135+
* Analyze trends in delivery attempt failures and correlate them with specific resource groups or topics to pinpoint problematic areas.
136+
* Monitor dropped event counts over time and investigate the reasons behind event drops to improve system reliability.
137+
* Track the top failed topics and delivery destinations to prioritize troubleshooting efforts and optimize event routing.
138+
139+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureEventGrid/Azure-Event-Grid-Topic-Domain.png')} alt="Azure Event Grid - Domain Errors" style={{border: '1px solid gray'}} width="800" />
140+
141+
### Topic Operations
142+
143+
The **Azure Event Grid - Topic Operations** dashboard provides details on the performance and reliability of your Event Grid service, including processing times, success rates, and failure percentages for system topics and topics.
144+
145+
Use this dashboard to:
146+
* Monitor the average destination processing duration to identify potential bottlenecks or performance issues in event delivery.
147+
* Track delivery failure percentages over time to quickly spot and address any spikes in unsuccessful event transmissions.
148+
* Analyze the correlation between unmatched event percentages and advanced filter evaluation counts to optimize event routing and filtering.
149+
* Identify trends in publish success latency and failure rates to ensure efficient event publishing and processing.
150+
151+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureEventGrid/Azure-Event-Grid-Topic-Operations.png')} alt="Azure Event Grid - Topic Operations" style={{border: '1px solid gray'}} width="800" />
219152

220-
### Operations
153+
### Domain Operations
221154

222-
**Azure Event Grid - Operations** dashboard provides details on the performance and reliability of your Event Grid service, including processing times, success rates, and failure percentages.
155+
The **Azure Event Grid - Domain Operations** dashboard provides details on the performance and reliability of your Event Grid service, including processing times, success rates, and failure percentages for domains. You can filter the dashboard results for particular topic using the topic filter.
223156

224157
Use this dashboard to:
225158
* Monitor the average destination processing duration to identify potential bottlenecks or performance issues in event delivery.
226159
* Track delivery failure percentages over time to quickly spot and address any spikes in unsuccessful event transmissions.
227160
* Analyze the correlation between unmatched event percentages and advanced filter evaluation counts to optimize event routing and filtering.
228161
* Identify trends in publish success latency and failure rates to ensure efficient event publishing and processing.
229162

230-
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureEventGrid/Azure-Event-Grid-Operations.png')} alt="Azure Event Grid - Operations" style={{border: '1px solid gray'}} width="800" />
163+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureEventGrid/Azure-Event-Grid-Domain-Operations.png')} alt="Azure Event Grid - Operations" style={{border: '1px solid gray'}} width="800" />
231164

232165
### Policy and Recommendations
233166

234-
**Azure Event Grid - Policy and Recommendations** dashboard provides details on policy events and recommendations for your Azure Event Grid resources.
167+
The **Azure Event Grid - Policy and Recommendations** dashboard provides details on policy events and recommendations for your Azure Event Grid resources.
235168

236169
Use this dashboard to:
237170
* Monitor the success and failure rates of policy events to ensure proper configuration and compliance.

0 commit comments

Comments
 (0)