diff --git a/docs/integrations/microsoft-azure/azure-cosmos-db.md b/docs/integrations/microsoft-azure/azure-cosmos-db.md index cc80b1ce6e..db49a9e929 100644 --- a/docs/integrations/microsoft-azure/azure-cosmos-db.md +++ b/docs/integrations/microsoft-azure/azure-cosmos-db.md @@ -40,109 +40,15 @@ For Azure Cosmos DB, you can collect the following logs and metrics: 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: * 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/). -* 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. +* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source). 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). 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`. -### Configure field in field schema - -1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**.
[**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**. -1. Search for the following fields: - - `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). - - `location`. The region to which the resource name belongs to. - - `subscription_id`. ID associated with a subscription where the resource is present. - - `resource_group`. The resource group name where the Azure resource is present. - - `provider_name`. Azure resource provider name (for example, Microsoft.Network). - - `resource_type`. Azure resource type (for example, storage accounts). - - `resource_name`. The name of the resource (for example, storage account name). - - `service_type`. Type of the service that can be accessed with a Azure resource. - - `service_name`. Services that can be accessed with an Azure resource (for example, Azure SQL databases in Azure SQL Server). -1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields). - -### Configure Field Extraction Rules - -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/). - -#### Azure location extraction FER - - ```sql - Rule Name: AzureLocationExtractionFER - Applied at: Ingest Time - Scope (Specific Data): tenant_name=* - ``` - - ```sql title="Parse Expression" - json "location", "properties.resourceLocation", "properties.region", "properties.regionname" as location, resourceLocation, service_region, resourceRegion nodrop - | replace(toLowerCase(resourceLocation), " ", "") as resourceLocation - | if (!isBlank(resourceLocation), resourceLocation, location) as location - | if (!isBlank(service_region), service_region, location) as location - | if (!isBlank(resourceRegion), resourceRegion, location) as location - | if (isBlank(location), "global", location) as location - | fields location - ``` - -#### Resource ID extraction FER - - ```sql - Rule Name: AzureResourceIdExtractionFER - Applied at: Ingest Time - Scope (Specific Data): tenant_name=* - ``` - - ```sql title="Parse Expression" - json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop - | if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId - | toUpperCase(resourceId) as resourceId - | parse regex field=resourceId "/SUBSCRIPTIONS/(?[^/]+)" nodrop - | parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop - | parse regex field=resourceId "/PROVIDERS/(?[^/]+)" nodrop - | parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?[^/]+)/(?.+)" nodrop - | parse regex field=resource_name "(?[^/]+)(?:/PROVIDERS/[^/]+)?/(?[^/]+)/?(?.+)" nodrop - | if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name - | fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name - ``` - -### Configure metric rules - -Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule). - -#### Azure observability metadata extraction application gateway level - -```sql -Rule Name: AzureObservabilityMetadataExtractionCosmosDBAccountLevel -``` - -```sql title="Metric match expression" -resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.DOCUMENTDB/*/* tenant_name=* -``` -| Fields extracted | Metric rule | -|:------------------|:---------------------| -| subscription_id | $resourceId._1 | -| resource_group | $resourceId._2 | -| provider_name | MICROSOFT.DOCUMENTDB | -| resource_type | $resourceId._3 | -| resource_name | $resourceId._4 | - - ### Configure metrics collection - -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. - -1. Create hosted collector and tag `tenant_name` field.
Azure Tag Tenant Name -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). -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). -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. - 1. Choose **Stream to an event hub** as destination. - 1. Select all the metrics under **Metrics** section. - 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.
Azure Cosmos DB Diagnostic Settings for metrics -5. Tag the location field in the source with right location value.
Azure Cosmos DB for NoSQL Tag Location - -:::note -Currently, only Azure Cosmos DB for NoSQL database account type supports exporting metrics using diagnostic settings. -::: +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). ### Configure logs collection @@ -178,15 +84,27 @@ For security events, make sure you enable [Microsoft Defender for Cloud](https:/ 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. -import AppInstall2 from '../../reuse/apps/app-install-v2.md'; +import AppInstallIndexV2 from '../../reuse/apps/app-install-index-option.md'; + + + +As part of the app installation process, the following fields will be created by default: - +- `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). +- `location`. The region the resource name belongs to. +- `subscription_id`. ID associated with a subscription where the resource is present. +- `resource_group`. The resource group name where the Azure resource is present. +- `provider_name`. Azure resource provider name (for example, Microsoft.Network). +- `resource_type`. Azure resource type (for example, storage accounts). +- `resource_name`. The name of the resource (for example, storage account name). +- `service_type`. Type of the service that can be accessed with an Azure resource. +- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions). ## Viewing the Azure Cosmos DB dashboards -import ViewDashboards from '../../reuse/apps/view-dashboards.md'; +import ViewDashboardsIndex from '../../reuse/apps/view-dashboards-index.md'; - + ### Overview @@ -287,6 +205,19 @@ Use this dashboard to: Azure Cosmos DB - Administrative Operations dashboard +### Partitions + + +The **Azure Cosmos DB - Partitions** dashboard provides details about partitions count, throughput, and physical partition size by database. + +Use this dashboard to: +* Monitor partition size and their throughput throughout the database. +* View partitions allocated to different DB's and collections. +* Track partition count and usage. + +Azure Cosmos DB - Partitions dashboard + + ## Upgrade/Downgrade the Azure Cosmos DB app (optional) import AppUpdate from '../../reuse/apps/app-update.md'; @@ -299,6 +230,21 @@ import AppUninstall from '../../reuse/apps/app-uninstall.md'; +## Create monitors for Azure Cosmos DB + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + + +### Azure Cosmos DB alerts + +These alerts are metrics-based and will work for all Cosmos DB's. + +| Alert Name | Description | Alert Condition | Recover Condition | +|:-----------------------------------------------|:-----------------------------------------------------------------------------------------|:----------------|:------------------| +| `Azure Cosmos DB - Availability` | This alert gets triggered when Availability drops below 100% in Azure Cosmos DB. | Count < 100 | Count >= 100 | +| `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 | + ## Troubleshooting ### HTTP Logs and Metrics Source used by Azure Functions