Azure Insights metrics exporter 中文技术文档

1. 镜像概述

Azure Insights metrics exporter 是一款 Prometheus 导出器，用于按需抓取 Azure Insights 指标。支持通过单次抓取从所有资源获取指标（自动服务发现），并支持指标维度，配置完全通过 Prometheus 完成，无需单独的配置文件。

2. 核心功能与特性

• 自动服务发现：支持从 Azure 订阅中自动发现资源并抓取指标
• 维度支持：支持 Azure 指标的维度标签，可通过参数筛选和聚合
• 灵活的探测端点：提供多种 HTTP 端点，支持单资源、资源列表、基于标签的资源配置及 LogAnalytics 查询
• 缓存机制：支持内部缓存，提升指标抓取效率
• 并发控制：可配置订阅和资源级别的并发请求数，优化抓取性能
• Prometheus 原生集成：指标格式符合 Prometheus 规范，支持通过 Prometheus 配置自定义抓取参数

3. 使用场景与适用范围

适用场景

• 将 Azure 云资源指标（如 Redis、虚拟网络网关、虚拟机等）集成到 Prometheus 监控体系
• 按需抓取 Azure LogAnalytics 查询结果并转换为 Prometheus 指标
• 对 Azure 资源指标进行多维度分析和告警

适用范围

• 支持所有提供 Azure Insights 指标的 Azure 资源类型（如 Microsoft.Cache/Redis、Microsoft.Network/virtualNetworkGateways 等）
• 支持 Azure 公有云及其他 Azure 环境（通过环境变量配置）

4. 配置说明

4.1 命令行参数与环境变量

4.2 Azure API 认证

通过环境变量配置 Azure API 认证，支持 Azure SDK for Go 提供的所有认证方式，详情参考 Azure SDK for Go 认证文档。常用认证环境变量：

• AZURE_CLIENT_ID：服务主体客户端 ID
• AZURE_CLIENT_SECRET：服务主体客户端密钥
• AZURE_TENANT_ID：Azure 租户 ID
• AZURE_SUBSCRIPTION_ID：目标 Azure 订阅 ID

5. 指标说明

6. HTTP 端点

6.1 /probe/metrics/resource 参数

6.2 /probe/metrics/list 参数

6.3 /probe/metrics/scrape 参数

6.4 /probe/loganalytics/query 参数

7. Docker 部署方案

7.1 docker run 命令示例

bash
docker run -d \
  --name azure-metrics-exporter \
  -p 8080:8080 \
  -e AZURE_CLIENT_ID="your-client-id" \
  -e AZURE_CLIENT_SECRET="your-client-secret" \
  -e AZURE_TENANT_ID="your-tenant-id" \
  -e SERVER_BIND=":8080" \
  -e CONCURRENCY_SUBSCRIPTION="5" \
  -e ENABLE_CACHING="true" \
  webdevops/azure-metrics-exporter

7.2 Docker Compose 配置示例

yaml
version: '3'
services:
  azure-metrics-exporter:
    image: webdevops/azure-metrics-exporter
    container_name: azure-metrics-exporter
    ports:
      - "8080:8080"
    environment:
      - AZURE_CLIENT_ID=your-client-id
      - AZURE_CLIENT_SECRET=your-client-secret
      - AZURE_TENANT_ID=your-tenant-id
      - AZURE_ENVIRONMENT=AZUREPUBLICCLOUD  # 如使用中国云，改为 AZURECHINACLOUD
      - SERVER_BIND=:8080
      - CONCURRENCY_SUBSCRIPTION=5
      - CONCURRENCY_SUBSCRIPTION_RESOURCE=10
      - ENABLE_CACHING=true
      - LOG_JSON=false  # 如需 JSON 日志，设为 true
    restart: unless-stopped

8. Prometheus 配置示例

8.1 Azure Redis 指标

yaml
- job_name: azure-metrics-redis
  scrape_interval: 1m
  metrics_path: /probe/metrics/list
  params:
    name: ["my_redis_metric"]  # 自定义指标名称
    subscription: 
      - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx  # 替换为实际订阅 ID
    filter: ["resourceType eq 'Microsoft.Cache/Redis'"]  # 筛选 Redis 资源
    metric:       
      - connectedclients       # 连接客户端数
      - totalcommandsprocessed # 总命令处理数
      - cachehits              # 缓存命中数
      - cachemisses            # 缓存未命中数
      - usedmemory             # 内存使用量
      - usedmemorypercentage   # 内存使用率
    interval: ["PT1M"]         # 采样间隔：1 分钟
    timespan: ["PT1M"]         # 时间范围：过去 1 分钟
    aggregation:  
      - average                # 平均值
      - total                  # 总和
  static_configs:
    - targets: ["azure-metrics-exporter:8080"]  # 导出器服务地址

8.2 虚拟网络网关指标

yaml
- job_name: azure-metrics-virtualNetworkGateways
  scrape_interval: 1m
  metrics_path: /probe/metrics/list
  params:
    name: ["my_vng_metric"]  # 自定义指标名称
    subscription: 
      - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx  # 替换为实际订阅 ID
    filter: ["resourceType eq 'Microsoft.Network/virtualNetworkGateways'"]  # 筛选虚拟网络网关
    metric:       
      - AverageBandwidth       # 平均带宽
      - P2SBandwidth           # P2S 带宽
      - P2SConnectionCount     # P2S 连接数
      - TunnelAverageBandwidth # 隧道平均带宽
      - TunnelEgressBytes      # 隧道出口字节数
      - TunnelIngressBytes     # 隧道入口字节数
    interval: ["PT5M"]         # 采样间隔：5 分钟
    timespan: ["PT5M"]         # 时间范围：过去 5 分钟
    aggregation:
      - average                # 平均值
      - total                  # 总和
  static_configs:
    - targets: ["azure-metrics-exporter:8080"]  # 导出器服务地址

8.3 虚拟网络网关连接指标（维度支持）

yaml
- job_name: azure-metrics-virtualNetworkGateways-connections
  scrape_interval:1m
  metrics_path: /probe/metrics/list
  params:
    name: ["my_vng_connection_metric"]  # 自定义指标名称
    subscription: 
      - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx  # 替换为实际订阅 ID
    filter: ["resourceType eq 'Microsoft.Network/virtualNetworkGateways'"]  # 筛选虚拟网络网关
    metric:
      - TunnelAverageBandwidth          # 隧道平均带宽
      - TunnelEgressBytes               # 隧道出口字节数
      - TunnelIngressBytes              # 隧道入口字节数
    interval: ["PT5M"]                  # 采样间隔：5 分钟
    timespan: ["PT5M"]                  # 时间范围：过去 5 分钟
    aggregation:  
      - average                         # 平均值
      - total                           # 总和
    metricFilter: ["ConnectionName eq '*'"]  # 筛选所有连接
    metricTop: ["10"]                   # 最多返回 10 个连接的维度结果
  static_configs:
    - targets: ["azure-metrics-exporter:8080"]  # 导出器服务地址

注：所有示例中的订阅 ID、资源筛选器、指标名称等需根据实际 Azure 环境替换。支持的 Azure 指标列表可参考 Azure 指标支持文档。