Azure Database Account Metrics
Collect metrics from Azure Database accounts with Elastic Agent.
Version | 1.6.7 (View all) |
Compatible Kibana version(s) | 8.12.0 or higher |
Supported Serverless project types | Security Observability |
Subscription level | Basic |
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 section.
Setup
Follow these step-by-step instructions on how to set up an Azure metrics integration.
Data stream specific configuration notes
Period
:: (string) Reporting interval. Metrics will have a timegrain of 5 minutes, so the Period
configuration option for database_account
should have a value of 300s
or multiple of 300s
for 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.7 | Enhancement View pull request | 8.12.0 or higher |
1.6.6 | Bug fix View pull request | 8.12.0 or higher |
1.6.5 | Enhancement View pull request | 8.12.0 or higher |
1.6.4 | Enhancement View pull request | 8.12.0 or higher |
1.6.3 | Enhancement View pull request | 8.12.0 or higher |
1.6.2 | Enhancement View pull request | 8.12.0 or higher |
1.6.1 | Enhancement View pull request | 8.12.0 or higher |
1.6.0 | Enhancement View pull request | 8.12.0 or higher |
1.5.0 | Enhancement View pull request | 8.11.2 or higher |
1.4.4 | Enhancement View pull request | 8.11.2 or higher |
1.4.3 | Enhancement View pull request | 8.11.2 or higher |
1.4.2 | Enhancement View pull request | 8.11.2 or higher |
1.4.1 | Enhancement View pull request | 8.11.2 or higher |
1.4.0 | Enhancement View pull request | 8.11.2 or higher |
1.3.0 | Enhancement View pull request | 8.10.2 or higher |
1.2.1 | Bug fix View pull request | 8.10.2 or higher |
1.2.0 | Enhancement View pull request | 8.10.2 or higher |
1.1.1 | Enhancement View pull request | 8.10.2 or higher |
1.1.0 | Enhancement View pull request | 8.10.2 or higher |
1.0.43 | Enhancement View pull request | 8.9.0 or higher |
1.0.42 | Enhancement View pull request | 8.9.0 or higher |
1.0.41 | Enhancement View pull request | 8.9.0 or higher |
1.0.40 | Enhancement View pull request | 8.9.0 or higher |
1.0.39 | Bug fix View pull request | 8.9.0 or higher |
1.0.38 | Enhancement View pull request | 8.9.0 or higher |
1.0.37 | Enhancement View pull request | 8.9.0 or higher |
1.0.36 | Enhancement View pull request | 8.9.0 or higher |
1.0.35 | Bug fix View pull request | 8.9.0 or higher |
1.0.34 | Enhancement View pull request | 8.9.0 or higher |
1.0.33 | Enhancement View pull request | 8.9.0 or higher |
1.0.32 | Enhancement View pull request | 8.9.0 or higher |
1.0.31 | Enhancement View pull request | 8.9.0 or higher |
1.0.30 | Enhancement View pull request | 8.9.0 or higher |
1.0.29 | Enhancement View pull request | 8.9.0 or higher |
1.0.28 | Enhancement View pull request | 8.9.0 or higher |
1.0.27 | Enhancement View pull request | 8.4.0 or higher |
1.0.26 | Enhancement View pull request | 8.4.0 or higher |
1.0.25 | Enhancement View pull request | 8.4.0 or higher |
1.0.24 | Bug fix View pull request | 8.3.0 or higher |
1.0.23 | Enhancement View pull request | 8.3.0 or higher |
1.0.22 | Enhancement View pull request | 8.3.0 or higher |
1.0.21 | Enhancement View pull request | 8.3.0 or higher |
1.0.20 | Enhancement View pull request | 7.14.0 or higher |
1.0.19 | Enhancement View pull request | 7.14.0 or higher |
1.0.18 | Enhancement View pull request | 7.14.0 or higher |
1.0.17 | Enhancement View pull request | 7.14.0 or higher |
1.0.16 | Enhancement View pull request | 7.14.0 or higher |
1.0.15 | Bug fix View pull request | 7.14.0 or higher |
1.0.14 | Bug fix View pull request | 7.14.0 or higher |
1.0.13 | Bug fix View pull request | 7.14.0 or higher |
1.0.12 | Enhancement View pull request | 7.14.0 or higher |
1.0.11 | Enhancement View pull request | 7.14.0 or higher |
1.0.10 | Enhancement View pull request | 7.14.0 or higher |
1.0.9 | Enhancement View pull request | 7.14.0 or higher |
1.0.8 | Enhancement View pull request | — |
1.0.7 | Enhancement View pull request | — |
1.0.6 | Enhancement View pull request | — |
1.0.5 | Enhancement View pull request | 7.14.0 or higher |
1.0.4 | Enhancement View pull request | — |
1.0.3 | Enhancement View pull request | 7.14.0 or higher |
1.0.2 | Enhancement View pull request | — |
1.0.1 | Enhancement View pull request | 7.14.0 or higher |
1.0.0 | Enhancement View pull request | 7.14.0 or higher |
0.5.1 | Enhancement View pull request | — |
0.5.0 | Enhancement View pull request | — |
0.4.1 | Enhancement View pull request | — |
0.4.0 | Enhancement View pull request | — |
0.3.2 | Enhancement View pull request | — |
0.3.1 | Enhancement View pull request | — |
0.3.0 | Enhancement View pull request | — |
0.2.0 | Enhancement View pull request | — |
0.1.0 | Enhancement View pull request | — |
0.0.1 | Enhancement View pull request | — |