prom/container-exporter

Container Exporter 镜像文档

1. 镜像概述

1.1 镜像名称

prom/container-exporter

1.2 概述与主要用途

Container Exporter 是一款 Prometheus 指标导出器（Exporter），用于采集容器指标并暴露给 Prometheus。其核心功能是通过与容器管理器（当前支持 Docker）通信获取运行中容器列表，结合 libcontainer 和 DockerClient 工具集收集容器的各类运行指标（如 CPU、内存等），最终以 Prometheus 可识别的格式通过 HTTP 端口提供指标数据。

2. 核心功能与特性

• Docker 容器支持：目前已适配 Docker 容器管理器，可直接通过 Docker 套接字（Docker Socket）获取容器信息。
• 多维度指标采集：基于 libcontainer 和 DockerClient 采集容器的关键运行指标（如 CPU 使用率、内存占用、受限周期等）。
• 标签集成能力：支持将 Docker 容器标签（Label）作为 Prometheus 指标的标签（Label），实现指标的精细化筛选与聚合。
• 标准化指标暴露：通过 HTTP 端口（默认 9104）暴露指标，符合 Prometheus 采集规范。

3. 使用场景与适用范围

• Docker 容器监控：适用于基于 Prometheus 的 Docker 容器环境监控，需实时采集容器运行状态指标的场景。
• 标签化指标分析：需将容器自定义标签（如业务标识、环境信息）集成到监控指标中，实现按标签维度（如业务线、环境）分析容器性能的场景。

4. 使用方法与配置说明

4.1 基本部署

4.1.1 依赖说明

运行容器需挂载以下宿主机路径：

• /sys/fs/cgroup:/cgroup：提供 cgroup 层级文件系统访问，用于采集容器资源使用指标（如 CPU、内存）。
• /var/run/docker.sock:/var/run/docker.sock：提供 Docker 套接字访问，用于与 Docker 引擎通信获取容器列表及元数据。

4.1.2 部署命令

通过 docker run 命令启动容器，默认暴露 9104 端口：

bash
docker run -p 9104:9104 \
  -v /sys/fs/cgroup:/cgroup \
  -v /var/run/docker.sock:/var/run/docker.sock \
  prom/container-exporter

4.2 标签配置

4.2.1 功能说明

通过 -labels 参数可指定 Docker 容器标签，使 Prometheus 指标中包含这些标签的键值对，便于按标签维度聚合分析指标。未定义指定标签的容器，其对应标签值将以空字符串（""）显示。

4.2.2 使用方法

1. 为容器添加标签：创建容器时通过 --label 参数添加自定义标签（如 LabelA=ValueA）。
2. 启动 Exporter 时指定标签：通过 -labels 参数传入需集成的标签列表（逗号分隔）。

4.2.3 示例

步骤 1：创建带标签的容器

bash
# 创建 ContainerA，包含 LabelA 和 LabelB 标签
docker run --name ContainerA --label LabelA=ValueA --label LabelB=ValueB [镜像名称]

# 创建 ContainerB，包含 LabelB 和 LabelC 标签
docker run --name ContainerB --label LabelB=ValueB --label LabelC=ValueC [镜像名称]

步骤 2：启动 Exporter 并指定标签

bash
docker run -p 9104:9104 \
  -v /sys/fs/cgroup:/cgroup \
  -v /var/run/docker.sock:/var/run/docker.sock \
  prom/container-exporter -labels=LabelA,LabelB,LabelC

步骤 3：查看指标效果
Exporter 暴露的指标将包含指定标签，未定义标签的容器对应值为空字符串：

container_cpu_throttled_periods_total{LabelA="ValueA",LabelB="ValueB",LabelC="",name="ContainerA"...
container_cpu_throttled_periods_total{LabelA="",LabelB="ValueB",LabelC="ValueC",name="ContainerB"...

4.3 参数说明

5. 注意事项

• 权限要求：容器需具备访问 /sys/fs/cgroup 和 Docker 套接字的权限，建议以 root 用户运行（默认配置通常满足）。
• 标签数量限制：过多标签可能增加指标 cardinality，建议仅指定必要标签。
• 端口冲突：默认暴露 9104 端口，若需修改可通过 -p <主机端口>:9104 调整主机映射端口。