​

Azuremonitor Receiver

​

Supported Telemetry

​

Overview

​

Configuration

• subscription_ids: list of subscriptions on which the resource’s metrics are collected
• or discover_subscriptions: (default = false) If set to true, will collect metrics from all subscriptions in the tenant.

• auth.authenticator: Specifies the component ID to use to authenticate requests to Azure API. Use azureauth extension.
• credentials (Deprecated since [v0.129.0]: use auth instead)(default = service_principal): Specifies the used authentication method. Supported values are service_principal, workload_identity, managed_identity, default_credentials.
• resource_groups (default = none): Filter metrics for specific resource groups, not setting a value will scrape metrics for all resources in the subscription.
• services (default = none): Filter metrics for specific services, not setting a value will scrape metrics for all services integrated with Azure Monitor.
• metrics (default = none): Filter metrics by name and aggregations. Not setting a value will scrape all metrics and their aggregations.
• cache_resources (default = 86400): List of resources will be cached for the provided amount of time in seconds.
• cache_resources_definitions (default = 86400): List of metrics definitions will be cached for the provided amount of time in seconds.
• maximum_number_of_metrics_in_a_call (default = 20): Maximum number of metrics to fetch in per API call, current limit in Azure is 20 (as of 03/27/2023).
• maximum_number_of_records_per_resource (default = 10): Maximum number of records to fetch per resource.
• initial_delay (default = 1s): defines how long this receiver waits before starting.
• cloud (default = AzureCloud): defines which Azure cloud to use. Valid values: AzureCloud, AzureUSGovernment, AzureChinaCloud.
• dimensions.enabled (default = true): allows to opt out from automatically split by all the dimensions of the resource type.
• dimensions.overrides (default = {}): if dimensions are enabled, it allows you to specify a set of dimensions for a particular metric. This is a two levels map with first key being the resource type and second key being the metric name. Programmatic value should be used for metric name https://learn.microsoft.com/en-us/azure/azure-monitor/reference/metrics-index
• append_tags_as_attributes (default = []): Controls which Azure resource tags are added as resource attributes to the metrics. Can be a list of specific tag names or ["*"] to include all tags.
• use_batch_api (default = false): Use the batch API to fetch metrics. This is useful when the number of subscriptions is high and the API calls are rate limited.
• maximum_resources_per_batch (default = 50): If batch is enabled, the maximum number of unique resource IDs to fetch per API call, current limit is 50 (as of 06/16/2025) https://learn.microsoft.com/en-us/azure/azure-monitor/metrics/migrate-to-batch-api?tabs=individual-response

• tenant_id
• client_id
• client_secret

• tenant_id
• client_id
• federate_token_file

• client_id

​

Filtering metrics

• the key of the top-level is the Azure Metric Namespace,
• the key of the nested map is an Azure Metric Name,
• and the map values are a list of aggregation methods (e.g., Average, Minimum, Maximum, Total, Count).

[!NOTE]

• “All aggregations” shortcut: The metric map value can be an empty array [] or an array with one “wildcard” element [*]. In this case, the scraper will fetch all supported aggregations for that metric, which is also the case if no metrics configuration is provided.
• Case Insensitive: The letter case of the Namespaces, Metric names, and Aggregations does not affect the functionality.

[!WARNING]
If you started providing a metrics configuration for a namespace, you have to specify all the metrics and their aggregations for that namespace. Otherwise, these metrics will be ignored.

receivers:
  azure_monitor:
    resource_groups:
      - ${resource_groups}
    services:
      - Microsoft.EventHub/namespaces
      - Microsoft.AAD/DomainServices # scraper will fetch all metrics from this namespace since there are no limits under the "metrics" option
    metrics:
      "microsoft.eventhub/namespaces": # scraper will fetch only the metrics listed below:
        IncomingMessages: [total]     # metric IncomingMessages with aggregation "Total"
        NamespaceCpuUsage: [*]        # metric NamespaceCpuUsage with all known aggregations
        ActiveConnections: []         # metric ActiveConnections with all known aggregations (same effect than [*])

​

Use Batch API (experimental)

• the Azure Resource Manager (ARM) API (currently by default)
• the Azure Monitor Metrics Data Plane API (with use_batch_api=true)

Some highlights from announcement blog post - Jan 31, 2024

• Higher Querying Limits: This API is designed to handle metric data queries for resources with higher query limits compared to existing Azure Resource Manager APIs. This is particularly advantageous for customers with large subscriptions containing numerous resources. While the REST API allows only 12,000 API calls per hour, the Azure Metrics Data Plane API elevates this limit to a staggering 360,000 API calls per hour. This increase in query throughput ensures a more efficient and streamlined experience for customers.
• Efficiency: The efficiency of this API shines when collecting metrics for multiple resources. Instead of making multiple API calls for each resource, the Azure Metrics Data Plane API offers a single batch API call that can accommodate up to 50 resource IDs. This results in higher throughput and more efficient querying, making it a time-saving solution.
• Improved Performance: The performance of client-side services can be greatly enhanced by reducing the number of calls required to extract the same amount of metric data for resources. The Azure Metrics Data Plane API optimizes the data retrieval process, ultimately leading to improved performance across the board.

receivers:
  azure_monitor:
    use_batch_api: true
    ... # no change for other configs

​

Example Configurations

receivers:
  azure_monitor:
    subscription_ids: ["${subscription_id}"]
    tenant_id: "${tenant_id}"
    client_id: "${client_id}"
    client_secret: "${env:CLIENT_SECRET}"
    cloud: AzureUSGovernment
    resource_groups:
      - "${resource_group1}"
      - "${resource_group2}"
    services:
      - "${service1}"
      - "${service2}"
    collection_interval: 60s
    initial_delay: 1s

receivers:
  azure_monitor:
    subscription_ids: ["${subscription_id}"]
    credentials: "workload_identity"
    tenant_id: "${env:AZURE_TENANT_ID}"
    client_id: "${env:AZURE_CLIENT_ID}"
    federated_token_file: "${env:AZURE_FEDERATED_TOKEN_FILE}"

receivers:
  azure_monitor:
    subscription_ids: ["${subscription_id}"]
    credentials: "managed_identity"
    client_id: "${env:AZURE_CLIENT_ID}"

receivers:
  azure_monitor:
    subscription_ids: ["${subscription_id}"]
    credentials: "default_credentials"

receivers:
  azure_monitor:
    subscription_ids: ["${subscription_id}"]
    auth:
      authenticator: azure_auth

extensions:
  azure_auth:
    managed_identity:
      client_id: ${client_id}

receivers:
  azure_monitor:
    dimensions:
      enabled: true
      overrides:
        "Microsoft.Network/azureFirewalls":
          # Real example of an Azure limitation here:
          # Dimensions exposed are Reason, Status, Protocol,
          # but when selecting Protocol in the filters, it returns nothing.
          # Note here that the metric display name is ``Network rules hit count`` but it's programmatic value is ``NetworkRuleHit``
          # Ref: https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-network-azurefirewalls-metrics
          "NetworkRuleHit": [Reason, Status]

receivers:
  azure_monitor:
    # Include all tags
    append_tags_as_attributes: ["*"]
    
    # Or include only specific tags
    append_tags_as_attributes: ["service", "environment"]

​

Metrics

​

Azure API calls summary

​

Subscriptions - Get

conditions:
- subscription_ids is set
- discover_subscriptions is false or not set
- resource_attributes.subscription.enabled is true
cardinality: once per sub id

​

Subscriptions - List

conditions:
- discover_subscriptions is true
cardinality: once per *page of sub

​

Resources - List

conditions:
- always
cardinality: once per sub id

​

Metrics Definitions - List

conditions: always
cardinality:
  - if use_batch_api is false, once per res id and *page of metrics def
  - if use_batch_api is true, once per res type and *page of metrics def

​

Metrics - List

conditions:
- use_batch_api is false
cardinality: once per res id, *page of metrics, and **composite key

​

Metrics Batch - Batch

conditions:
- use_batch_api is true
cardinality: once per res type and **composite key

*page size has not been clearly identified, reading the documentation. Even Chat Bots lose themselves with the “top”/“$top” filter that doesn’t seem related, and give random results from 10 to 1000… **the composite key is an identifier formed with info retrieved in metric definitions. Useful to group and reduce the number of metrics calls. It is composed by

• dimensions,
• aggregations,
• minimum timegrain.

It is used to get several metrics in one request.

​

Resource Attributes

​

Configuration

​

Example Configuration

azure_monitor/valid_subscription_ids:
  subscription_ids:
    - test
  credentials: default_credentials

azure_monitor/valid_discover_subscription:
  discover_subscriptions: true
  credentials: default_credentials

azure_monitor/missing_subscriptions:
  subscription_ids: []
  discover_subscriptions: false
  credentials: default_credentials

azure_monitor/invalid_cloud:
  discover_subscriptions: true
  cloud: invalid
  credentials: default_credentials

azure_monitor/missing_service_principal:
  discover_subscriptions: true
  credentials: service_principal

azure_monitor/missing_workload_identity:
  discover_subscriptions: true
  credentials: workload_identity

azure_monitor/invalid_credentials:
  discover_subscriptions: true
  credentials: invalid

azure_monitor/valid_authenticator:
  discover_subscriptions: true
  auth:
    authenticator: azureauth/monitor
  credentials: does-not-matter

azure_monitor/valid_authenticator_2:
  discover_subscriptions: true
  auth:
    authenticator: azureauth
  credentials: does-not-matter

azure_monitor/max_resources_per_batch_negative_value:
  discover_subscriptions: true
  auth:
    authenticator: azureauth
  credentials: does-not-matter
  use_batch_api: true
  maximum_resources_per_batch: -1

azure_monitor/append_tags_all:
  subscription_ids:
    - test
  credentials: default_credentials
  append_tags_as_attributes: ["*"]

azure_monitor/append_tags_specific:
  subscription_ids:
    - test
  credentials: default_credentials
  append_tags_as_attributes: ["service", "environment"]