Docker CLI 的 OpenTelemetry

Docker CLI 支持 OpenTelemetry 用于发射有关命令调用的指标的仪器。默认情况下，这是禁用的。您可以配置 CLI 开始将指标发射到您指定的端点。这使您可以捕获有关 docker 命令调用的信息，以便更深入地了解您的 Docker 使用情况。

导出指标是可选的，您可以通过指定指标收集器的目标地址来控制数据发送的位置。

什么是 OpenTelemetry？

OpenTelemetry，或简称 OTel，是一个用于创建和管理遥测数据的开放可观测性框架，例如跟踪、指标和日志。OpenTelemetry 与供应商和工具无关，这意味着它可以与各种可观测性后端一起使用。

Docker CLI 中对 OpenTelemetry 仪器的支持意味着 CLI 可以使用 Open Telemetry 规范中定义的协议和约定，发射有关发生的事件的信息。

工作原理

Docker CLI 默认情况下不会发射遥测数据。只有在您在系统上设置了环境变量后，Docker CLI 才会尝试将 OpenTelemetry 指标发射到您指定的端点。

DOCKER_CLI_OTEL_EXPORTER_OTLP_ENDPOINT=<endpoint>

该变量指定 OpenTelemetry 收集器的端点，docker CLI 调用相关的遥测数据应发送到该端点。要捕获数据，您需要一个在该端点上侦听的 OpenTelemetry 收集器。

收集器的目的是接收遥测数据、处理它并将其导出到后端。后端是遥测数据存储的位置。您可以从许多不同的后端中选择，例如 Prometheus 或 InfluxDB。

一些后端提供用于直接可视化指标的工具。或者，您也可以运行一个支持生成更有用的图表（例如 Grafana）的专用前端。

设置

要开始为 Docker CLI 捕获遥测数据，您需要

• 将 DOCKER_CLI_OTEL_EXPORTER_OTLP_ENDPOINT 环境变量设置为指向 OpenTelemetry 收集器端点
• 运行一个接收来自 CLI 命令调用的信号的 OpenTelemetry 收集器
• 运行一个用于存储从收集器接收的数据的后端

以下 Docker Compose 文件引导了一组服务以开始使用 OpenTelemetry。它包括一个 OpenTelemetry 收集器，CLI 可以将指标发送到该收集器，以及一个从收集器抓取指标的 Prometheus 后端。

name: cli-otel
services:
  prometheus:
    image: prom/prometheus
    command:
      - "--config.file=/etc/prometheus/prom.yml"
    ports:
      # Publish the Prometheus frontend on localhost:9091
      - 9091:9090
    restart: always
    volumes:
      # Store Prometheus data in a volume:
      - prom_data:/prometheus
      # Mount the prom.yml config file
      - ./prom.yml:/etc/prometheus/prom.yml
  otelcol:
    image: otel/opentelemetry-collector
    restart: always
    depends_on:
      - prometheus
    ports:
      - 4317:4317
    volumes:
      # Mount the otelcol.yml config file
      - ./otelcol.yml:/etc/otelcol/config.yaml

volumes:
  prom_data:

此服务假定以下两个配置文件与 compose.yml 位于同一目录中

• otelcol.yml

  显示更多

  # Receive signals over gRPC and HTTP
  receivers:
    otlp:
      protocols:
        grpc:
        http:
  
  # Establish an endpoint for Prometheus to scrape from
  exporters:
    prometheus:
      endpoint: "0.0.0.0:8889"
  
  service:
    pipelines:
      metrics:
        receivers: [otlp]
        exporters: [prometheus]

  隐藏
• prom.yml

  显示更多

  # Configure Prometheus to scrape the OpenTelemetry collector endpoint
  scrape_configs:
    - job_name: "otel-collector"
      scrape_interval: 1s
      static_configs:
        - targets: ["otelcol:8889"]

  隐藏

有了这些文件后

1. 启动 Docker Compose 服务

   $ docker compose up
   

2. 配置 Docker CLI 以将遥测导出到 OpenTelemetry 收集器。

   $ export DOCKER_CLI_OTEL_EXPORTER_OTLP_ENDPOINT=https://127.0.0.1:4317
   

3. 运行 docker 命令以触发 CLI 将指标信号发送到 OpenTelemetry 收集器。

   $ docker version
   

4. 要查看 CLI 创建的遥测指标，请通过访问 https://127.0.0.1:9091/graph 打开 Prometheus 表达式浏览器。

5. 在 查询 字段中，输入 command_time_milliseconds_total 并执行查询以查看遥测数据。

可用指标

Docker CLI 目前导出一个指标 command.time，它以毫秒为单位衡量命令的执行持续时间。此指标具有以下属性

• command.name：命令的名称
• command.status.code：命令的退出代码
• command.stderr.isatty：如果 stderr 连接到 TTY，则为 true
• command.stdin.isatty：如果 stdin 连接到 TTY，则为 true
• command.stdout.isatty：如果 stdout 连接到 TTY，则为 true