openkruise/kruise-state-metrics

kruise-state-metrics 镜像文档

镜像概述

本镜像为 https://github.com/openkruise/kruise 项目的 kruise-state-metrics 组件提供容器化部署支持。该组件专注于采集 Kubernetes 集群中 OpenKruise 扩展资源（如 AdvancedStatefulSet、StatefulSetAutoScaler、BroadcastJob 等）的运行时指标，并通过 HTTP 接口暴露，供 Prometheus 等监控系统采集，实现对 OpenKruise 管理的有状态应用的监控与运维。

核心功能和特性

• 多资源类型支持：支持采集 OpenKruise 核心扩展资源指标，包括但不限于 AdvancedStatefulSet、StatefulSetAutoScaler、BroadcastJob、AdvancedDaemonSet、NodeImage 等。
• Prometheus 兼容：暴露符合 Prometheus 格式的指标接口（默认路径 /metrics），可直接被 Prometheus 发现和采集。
• 可配置指标规则：支持通过配置文件自定义指标采集规则，过滤或增强特定资源的指标维度。
• 轻量级设计：容器镜像体积小，资源占用低，适合在 Kubernetes 集群中高效部署。
• Kubernetes API 集成：通过 Kubernetes API Server 动态发现和监听 OpenKruise 资源变化，确保指标实时性。

使用场景

• OpenKruise 资源监控：在部署 OpenKruise 的 Kubernetes 集群中，需监控 AdvancedStatefulSet 等扩展资源的副本状态、扩缩容进度、调度状态等指标时使用。
• 监控平台集成：作为 Prometheus 监控流水线的数据源，为 Grafana 面板、告警规则提供 OpenKruise 资源的指标数据。
• 有状态应用运维：辅助运维人员通过指标分析 OpenKruise 管理的有状态应用的稳定性和性能。

使用方法

基本运行方式

通常 kruise-state-metrics 需在 Kubernetes 集群中以 Deployment 或 DaemonSet 形式部署，以下为 Docker 直接运行示例（需确保宿主机可访问 Kubernetes API Server）：

bash
docker run -d \
  --name kruise-state-metrics \
  -p 9090:9090 \
  -v /path/to/kubeconfig:/etc/kubeconfig \
  docker.xuanyuan.run/openkruise/kruise-state-metrics:latest \
  --kubeconfig=/etc/kubeconfig \
  --metrics-port=9090 \
  --resources=AdvancedStatefulSet,StatefulSetAutoScaler

配置参数说明

环境变量配置

部分配置可通过环境变量传递，优先级低于命令行参数：

Kubernetes 部署示例

在 Kubernetes 集群中推荐通过 Deployment 部署，以下为简化的 YAML 示例：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kruise-state-metrics
  namespace: kruise-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: kruise-state-metrics
  template:
    metadata:
      labels:
        app: kruise-state-metrics
    spec:
      containers:
      - name: kruise-state-metrics
        image: docker.xuanyuan.run/openkruise/kruise-state-metrics:latest
        ports:
        - containerPort: 9090
          name: metrics
        args:
        - --metrics-port=9090
        - --resources=AdvancedStatefulSet,StatefulSetAutoScaler,BroadcastJob
        resources:
          limits:
            cpu: 100m
            memory: 128Mi
          requests:
            cpu: 50m
            memory: 64Mi

部署后，可通过 Service 暴露指标，并配置 Prometheus ServiceMonitor 进行采集：

yaml
apiVersion: v1
kind: Service
metadata:
  name: kruise-state-metrics
  namespace: kruise-system
spec:
  selector:
    app: kruise-state-metrics
  ports:
  - port: 80
    targetPort: metrics

指标说明

暴露的指标遵循 Prometheus 规范，常见指标包括：

• kruise_advanced_statefulset_replicas：AdvancedStatefulSet 的副本数
• kruise_advanced_statefulset_ready_replicas：AdvancedStatefulSet 的就绪副本数
• kruise_broadcastjob_completed_jobs：BroadcastJob 完成的 Pod 数
• kruise_statefulsetautoscaler_desired_replicas：StatefulSetAutoScaler 的期望副本数

完整指标列表可通过访问容器的 /metrics 端点查看。