Documentation Grafana Alloy Reference Components prometheus prometheus.exporter.azure

prometheus.exporter.azure

The prometheus.exporter.azure component embeds azure-metrics-exporter to collect metrics from Azure Monitor.

The exporter supports all metrics defined by Azure Monitor. You can find the complete list of available metrics in the Azure Monitor documentation. Metrics for this integration use the template azure_{type}_{metric}_{aggregation}_{unit} by default. As an example, the exporter exports the Egress metric for BlobService as azure_microsoft_storage_storageaccounts_blobservices_egress_total_bytes.

The exporter offers the following two options for gathering metrics.

1. Use an Azure Resource Graph query to identify resources for gathering metrics. This is the default option.
   1. This query makes one API call per resource identified.
   2. Subscriptions with a reasonable amount of resources can hit the 12000 requests per hour rate limit Azure enforces.
2. Set the regions to gather metrics from and get metrics for all resources across those regions.
   1. This option makes one API call per subscription, dramatically reducing the number of API calls.
   2. This approach doesn’t work with all resource types, and Azure doesn’t document which resource types do or don’t work.
   3. A resource type that’s not supported produces errors that look like Resource type: microsoft.containerservice/managedclusters not enabled for Cross Resource metrics.
   4. If you encounter one of these errors you must use the default Azure Resource Graph based option to gather metrics.

Authentication

Alloy must be running in an environment with access to Azure. The exporter uses the Azure SDK for Go and supports authentication.

The account used by Alloy needs:

• When using an Azure Resource Graph query, read access to the resources that Resource Graph queries.
• Permissions to call the Microsoft.Insights Metrics API which should be the Microsoft.Insights/Metrics/Read permission.

Usage

Alloy Copy

prometheus.exporter.azure "<LABEL>" {
        subscriptions = [
                <SUB_ID_1>,
                <SUB_ID_2>,
                ...
        ]

        resource_type = "<RESOURCE_TYPE>"

        metrics = [
                "<METRIC_1>",
                "<METRIC_2>",
                ...
        ]
}

Arguments

You can use the following arguments with prometheus.exporter.azure:

The list of available resource_type values and their corresponding metrics is in Azure Monitor essentials.

You can find the list of available regions for your subscription by running the Azure CLI command az account list-locations --query '[].name'.

You can embed resource_graph_query_filter into a template query of the form Resources | where type =~ "<resource_type>" | <resource_graph_query_filter> | project id, tags.

Valid values for metric_aggregations are minimum, maximum, average, total, and count. If you don’t specify an aggregation, the exporter retrieves the value from the metric. For example, the aggregation value of the metric Availability in Microsoft.ClassicStorage/storageAccounts is average. Every metric has its own set of dimensions. For example, the dimensions for the metric Availability in Microsoft.ClassicStorage/storageAccounts are GeoType, ApiName, and Authentication. If you request a single dimension, it has the name dimension. If you request multiple dimensions, they have the name dimension<dimension_name>.

The exporter adds tags in included_resource_tags as labels with the name tag_<tag_name>.

Valid values for azure_cloud_environment are azurecloud, azurechinacloud, azuregovernmentcloud and azurepprivatecloud.

validate_dimensions defaults to false to reduce the number of Azure exporter instances required when a resource_type has metrics with varying dimensions. When you enable validate_dimensions, you need one exporter instance per metric + dimension combination, which is more tedious to maintain.

You use timespan and interval to control how the exporter queries metrics from Azure Monitor. The exporter queries metrics over the timespan and returns the most recent data point at the specified interval. If you are having issues with missing metrics, try increasing the timespan to a larger value, such as PT10M for 10 minutes, or PT15M for 15 minutes.

Blocks

The prometheus.exporter.azure component doesn’t support any blocks. You can configure this component with arguments.

Exported fields

Component health

prometheus.exporter.azure is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.azure doesn’t expose any component-specific debug information.

Debug metrics

prometheus.exporter.azure doesn’t expose any component-specific debug metrics.

Examples

Alloy Copy

prometheus.exporter.azure "example" {
    subscriptions    = ["<SUBSCRIPTION_ID>"]
    resource_type    = "Microsoft.Storage/storageAccounts"
    regions          = [
        "westeurope",
    ]
    metric_namespace = "Microsoft.Storage/storageAccounts/blobServices"
    metrics          = [
        "Availability",
        "BlobCapacity",
        "BlobCount",
        "ContainerCount",
        "Egress",
        "IndexCapacity",
        "Ingress",
        "SuccessE2ELatency",
        "SuccessServerLatency",
        "Transactions",
    ]
    included_dimensions = [
        "ApiName",
        "TransactionType",
    ]
    timespan         = "PT1H"
}

// Configure a prometheus.scrape component to send metrics to.
prometheus.scrape "demo" {
    targets    = prometheus.exporter.azure.example.targets
    forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
    endpoint {
        url = "<PROMETHEUS_REMOTE_WRITE_URL>"

        basic_auth {
            username = "<USERNAME>"
            password = "<PASSWORD>"
        }
    }
}

Replace the following:

• <SUBSCRIPTION_ID>: An Azure subscription ID holding the resources you want to monitor. Add one array element per subscription ID.
• <PROMETHEUS_REMOTE_WRITE_URL>: The URL of the Prometheus remote_write compatible server to send metrics to.
• <USERNAME>: The username to use for authentication to the remote_write API.
• <PASSWORD>: The password to use for authentication to the remote_write API.

Compatible components

prometheus.exporter.azure has exports that can be consumed by the following components:

• Components that consume Targets