Skip to content

Commit

Permalink
azure metrics: add list of supported databases and namespaces (#11118)
Browse files Browse the repository at this point in the history
Add the list of databases and namespaces supported by the Azure Database Account integration.

Set the right expectations about the namespaces and supported databases. Without this list, users may expect this integration to support all database types available in Azure.
  • Loading branch information
zmoog authored Sep 19, 2024
1 parent cdcedd4 commit 076cfec
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 2 deletions.
12 changes: 12 additions & 0 deletions packages/azure_metrics/_dev/build/docs/database_account.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
# Azure Database Account Integration

The Azure Database Account data stream collects and aggregates database account related metrics from Azure Database Account type resources where it can be used for analysis, visualization, and alerting.

The Azure Database Account will periodically retrieve the Azure Monitor metrics using the Azure REST APIs as MetricList.
Additional Azure API calls will be executed to retrieve information regarding the resources targeted by the user.

## Supported namespaces and databases

The Azure Database Account integration collects metrics from the `Microsoft.DocumentDb/databaseAccounts` namespace only.

The integration supports metrics for the following databases:

- Azure Cosmos DB with SQL API
- Azure Cosmos DB for Apache Gremlin
- Azure Cosmos DB for Apache Cassandra
- Azure Cosmos DB for MongoDB

## Requirements

Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) section.
Expand Down
6 changes: 5 additions & 1 deletion packages/azure_metrics/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@

- version: "1.6.5"
changes:
- description: Consolidate content on Azure metrics pages.
type: enhancement
link: https://github.com/elastic/integrations/pull/11118
- version: "1.6.4"
changes:
- description: Consolidate content on Azure metrics pages.
Expand Down
12 changes: 12 additions & 0 deletions packages/azure_metrics/docs/database_account.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
# Azure Database Account Integration

The Azure Database Account data stream collects and aggregates database account related metrics from Azure Database Account type resources where it can be used for analysis, visualization, and alerting.

The Azure Database Account will periodically retrieve the Azure Monitor metrics using the Azure REST APIs as MetricList.
Additional Azure API calls will be executed to retrieve information regarding the resources targeted by the user.

## Supported namespaces and databases

The Azure Database Account integration collects metrics from the `Microsoft.DocumentDb/databaseAccounts` namespace only.

The integration supports metrics for the following databases:

- Azure Cosmos DB with SQL API
- Azure Cosmos DB for Apache Gremlin
- Azure Cosmos DB for Apache Cassandra
- Azure Cosmos DB for MongoDB

## Requirements

Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) section.
Expand Down
2 changes: 1 addition & 1 deletion packages/azure_metrics/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: azure_metrics
title: Azure Resource Metrics
version: 1.6.4
version: 1.6.5
description: Collect metrics from Azure resources with Elastic Agent.
type: integration
icons:
Expand Down

0 comments on commit 076cfec

Please sign in to comment.