itzg/kube-metrics-reporter

itzg/kube-metrics-reporter 镜像文档

镜像概述

itzg/kube-metrics-reporter是一个轻量级应用，用于访问https://github.com/kubernetes/metrics%E5%B9%B6%E6%94%B6%E9%9B%86%E3%80%81%E6%8A%A5%E5%91%8APod%E5%AE%B9%E5%99%A8%E7%9A%84%E8%B5%84%E6%BA%90%E4%BD%BF%E7%94%A8%E6%8C%87%E6%A0%87%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%94%AF%E6%8C%81%E5%B0%86%E6%8C%87%E6%A0%87%E8%BE%93%E5%87%BA%E5%88%B0%E6%8E%A7%E5%88%B6%E5%8F%B0%E6%88%96%E5%8F%91%E9%80%81%E8%87%B3Telegraf%EF%BC%8C%E4%BE%BF%E4%BA%8E%E8%BF%9B%E4%B8%80%E6%AD%A5%E7%9A%84%E7%9B%91%E6%8E%A7%E5%92%8C%E5%88%86%E6%9E%90%E3%80%82

核心功能和特性

• 指标收集：从Kubernetes metrics API获取Pod容器的CPU和内存使用指标
• 灵活配置：支持自定义收集间隔、指定监控命名空间
• 多输出方式：默认输出到控制台，可配置发送至Telegraf
• 指标单位：CPU使用以毫核（1/1000 vCPU）为单位，内存使用以兆字节（Mi）为单位，与kubectl top pods输出一致
• 重复报告：可配置按指定间隔重复输出指标

使用场景

适用于Kubernetes集群环境中需要监控Pod容器资源使用情况的场景，尤其适合：

• 临时查看集群内Pod的CPU和内存占用
• 将容器指标集成到监控系统（如Telegraf+InfluxDB+Grafana）
• 资源使用趋势分析和容量规划

使用方法和配置说明

命令行参数与环境变量

报告方式

控制台报告（默认）

无需额外配置，启动后将直接在控制台输出指标，格式如下：

2019-12-27T22:39:36-06:00 pod=grafana-0, container=grafana, cpu=1m, mem=20Mi
2019-12-27T22:39:36-06:00 pod=nginx-ingress-controller-857f44797-gs92j, container=nginx-ingress-controller, cpu=6m, mem=111Mi
2019-12-27T22:39:36-06:00 pod=telegraf-mwrh9, container=telegraf, cpu=1m, mem=22Mi
2019-12-27T22:39:36-06:00 pod=influxdb-0, container=influxdb, cpu=2m, mem=37Mi

Telegraf报告

当配置TELEGRAF_ENDPOINT后，指标将以Influx行协议格式发送至指定的Telegraf端点。

Telegraf配置：需在Telegraf中启用socket_listener插件，示例配置：

toml
[[inputs.socket_listener]]
  service_address = "tcp://:8094"

发送的指标格式：

kubernetes_pod_container,container_name=nginx-ingress-controller,host=dbc5f9812889,namespace=default,pod_name=nginx-ingress-controller-857f44797-gs92j cpu_usage_millicores=8i,memory_usage_mbytes=111i 1577507390268680300
kubernetes_pod_container,container_name=grafana,host=dbc5f9812889,namespace=default,pod_name=grafana-0 cpu_usage_millicores=1i,memory_usage_mbytes=20i 1577507390268680300

服务账户配置

由于应用需要访问Kubernetes metrics API，需为其配置具有适当权限的服务账户。

创建服务账户、角色和角色绑定

yaml
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: kube-metrics-monitor
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: kube-metrics-monitor
rules:
  - apiGroups: ["metrics.k8s.io"]
    resources:
      - pods
    verbs: ["get", "list"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: kube-metrics-monitor
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: kube-metrics-monitor
subjects:
  - kind: ServiceAccount
    name: kube-metrics-monitor

Kubernetes部署示例

以下是在Kubernetes中部署该应用的示例：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kube-metrics-reporter
  labels:
    app: kube-metrics-reporter
spec:
  replicas: 1
  template:
    metadata:
      name: kube-metrics-reporter
      labels:
        app: kube-metrics-reporter
    spec:
      serviceAccountName: kube-metrics-monitor
      containers:
        - name: kube-metrics-reporter
          image: itzg/kube-metrics-reporter:v0.1.0
          env:
            - name: TELEGRAF_ENDPOINT
              value: telegraf:8094  # 替换为实际的Telegraf服务地址
            - name: NAMESPACE
              valueFrom:
                fieldRef:
                  fieldPath: metadata.namespace  # 使用当前命名空间
            - name: INTERVAL
              value: "30s"  # 设置30秒收集一次指标
            - name: REPEAT
              value: "true"  # 启用重复报告
          resources:
            requests:
              cpu: 10m  # 资源请求
      restartPolicy: Always
  selector:
    matchLabels:
      app: kube-metrics-reporter