---
id: azure-cosmos-db
title: Azure Cosmos DB
sidebar_label: Azure Cosmos DB
description: Learn about the Sumo Logic collection process for the Azure Cosmos DB service.
slug: /help/docs/integrations/microsoft-azure/azure-cosmos-db/
canonical: https://www.sumologic.com/help/docs/integrations/microsoft-azure/azure-cosmos-db/
---

import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/integrations/microsoft-azure/azure-cosmos-db.png')} alt="Azure Cosmos DB icon" width="50"/>

[Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/introduction) is a fully managed NoSQL and relational database for modern app development offering single-digit millisecond response times, automatic and instant scalability, along with guaranteed speed at any scale. This integration helps in monitoring the overall performance, failures, capacity, and operational health of all your Azure Cosmos DB resources.

The below instructions applies to the following [database APIs](https://learn.microsoft.com/en-us/azure/cosmos-db/choose-api):

* NoSQL
* MongoDB
* Cassandra
* Gremlin
* Table

:::note
This app is tested with Azure Cosmos DB for MongoDB, Cassandra, and NoSQL database account types.
:::

## Log and metric types

For Azure Cosmos DB, you can collect the following logs and metrics:

* **Resource logs**. To learn more about the different resource log category types and schemas collected for Azure Cosmos DB, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/cosmos-db/monitor-reference#resource-logs).

* **Platform Metrics for Azure Cosmos DB**. For more information on supported metrics and dimensions, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/cosmos-db/monitor-reference#metrics). These metrics are available within the namespace `Microsoft.DocumentDB/DatabaseAccounts`

* **Activity logs**. Provides insight into any subscription-level or management group level events that have occurred in the Azure. To learn more, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/activity-log-schema).

## Setup

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 [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 collector

Create a hosted collector if not already configured 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). Make sure you create the required sources in this collector. <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" />

### Configure metrics collection

import MetricsSource from '../../reuse/metrics-source.md';

<MetricsSource/>

### Configure logs collection

In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.

1. To set up the Azure Event Hubs source in Sumo Logic, refer to [Azure Event Hubs Source for Logs](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
2. If you want to audit Azure Cosmos DB control plane operations, [disable the key based metadata write access](https://learn.microsoft.com/en-us/azure/cosmos-db/audit-control-plane-logs#disable-key-based-metadata-write-access).
3. To create the diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/cosmos-db/monitor-resource-logs?tabs=azure-portal#create-diagnostic-settings). Perform the following steps for each Azure Cosmos DB account that you want to monitor.
   1. Choose **Stream to an event hub** as the destination.
   1. Select your preferred log categories depending upon your database API or select **allLogs**.
   1. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/integrations/microsoft-azure/cosmosdb-diagnostic-logs.png')} alt="Azure CosmosDB Diagnostic Settings for logs" style={{border: '1px solid gray'}} width="800" />
4. 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" />

#### Activity logs (optional)

import ActivityLogs from '../../reuse/apps/azure-activity-logs.md';

<ActivityLogs/>

##### Enabling Microsoft Defender for Cloud

For security events, make sure you enable [Microsoft Defender for Cloud](https://learn.microsoft.com/en-us/azure/defender-for-cloud/defender-for-databases-enable-cosmos-protections?tabs=azure-portal). In the Defender Plans Settings page toggle the Databases status under the Cloud Workload Protection section and select the resource types.

<img src={useBaseUrl('img/integrations/microsoft-azure/Microsoft-Cloud-Defender-Edit-Settings.png')} alt="Edit Settings" style={{border: '1px solid gray'}} width="800" />

<img src={useBaseUrl('img/integrations/microsoft-azure/Microsoft-Cloud-Defender-Plans-CosmosDB.png')} alt="Cloud Defender Plans" style={{border: '1px solid gray'}} width="800" />

<img src={useBaseUrl('img/integrations/microsoft-azure/Microsoft-Cloud-Defender-Plans-CosmosDB_resource_types.png')} alt="Select Database Types" style={{border: '1px solid gray'}} width="800" />

## Installing the Azure Cosmos DB app

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 AppInstallIndexV2 from '../../reuse/apps/app-install-index-option.md';

<AppInstallIndexV2/>

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 ViewDashboardsIndex from '../../reuse/apps/view-dashboards-index.md';

<ViewDashboardsIndex/>

### Overview

The **Azure Cosmos DB - Overview** dashboard provides details about RU (Request Unit) consumption, duration, status code distribution across database and collection.

Use this dashboard to:
* Track data plane request locations for cross region calls.
* Monitor request units, duration consumed across database and collection.
* Identify failed requests across database and collection.

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

### Throughput

The **Azure Cosmos DB - Throughput** dashboard provides details about Request Unit (RU) consumption for logical partition keys in each region, within each of their physical partitions.

Use this dashboard to:
* Identify hot partitions from a request volume perspective.
* Track request units consumed by each database.

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

### Audit

The **Azure Cosmos DB - Audit** dashboard provides details about all control plane operations executed on the account.

Use this dashboard to:

* Monitor control plane requests which includes modifications to the regional failover policy, indexing policy, IAM role assignments, backup/restore policies, VNet and firewall rules, private links as well as updates, and deletes of the account.
* Monitor data plane operations executed to create, update, delete, or retrieve data within the account.
* Use operation name filter to track important events like network settings update, account key rotations, provisioned throughput changes and replication settings update.


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

### Storage

The **Azure Cosmos DB - Storage** dashboard provides details about data usage, document count, and physical partition size by database.

Use this dashboard to:
* Identify logical partition keys that have consumed more storage space than others.
* Track document count and data usage.

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

### Performance

The **Azure Cosmos DB - Performance** dashboard provides insights into the performance of your Azure Cosmos DB databases. This includes metrics on query duration, server side latency, and failed queries.

Use this dashboard to:
* Monitor and analyze the failed queries of your Azure Cosmos DB.
* Identify performance bottlenecks and optimize query execution.

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

### Queries

The **Azure Cosmos DB - Queries** dashboard provides insights into the queries executed in your Azure Cosmos DB databases.

Use this dashboard to:
* Analyze query distribution across duration, request charge, response length.
* Identify query bottlenecks and optimize query execution.

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

### Health

The **Azure Cosmos DB - Health** dashboard provides information of any service health incidents or resource health events associated with Azure Cosmos DB accounts in your azure account.

Use this dashboard to:
* View recent resource and service health incidents.
* View distribution of service and resource health by incident type.
* Monitor service availability.

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

### Policy and Recommendations

The **Azure Cosmos DB - Policy and Recommendations** dashboard provides information of all effect action operations performed by Azure policy and recommendations events from Azure Advisor.

Use this dashboard to:
* Monitor policy events with warnings and errors.
* View recent failed policy events.
* View total recommendation events.
* Identify high impact recommendations.
* View recent recommendation events and navigate to the affected resource.

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

### Administrative Operations

The **Azure Cosmos DB - Administrative Operations** dashboard provides details on users performing admin operations.

Use this dashboard to:
* Identify top users performing administrative operations.
* View top 10 operations that caused the most errors.
* View recent diagnostic, network, and replication settings updates operations.

<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" />

### 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.

<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" />


## Upgrade/Downgrade the Azure Cosmos DB app (optional)

import AppUpdate from '../../reuse/apps/app-update.md';

<AppUpdate/>

## Uninstalling the Azure Cosmos DB app (optional)

import AppUninstall from '../../reuse/apps/app-uninstall.md';

<AppUninstall/>

## Create monitors for Azure Cosmos DB

import CreateMonitors from '../../reuse/apps/create-monitors.md';

<CreateMonitors/>

### 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

### Metrics collection via Azure Metrics Source

To troubleshoot metrics collection via Azure Metrics Source, follow the instructions in [Troubleshooting Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source/#troubleshooting).