Skip to content

Commit 9e83563

Browse files
authored
Merge branch 'main' into docs-888-more-improvements-to-automation-integrations
2 parents b368ffa + 0921b00 commit 9e83563

File tree

3 files changed

+77
-198
lines changed

3 files changed

+77
-198
lines changed

docs/integrations/microsoft-azure/azure-cache-for-redis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,8 @@ The **Azure Cache for Redis - Resource Performance(Non-Enterprise)** dashboard p
159159
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Performance-Non-Enterprise.png')} alt="Azure Cache for Redis - Resource Performance(Non-Enterprise)" style={{border: '1px solid gray'}} width="800" />
160160

161161

162-
### Azure Application Gateway alerts
163-
These alerts are metric based and will work for all Azure Application Gateways.
162+
### Azure Cache for Redis alerts
163+
These alerts are metric based and will work for all Azure Cache for Redis.
164164

165165
| Alert Name | Alert Description and Conditions | Alert Condition | Recover Condition |
166166
|:-------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:------------------|

docs/integrations/microsoft-azure/azure-cosmos-db.md

Lines changed: 46 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -40,109 +40,15 @@ For Azure Cosmos DB, you can collect the following logs and metrics:
4040
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:
4141

4242
* 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/).
43-
* 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.
43+
* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
4444

4545
You must explicitly enable diagnostic settings for each Azure Cosmos DB account 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).
4646

4747
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/CosmosDB/Logs`, `Azure/CosmosDB/Metrics`.
4848

49-
### Configure field in field schema
50-
51-
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**.
52-
1. Search for the following fields:
53-
- `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).
54-
- `location`. The region to which the resource name belongs to.
55-
- `subscription_id`. ID associated with a subscription where the resource is present.
56-
- `resource_group`. The resource group name where the Azure resource is present.
57-
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
58-
- `resource_type`. Azure resource type (for example, storage accounts).
59-
- `resource_name`. The name of the resource (for example, storage account name).
60-
- `service_type`. Type of the service that can be accessed with a Azure resource.
61-
- `service_name`. Services that can be accessed with an Azure resource (for example, Azure SQL databases in Azure SQL Server).
62-
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
63-
64-
### Configure Field Extraction Rules
65-
66-
Create the following Field Extraction Rules (FER) for Azure Storage by following the instructions in [Create a Field Extraction Rule](/docs/manage/field-extractions/create-field-extraction-rule/).
67-
68-
#### Azure location extraction FER
69-
70-
```sql
71-
Rule Name: AzureLocationExtractionFER
72-
Applied at: Ingest Time
73-
Scope (Specific Data): tenant_name=*
74-
```
75-
76-
```sql title="Parse Expression"
77-
json "location", "properties.resourceLocation", "properties.region", "properties.regionname" as location, resourceLocation, service_region, resourceRegion nodrop
78-
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
79-
| if (!isBlank(resourceLocation), resourceLocation, location) as location
80-
| if (!isBlank(service_region), service_region, location) as location
81-
| if (!isBlank(resourceRegion), resourceRegion, location) as location
82-
| if (isBlank(location), "global", location) as location
83-
| fields location
84-
```
85-
86-
#### Resource ID extraction FER
87-
88-
```sql
89-
Rule Name: AzureResourceIdExtractionFER
90-
Applied at: Ingest Time
91-
Scope (Specific Data): tenant_name=*
92-
```
93-
94-
```sql title="Parse Expression"
95-
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
96-
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
97-
| toUpperCase(resourceId) as resourceId
98-
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
99-
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
100-
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
101-
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
102-
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
103-
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
104-
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
105-
```
106-
107-
### Configure metric rules
108-
109-
Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule).
110-
111-
#### Azure observability metadata extraction application gateway level
112-
113-
```sql
114-
Rule Name: AzureObservabilityMetadataExtractionCosmosDBAccountLevel
115-
```
116-
117-
```sql title="Metric match expression"
118-
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.DOCUMENTDB/*/* tenant_name=*
119-
```
120-
| Fields extracted | Metric rule |
121-
|:------------------|:---------------------|
122-
| subscription_id | $resourceId._1 |
123-
| resource_group | $resourceId._2 |
124-
| provider_name | MICROSOFT.DOCUMENTDB |
125-
| resource_type | $resourceId._3 |
126-
| resource_name | $resourceId._4 |
127-
128-
12949
### Configure metrics collection
13050

131-
132-
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, on to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
133-
134-
1. Create hosted collector and tag `tenant_name` field. <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" />
135-
2. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
136-
3. [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).
137-
4. [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 following steps for each Azure Cosmos DB account that you want to monitor.
138-
1. Choose **Stream to an event hub** as destination.
139-
1. Select all the metrics under **Metrics** section.
140-
1. Use the Event Hub namespace created by the ARM template in the previous step. You can create a new Event Hub or use the one created by the ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/integrations/microsoft-azure/azurecosmosdb-metrics.png')} alt="Azure Cosmos DB Diagnostic Settings for metrics" style={{border: '1px solid gray'}} width="800" />
141-
5. Tag the location field in the source with right location value.<br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Cosmos DB for NoSQL Tag Location" style={{border: '1px solid gray'}} width="400" />
142-
143-
:::note
144-
Currently, only Azure Cosmos DB for NoSQL database account type supports exporting metrics using diagnostic settings.
145-
:::
51+
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).
14652

14753
### Configure logs collection
14854

@@ -178,15 +84,27 @@ For security events, make sure you enable [Microsoft Defender for Cloud](https:/
17884

17985
This section provides instructions on how to install the Azure Cosmos DB app, and shows examples of each of the preconfigured dashboards you can use to analyze your data.
18086

181-
import AppInstall2 from '../../reuse/apps/app-install-v2.md';
87+
import AppInstallIndexV2 from '../../reuse/apps/app-install-index-option.md';
88+
89+
<AppInstallIndexV2/>
90+
91+
As part of the app installation process, the following fields will be created by default:
18292

183-
<AppInstall2/>
93+
- `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).
94+
- `location`. The region the resource name belongs to.
95+
- `subscription_id`. ID associated with a subscription where the resource is present.
96+
- `resource_group`. The resource group name where the Azure resource is present.
97+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
98+
- `resource_type`. Azure resource type (for example, storage accounts).
99+
- `resource_name`. The name of the resource (for example, storage account name).
100+
- `service_type`. Type of the service that can be accessed with an Azure resource.
101+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).
184102

185103
## Viewing the Azure Cosmos DB dashboards
186104

187-
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
105+
import ViewDashboardsIndex from '../../reuse/apps/view-dashboards-index.md';
188106

189-
<ViewDashboards/>
107+
<ViewDashboardsIndex/>
190108

191109
### Overview
192110

@@ -287,6 +205,19 @@ Use this dashboard to:
287205

288206
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-CosmosDB/Azure-Cosmos-DB-Administrative-Operations.png')} alt="Azure Cosmos DB - Administrative Operations dashboard" style={{border: '1px solid gray'}} width="800" />
289207

208+
### Partitions
209+
210+
211+
The **Azure Cosmos DB - Partitions** dashboard provides details about partitions count, throughput, and physical partition size by database.
212+
213+
Use this dashboard to:
214+
* Monitor partition size and their throughput throughout the database.
215+
* View partitions allocated to different DB's and collections.
216+
* Track partition count and usage.
217+
218+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-CosmosDB/Azure-Cosmos-DB-Partitions.png')} alt="Azure Cosmos DB - Partitions dashboard" style={{border: '1px solid gray'}} width="800" />
219+
220+
290221
## Upgrade/Downgrade the Azure Cosmos DB app (optional)
291222

292223
import AppUpdate from '../../reuse/apps/app-update.md';
@@ -299,6 +230,21 @@ import AppUninstall from '../../reuse/apps/app-uninstall.md';
299230

300231
<AppUninstall/>
301232

233+
## Create monitors for Azure Cosmos DB
234+
235+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
236+
237+
<CreateMonitors/>
238+
239+
### Azure Cosmos DB alerts
240+
241+
These alerts are metrics-based and will work for all Cosmos DB's.
242+
243+
| Alert Name | Description | Alert Condition | Recover Condition |
244+
|:-----------------------------------------------|:-----------------------------------------------------------------------------------------|:----------------|:------------------|
245+
| `Azure Cosmos DB - Availability` | This alert gets triggered when Availability drops below 100% in Azure Cosmos DB. | Count < 100 | Count >= 100 |
246+
| `Azure Cosmos DB - Normalized RU Consumption` | This alert gets triggered when high RU consumption usage is detected in Azure Cosmos DB. | Count >= 90 | Count < 90 |
247+
302248
## Troubleshooting
303249

304250
### HTTP Logs and Metrics Source used by Azure Functions

0 commit comments

Comments
 (0)