kanewinter/metrics-server-prom-aws

Kubernetes Metrics Server Prometheus适配器

动机 | 用法 | Docker Compose | 指标转换 | 许可证

动机

提供功能

该Docker镜像允许Prometheus采集Kubernetes metrics-server提供的指标。镜像可在任何Prometheus能作为目标访问的环境运行，包括Kubernetes集群内部。

需求背景

metrics-server是Kubernetes监控中heapster的继任者，但目前仅通过Kubernetes API服务器提供JSON格式的指标。而Prometheus需要特定的文本格式指标，因此需要将JSON格式透明转换为Prometheus支持的格式。

差异点

与metrics-server本身相比，该容器通过kubectl API调用获取额外的指标元数据，并将其包含在Prometheus输出中。

工作原理

1. Prometheus在:9100/metrics路径采集该Docker容器
2. 容器内的uwsgi将请求代理到kube-proxy
3. kube-proxy通过配置文件将请求隧道传输到Kubernetes集群的metrics-server
4. metrics-server返回JSON格式指标
5. kube-proxy将响应转发回uwsgi
6. uwsgi调用transform.py脚本
7. transform.py将JSON转换为Prometheus可读格式并返回给uwsgi
8. uwsgi将最终响应发送给Prometheus

用法

运行镜像

将kube config挂载到/etc/kube/config即可运行：

bash
$ docker run -d \
    -p 9100:9100 \
    -v ${HOME}/.kube/config:/etc/kube/config:ro \
    kanewinter/metrics-server-prom-aws

若kube config包含多个上下文，可指定使用的上下文：

bash
$ docker run -d \
    -p 9100:9100 \
    -v ${HOME}/.kube/config:/etc/kube/config:ro \
    -e KUBE_CONTEXT=my-context \
    kanewinter/metrics-server-prom-aws

配置Prometheus

在prometheus.yml中添加以下配置：

yml
scrape_configs:
  - job_name: 'kubernetes'
    scrape_interval: '15s'
    metrics_path: '/metrics'
    static_configs:
      - targets:
        - <DOCKER_IP地址>:9100

Docker Compose

本地测试可使用示例Docker Compose配置：

1. 进入example/目录
2. 将env-example复制为.env
3. 调整.env中的KUBE_CONTEXT
4. 运行docker-compose up

指标转换

metrics-server输出的JSON格式指标示例：

json
{
  "kind": "PodMetricsList",
  "apiVersion": "metrics.k8s.io/v1beta1",
  "metadata": {"selfLink": "/apis/metrics.k8s.io/v1beta1/pods"},
  "items": [
    {
      "metadata": {"name": "etcd-server-events-abc", "namespace": "kube-system", ...},
      "timestamp": "2018-08-20T03:19:00Z",
      "window": "1m0s",
      "containers": [{"name": "etcd-container", "usage": {"cpu": "7m", "memory": "125448Ki"}}]
    }
  ]
}

转换后的Prometheus格式示例（新增node和ip元数据）：

# HELP kube_metrics_server_pod_cpu  Pod的CPU时间（秒）
# TYPE kube_metrics_server_pod_cpu gauge
kube_metrics_server_pod_cpu{node="ip-10-30-78-99.eu-central-1.compute.internal",pod="etcd-server-events-abc",ip="10.30.62.138",container="etcd-container",namespace="kube-system"} 420
# HELP kube_metrics_server_pod_mem  Pod的内存（KB）
# TYPE kube_metrics_server_pod_mem gauge
kube_metrics_server_pod_mem{node="ip-10-30-78-99.eu-central-1.compute.internal",pod="etcd-server-events-abc",ip="10.30.62.138",container="etcd-container",namespace="kube-system"} 128475136

许可证

MIT License
Copyright (c) 2018 cytopia
该镜像在原镜像基础上添加了aws-iam-authenticator功能。