Azure Database Account Integration
<div class="condensed-table">
| | |
| --- | --- |
| Version | 1.6.9 (View all) |
| Compatible Kibana version(s) | 8.12.0 or higher |
| Supported Serverless project types
What’s this? | Security
Observability |
| Subscription level
What’s this? | Basic |
</div>
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.
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
Before you start, check the Authentication and costs section.
Follow these step-by-step instructions on how to set up an Azure metrics integration.
Period- (string) Reporting interval. Metrics will have a timegrain of 5 minutes, so the
Periodconfiguration option fordatabase_accountshould have a value of300sor multiple of300sfor relevant results. Resource IDs- ([]string) The fully qualified ID’s of the resource, including the resource name and resource type. Has the format
/subscriptions/{{guid}}/resourceGroups/{{resource-group-name}}/providers/{{resource-provider-namespace}}/{resource-type}/{{resource-name}}. Should return a list of resources. Resource Groups- ([]string) This option will return all database accounts inside the resource group.
If no resource filter is specified, then all database accounts inside the entire subscription will be considered.
The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are avg, sum, min, max, total, count.
**Exported fields**
| Field | Description | Type | Metric Type |
|---|---|---|---|
| @timestamp | Event timestamp. | date | |
| agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword | |
| azure.application_id | The application ID | keyword | |
| azure.database_account.. | database account | object | gauge |
| azure.dimensions.closure_reason | Reason of the Cassandra Connection Closures | keyword | |
| azure.dimensions.command_name | Mongo requests command name | keyword | |
| azure.dimensions.database_name | Database name | keyword | |
| azure.dimensions.resource_name | Name of the resource | keyword | |
| azure.dimensions.status_code | Status code of the made to database requests | keyword | |
| azure.namespace | The namespace selected | keyword | |
| azure.resource.group | The resource group | keyword | |
| azure.resource.id | The id of the resource | keyword | |
| azure.resource.name | The name of the resource | keyword | |
| azure.resource.tags.* | Azure resource tags. | object | |
| azure.resource.type | The type of the resource | keyword | |
| azure.subscription_id | The subscription ID | keyword | |
| azure.timegrain | The Azure metric timegrain | keyword | |
| cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | |
| cloud.availability_zone | Availability zone in which this host is running. | keyword | |
| cloud.image.id | Image ID for the cloud instance. | keyword | |
| cloud.instance.id | Instance ID of the host machine. | keyword | |
| cloud.instance.name | Instance name of the host machine. | keyword | |
| cloud.machine.type | Machine type of the host machine. | keyword | |
| cloud.project.id | Name of the project in Google Cloud. | keyword | |
| cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | |
| cloud.region | Region in which this host is running. | keyword | |
| container.id | Unique container id. | keyword | |
| container.image.name | Name of the image the container was built on. | keyword | |
| container.labels | Image labels. | object | |
| container.name | Container name. | keyword | |
| container.runtime | Runtime managing this container. | keyword | |
| data_stream.dataset | Data stream dataset name. | constant_keyword | |
| data_stream.namespace | Data stream namespace. | constant_keyword | |
| data_stream.type | Data stream type. | constant_keyword | |
| dataset.name | Dataset name. | constant_keyword | |
| dataset.namespace | Dataset namespace. | constant_keyword | |
| dataset.type | Dataset type. | constant_keyword | |
| ecs.version | ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices — which may conform to slightly different ECS versions — this field lets integrations adjust to the schema version of the events. |
keyword | |
| host | A host is defined as a general computing instance. ECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | |
| host.architecture | Operating system architecture. | keyword | |
| host.containerized | If the host is a container. | boolean | |
| host.domain | Name of the domain of which the host is a member. For example, on Windows this could be the host’s Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host’s LDAP provider. | keyword | |
| host.hostname | Hostname of the host. It normally contains what the hostname command returns on the host machine. |
keyword | |
| host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name. |
keyword | |
| host.ip | Host ip addresses. | ip | |
| host.mac | Host mac addresses. | keyword | |
| host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. |
keyword | |
| host.os.build | OS build information. | keyword | |
| host.os.codename | OS codename, if any. | keyword | |
| host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword | |
| host.os.kernel | Operating system kernel version as a raw string. | keyword | |
| host.os.name | Operating system name, without the version. | keyword | |
| host.os.name.text | Multi-field of host.os.name. |
text | |
| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword | |
| host.os.version | Operating system version as a raw string. | keyword | |
| host.type | Type of host. For Cloud providers this can be the machine type like t2.medium. If vm, this could be the container, for example, or other information meaningful in your environment. |
keyword | |
| service.address | Service address | keyword | |
| service.type | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch. |
keyword |
**Changelog**
| Version | Details | Kibana version(s) |
|---|---|---|
| 1.6.9 | pass:[] Bug fix (View pull request) Update links to getting started docs |
8.12.0 or higher |
| 1.6.8 | pass:[] Enhancement (View pull request) Add missing category. |
8.12.0 or higher |
| 1.6.7 | pass:[] Enhancement (View pull request) Clarify generic vs specialized integrations on Azure metrics pages. |
8.12.0 or higher |
| 1.6.6 | pass:[] Bug fix (View pull request) Fix capacity and count metrics visualizations in the overview, blob, table, and file storage dashboards. |
8.12.0 or higher |
| 1.6.5 | pass:[] Enhancement (View pull request) Consolidate content on Azure metrics pages. |
8.12.0 or higher |
| 1.6.4 | pass:[] Enhancement (View pull request) Consolidate content on Azure metrics pages. |
8.12.0 or higher |
| 1.6.3 | pass:[] Enhancement (View pull request) Consolidate content on the Azure Container Instance Metrics doc page. |
8.12.0 or higher |
| 1.6.2 | pass:[] Enhancement (View pull request) Consolidate content on the Azure Container Registry Metrics doc page. |
8.12.0 or higher |
| 1.6.1 | pass:[] Enhancement (View pull request) Consolidate content on the Azure Monitor Metrics doc page. |
8.12.0 or higher |
| 1.6.0 | pass:[] Enhancement (View pull request) Add support for integration secrets. |
8.12.0 or higher |
| 1.5.0 | pass:[] Enhancement (View pull request) Update visualizations of Queue Storage Overview, Table Storage Overview, File Storage Overview & Storage Overview dashboards. |
8.11.2 or higher |
| 1.4.4 | pass:[] Enhancement (View pull request) Migrate Blob Storage Overview dashboard to lens. |
8.11.2 or higher |
| 1.4.3 | pass:[] Enhancement (View pull request) Remove suffix from Compute VMs Overview dashboard. |
8.11.2 or higher |
| 1.4.2 | pass:[] Enhancement (View pull request) Apply documentation guidelines and add generic setup section to Azure Resource Metrics. |
8.11.2 or higher |
| 1.4.1 | pass:[] Enhancement (View pull request) Expand Azure guest metrics section. |
8.11.2 or higher |
| 1.4.0 | pass:[] Enhancement (View pull request) Enable time series data streams for all metrics dataset. This dramatically reduces storage for metrics and is expected to progressively improve query performance. For more details, see docs-content://manage-data/data-store/data-streams/time-series-data-stream-tsds.md. |
8.11.2 or higher |
| 1.3.0 | pass:[] Enhancement (View pull request) Allow rerouting of Azure metrics events to a different data stream. |
8.10.2 or higher |
| 1.2.1 | pass:[] Bug fix (View pull request) Add missing dimension metadata to the database_account datastream; fix typo in the container_registry field definition |
8.10.2 or higher |
| 1.2.0 | pass:[] Enhancement (View pull request) Enable time series data streams for the storage_account metrics dataset. This dramatically reduces storage for metrics and is expected to progressively improve query performance. For more details, see docs-content://manage-data/data-store/data-streams/time-series-data-stream-tsds.md. |
8.10.2 or higher |
| 1.1.1 | pass:[] Enhancement (View pull request) Add metric_type metadata to the storage_account datastream |
8.10.2 or higher |
| 1.1.0 | pass:[] Enhancement (View pull request) Add dimensions to the storage account datastream |
8.10.2 or higher |
| 1.0.43 | pass:[] Enhancement (View pull request) Migrate File Storage Overview dashboard to lens. |
8.9.0 or higher |
| 1.0.42 | pass:[] Enhancement (View pull request) Migrate Table Storage Overview dashboard to lens. |
8.9.0 or higher |
| 1.0.41 | pass:[] Enhancement (View pull request) Migrate Queue Storage Overview dashboard to lens. |
8.9.0 or higher |
| 1.0.40 | pass:[] Enhancement (View pull request) Add dimension and metric_type metadata to the database_account datastream |
8.9.0 or higher |
| 1.0.39 | pass:[] Bug fix (View pull request) Remove region dimension in the database_account datastream |
8.9.0 or higher |
| 1.0.38 | pass:[] Enhancement (View pull request) Migrate Compute VMs Overview dashboard to lens. |
8.9.0 or higher |
| 1.0.37 | pass:[] Enhancement (View pull request) Migrate Storage Overview dashboard to lens. |
8.9.0 or higher |
| 1.0.36 | pass:[] Enhancement (View pull request) Migrate Container Instance Overview dashboard to lens. |
8.9.0 or higher |
| 1.0.35 | pass:[] Bug fix (View pull request) Normalize the azure.dimentions.status field value to lowercase. Values from Azure come in lowercase and capitalized versions (e.g., True/true/False/false). |
8.9.0 or higher |
| 1.0.34 | pass:[] Enhancement (View pull request) Add dimension and metric_type metadata to the monitor datastream |
8.9.0 or higher |
| 1.0.33 | pass:[] Enhancement (View pull request) Add missing region dimension, remove outdated azure metrics for the database_account datastream |
8.9.0 or higher |
| 1.0.32 | pass:[] Enhancement (View pull request) Migrate Container Registry Overview dashboard to lens. |
8.9.0 or higher |
| 1.0.31 | pass:[] Enhancement (View pull request) Migrate Compute VM Guest Memory & Process Metrics Compute VM dashboard to lens. |
8.9.0 or higher |
| 1.0.30 | pass:[] Enhancement (View pull request) Migrate Compute VM Guest ASP.NET & Sql Server dashboard to lens. |
8.9.0 or higher |
| 1.0.29 | pass:[] Enhancement (View pull request) Migrate Compute VM Guest Linux Metrics Overview dashboard to lens. |
8.9.0 or higher |
| 1.0.28 | pass:[] Enhancement (View pull request) Add dimension and metric_type metadata to the compute_vm datastream |
8.9.0 or higher |
| 1.0.27 | pass:[] Enhancement (View pull request) Migrate Container Service Overview dashboard to lens. |
8.4.0 or higher |
| 1.0.26 | pass:[] Enhancement (View pull request) Migrate VM Scale Sets Overview dashboard to lens. |
8.4.0 or higher |
| 1.0.25 | pass:[] Enhancement (View pull request) Migrate Database Account Overview dashboard to lens. |
8.4.0 or higher |
| 1.0.24 | pass:[] Bug fix (View pull request) Fix the metrics field name in the container instance datastream. |
8.3.0 or higher |
| 1.0.23 | pass:[] Enhancement (View pull request) Add dimension and metric_type metadata to the compute_vm_scaleset datastream |
8.3.0 or higher |
| 1.0.22 | pass:[] Enhancement (View pull request) Add dimension and metric_type metadata to the container_registry datastream |
8.3.0 or higher |
| 1.0.21 | pass:[] Enhancement (View pull request) Migrate the visualizations to by value in dashboards to minimize the saved object clutter and reduce time to load. |
8.3.0 or higher |
| 1.0.20 | pass:[] Enhancement (View pull request) Add missing azure dimensions to the container_registry and compute_vm_scaleset datastreams |
7.14.0 or higher 8.0.0 or higher |
| 1.0.19 | pass:[] Enhancement (View pull request) Add dimension and metric_type metadata to the container_service datastream |
7.14.0 or higher 8.0.0 or higher |
| 1.0.18 | pass:[] Enhancement (View pull request) Add missing azure dimensions to the kube_pod_status_phase and kube_pod_status_ready metrics |
7.14.0 or higher 8.0.0 or higher |
| 1.0.17 | pass:[] Enhancement (View pull request) Add dimension and metric_type metadata to the container_instance datastream |
7.14.0 or higher 8.0.0 or higher |
| 1.0.16 | pass:[] Enhancement (View pull request) Added categories and/or subcategories. |
7.14.0 or higher 8.0.0 or higher |
| 1.0.15 | pass:[] Bug fix (View pull request) Fix dimensions for CassandraConnectionClosures metric configuration |
7.14.0 or higher 8.0.0 or higher |
| 1.0.14 | pass:[] Bug fix (View pull request) Fix CassandraConnectionClosures metric configuration |
7.14.0 or higher 8.0.0 or higher |
| 1.0.13 | pass:[] Bug fix (View pull request) Replace the link to Indonesian docs with English docs |
7.14.0 or higher 8.0.0 or higher |
| 1.0.12 | pass:[] Enhancement (View pull request) Add container_instance pipeline test |
7.14.0 or higher 8.0.0 or higher |
| 1.0.11 | pass:[] Enhancement (View pull request) Add compute_vm_scaleset pipeline test |
7.14.0 or higher 8.0.0 or higher |
| 1.0.10 | pass:[] Enhancement (View pull request) Add compute_vm pipeline test |
7.14.0 or higher 8.0.0 or higher |
| 1.0.9 | pass:[] Enhancement (View pull request) Move database_account metrics config from beats to integrations |
7.14.0 or higher 8.0.0 or higher |
| 1.0.8 | pass:[] Enhancement (View pull request) Move container_registry metrics config from beats to integrations |
— |
| 1.0.7 | pass:[] Enhancement (View pull request) Move container_service metrics config from beats to integrations |
— |
| 1.0.6 | pass:[] Enhancement (View pull request) Move container_instance metrics config from beats to integrations |
— |
| 1.0.5 | pass:[] Enhancement (View pull request) Fix doc build |
7.14.0 or higher 8.0.0 or higher |
| 1.0.4 | pass:[] Enhancement (View pull request) Update Readme |
— |
| 1.0.3 | pass:[] Enhancement (View pull request) Add documentation for multi-fields |
7.14.0 or higher 8.0.0 or higher |
| 1.0.2 | pass:[] Enhancement (View pull request) Update documentation |
— |
| 1.0.1 | pass:[] Enhancement (View pull request) Remove beta release tag from data streams |
7.14.0 or higher 8.0.0 or higher |
| 1.0.0 | pass:[] Enhancement (View pull request) Move azure_metrics package to GA |
7.14.0 or higher 8.0.0 or higher |
| 0.5.1 | pass:[] Enhancement (View pull request) Update to ECS 8.0 |
— |
| 0.5.0 | pass:[] Enhancement (View pull request) Release package for v8.0.0 |
— |
| 0.4.1 | pass:[] Enhancement (View pull request) Uniform with guidelines |
— |
| 0.4.0 | pass:[] Enhancement (View pull request) Update to ECS 1.12.0 |
— |
| 0.3.2 | pass:[] Enhancement (View pull request) Add/update configuration options definitions in the docs + add additional option for storage account |
— |
| 0.3.1 | pass:[] Enhancement (View pull request) Clean up text and fix dashboards |
— |
| 0.3.0 | pass:[] Enhancement (View pull request) Add guest metrics |
— |
| 0.2.0 | pass:[] Enhancement (View pull request) Update integration description |
— |
| 0.1.0 | pass:[] Enhancement (View pull request) Update dashboards, doc, ecs schema |
— |
| 0.0.1 | pass:[] Enhancement (View pull request) Create package |
— |