Azure Cosmos DB for PostgreSQL

Azure Cosmos DB for PostgreSQL is a managed service for PostgreSQL powered by the Citus open source extension which enables you to build highly scalable relational apps. This integration helps in identifying configurations errors, analyzing executed statements, and monitoring resource usage of individual nodes in a cluster.

Log and metric types

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

• PostgreSQL Server Logs. These logs are available for every node of a cluster and can be used to identify, troubleshoot, and repair configuration errors and suboptimal performance.
• Activity logs. Provides insight into any subscription-level or management group level events that have occurred in Azure. To learn more, refer to the Azure documentation.
• Metrics. These metrics are available for every node of a cluster, and in aggregate across the nodes. For more information on supported metrics, refer to the Azure documentation.

Setup

Azure service sends monitoring data to Azure Monitor, which can then stream data to Eventhub. Sumo Logic supports:

• Logs collection from Azure Monitor using our Azure Event Hubs source.
• Metrics collection using our HTTP Logs and Metrics source via Azure Functions deployed using the ARM template.

You must explicitly enable diagnostic settings for each Azure Cosmos DB for PostgreSQL cluster you want to monitor. You can forward logs to the same event hub provided they satisfy the limitations and permissions as described here.

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/CosmosDBforPostgreSQL/Logs, Azure/CosmosDBforPostgreSQL/Metrics.

Configure field in field schema

1. Classic UI. In the main Sumo Logic menu, select Manage Data > Logs > Fields.
   New 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.
2. Search for the following fields:
   • tenant_name. This field is tagged at the collector level. You can get the tenant name using the instructions in the Microsoft Documentation.
   • 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).
3. Create the fields if they are not present. Refer to Manage fields.

Configure Field Extraction Rules

Create the following Field Extraction Rules (FER) for Azure Storage by following the instructions in the Create a Field Extraction Rule. Create the rules below if they are not present.

Azure location extraction FER

Rule Name: AzureLocationExtractionFER
Applied at: Ingest Time
Scope (Specific Data): tenant_name=*

Parse Expression

json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
| if (!isBlank(resourceLocation), resourceLocation, location) as location
| if (!isBlank(service_region), service_region, location) as location
| if (isBlank(location), "global", location) as location
| fields location

Resource ID extraction FER

Rule Name: AzureResourceIdExtractionFER
Applied at: Ingest Time
Scope (Specific Data): tenant_name=*

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/(?<subscription_id>[^/]+)" nodrop
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" 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. Create the rules below if they are not present.

Azure observability metadata extraction flexible PostgreSQL server level

Rule Name: AzureObservabilityMetadataExtractionAzureCosmosDBForPostgreSQLLevel

Metric match expression

resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.DBFORPOSTGRESQL/FLEXIBLESERVERS/* tenant_name=*

Fields extracted	Metric rule
subscription_id	$resourceId._1
resource_group	$resourceId._2
provider_name	MICROSOFT.DBFORPOSTGRESQL
resource_type	SERVERGROUPSV2
resource_name	$resourceId._3

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.
   
2. Configure an HTTP Source.
3. Configure and deploy the ARM Template.
4. Export metrics to Event Hub. Perform the steps below for each Flexible PostgreSQL Server resource that you want to monitor.
   1. Choose Stream to an event hub as destination.
   2. Select AllMetrics.
   3. 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.
      
5. Tag the location field in the source with right location value.
   

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 the Azure Event Hubs Source for Logs.

2. To create the diagnostic settings in Azure portal, refer to the Azure documentation. Perform the steps below for each Azure Redis cache account that you want to monitor.

   1. Choose Stream to an event hub as the destination.
   2. Select allLogs.
   3. 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.
      

3. Set server parameters as given below:

   • log_statement. Select DDL.
   • log_lock_waits. Set to ON. If required, you can also configure deadlock_timeout.
   • log_connections. Set to ON.
   • log_disconnections. Set to ON.
   • log_duration. Set to ON. If required, you can also configure log_min_duration_statement.
   • log_hostname. Set to ON.
   • log_min_error_statement. Set to INFO.
   • log_min_messages. Set to INFO.
   • log_line_prefix. Set to %m [%p][%v] : %q[app=%a].

4. Tag the location field in the source with right location value.
   

Activity Logs

To collect activity logs, follow the instructions here. Skip this step if you are already collecting activity logs for a subscription.

note

Since this source contains logs from multiple regions, ensure that you do not tag this source with the location tag.

Installing the Azure Cosmos DB for PostgreSQL app

Now that you have set up data collection, install the Azure Database for PostgreSQL Sumo Logic app to use the pre-configured dashboards that provide visibility into your environment for real-time analysis of overall usage.

To install the app:

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
3. Optionally, you can scroll down to preview the dashboards included with the app. Then, click Install App (sometimes this button says Add Integration).
4. Click Next.
5. Look for the dialog confirming that your app was installed successfully.
   

Once an app is installed, it will appear in your Personal folder or the folder that you specified. From here, you can share it with other users in your organization. Dashboard panels will automatically start to fill with data matching the time range query received since you created the panel. Results won't be available immediately, but within about 20 minutes, you'll see completed graphs and maps.

Viewing the Azure Cosmos DB for PostgreSQL dashboards

All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level.

• You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. Learn more.
• You can use template variables to drill down and examine the data on a granular level. For more information, see Filtering Dashboards with Template Variables.
• Most Next-Gen apps allow you to provide the scope at the installation time and are comprised of a key (_sourceCategory by default) and a default value for this key. Based on your input, the app dashboards will be parameterized with a dashboard variable, allowing you to change the dataset queried by all panels. This eliminates the need to create multiple copies of the same dashboard with different queries.

Overview

The Azure Cosmos DB for PostgreSQL - Overview dashboard provides details about replication lag, active connections and query duration distribution across clusters and servers.

Use this dashboard to:

• Track replication lag across replica clusters.
• Analyse query execution duration distribution and common errors across all servers.
• Identify clusters with max cpu usage, memory usage, and storage usage.

Network

The Azure Cosmos DB for PostgreSQL - Network dashboard provides insights on active connections, failed Ccnnections, and network activity including ingress and egress bytes.

Use this dashboard to:

• Quickly identify connection errors across clusters.
• Monitor active connections, ingress, and egress trends across clusters.
• Identify abnormally long sessions.

Errors

The Azure Cosmos DB for PostgreSQL - Errors dashboard provides insight into server error logs by specifically monitoring errors and database shutdown/start events.

Use this dashboard to:

• Quickly identify top errors across clusters and servers.
• Monitor error trends and distribution across clusters and servers.
• Identify unexpected database shutdown or start activity.

Security

The Azure Cosmos DB for PostgreSQL - Security dashboard provides insight into locations of incoming connections, failed authentications, and top database errors and warnings.

Use this dashboard to:

• Monitor incoming connections, failed authorization requests, and failed authentication requests.
• Track the user performing failed authentication attempts across servers.

Storage

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

Use this dashboard to:

• Monitor the storage utilisation to decide on scaling up storage or scaling out the nodes if this metric exceeds 85 percent consistently.
• Track total storage used across the clusters.

Performance

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

Use this dashboard to:

• Track clusters approaching the maximum IOPS capacity, to decide on adding worker nodes.
• Identify clusters using a high percentage of the clusters available memory to decide on scaling up the compute if this metric consistently exceeds 90 percent.
• Monitor the CPU usage to decide on scaling up the compute if this metric exceeds 95 percent consistently.

Queries

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

Use this dashboard to:

• Analyze query execution duration distribution across servers.
• Identify query statements with errors.
• Monitor spike in query duration.

Health

The Azure Cosmos DB for PostgreSQL - Health dashboard provides information of any service health incidents or resource health events associated with Azure Cosmos DB for PostgreSQL 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.

Administrative Operations

The Azure Cosmos DB for PostgreSQL - 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.

Upgrade/Downgrade the Azure Cosmos DB for PostgreSQL app (Optional)

To update the app, do the following:

note

Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, and Manage Collectors capabilities depending upon the different content types part of the app.

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
   Optionally, you can identify apps that can be upgraded in the Upgrade available section.
3. To upgrade the app, select Upgrade from the Manage dropdown.
   1. If the upgrade does not have any configuration or property changes, you will be redirected to the Preview & Done section.
   2. If the upgrade has any configuration or property changes, you will be redirected to the Setup Data page.
   3. In the Configure section of your respective app, complete the following fields.
      1. Field Name. If you already have collectors and sources set up, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value.
   4. Click Next. You will be redirected to the Preview & Done section.

Post-update

Your upgraded app will be installed in the Installed Apps folder and dashboard panels will start to fill automatically.

note

See our Release Notes changelog for new updates in the app.

To revert the app to a previous version, do the following:

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
3. To version down the app, select Revert to < previous version of your app > from the Manage dropdown.

Uninstalling the Azure Cosmos DB for PostgreSQL app (Optional)

To uninstall the app, do the following:

1. Select App Catalog.
2. In the 🔎 Search Apps field, run a search for your desired app, then select it.
3. Click Uninstall.

Troubleshooting

HTTP Logs and Metrics Source used by Azure Functions

To troubleshoot metrics collection, follow the instructions in Collect Metrics from Azure Monitor > Troubleshooting metrics collection.