k8s-prometheus-adapter中自定义指标配置问题解析

问题背景

在使用k8s-prometheus-adapter配置自定义指标时，用户遇到了无法正确获取自定义指标的问题。具体表现为配置了新的seriesQuery后，虽然Prometheus-adapter能够运行，但在查询自定义指标时出现超时错误，且新配置的指标未出现在可用指标列表中。

错误现象分析

用户配置了一个名为"ready_pods_per_deployment"的指标，旨在统计每个Deployment中处于就绪状态的Pod数量。配置如下：

- seriesQuery: 'kube_pod_status_ready{condition="true"}'
  name:
    matches: "ready_pods_per_deployment"
    as: "ready_pods"
  metricsQuery: |
    sum by (owner_name) (
      kube_pod_status_ready{condition="true"}
      * on(pod) group_left(owner_name) kube_pod_owner{owner_kind="ReplicaSet"}
    )

然而，在查询自定义指标时，系统返回了大量超时错误日志，如"http: Handler timeout"和"http2: stream closed"等。这些错误表明Prometheus-adapter在处理请求时遇到了性能问题或配置问题。

问题根源

经过深入分析，发现问题的根本原因在于配置中缺少了必要的resources部分。在Prometheus-adapter的配置中，resources部分用于定义如何将Prometheus中的标签映射到Kubernetes资源上。缺少这部分配置会导致适配器无法正确关联指标与Kubernetes资源，进而导致查询失败。

解决方案

正确的配置应该包含resources部分，明确指定如何将Prometheus标签映射到Kubernetes资源。修正后的配置如下：

- seriesQuery: 'kube_pod_status_ready{condition="true"}'
  resources:
    overrides:
      namespace: {resource: "namespace"}
      pod: {resource: "pod"}
  name:
    matches: "^kube_pod_status_ready$"
    as: "ready_pods"
  metricsQuery: 'sum by (namespace, pod) (kube_pod_status_ready{condition="true"})'

这个修正后的配置：

1. 明确指定了namespace和pod标签如何映射到Kubernetes资源
2. 简化了metricsQuery，直接按namespace和pod分组统计就绪状态的Pod数量
3. 使用了更精确的正则表达式匹配原始指标名称

技术要点

1. resources配置的重要性：在Prometheus-adapter中，resources部分是将Prometheus指标与Kubernetes资源关联的关键。它告诉适配器如何将Prometheus标签转换为Kubernetes API可以理解的资源标识。

2. 标签映射原理：overrides允许覆盖默认的标签映射规则。在这个案例中，我们明确指定了namespace和pod标签对应的Kubernetes资源类型。

3. 查询优化：原始配置中的复杂join操作(* on(pod) group_left)可能导致性能问题。简化后的查询更直接，减少了计算复杂度。

4. 指标命名规范：使用^kube_pod_status_ready$这样的精确匹配可以避免意外的指标名称冲突。

最佳实践建议

1. 在配置自定义指标时，始终包含完整的resources部分
2. 对于简单的聚合需求，优先考虑使用简单的PromQL查询
3. 在修改配置后，检查Prometheus-adapter的日志以确保没有错误
4. 使用kubectl get --raw命令验证指标是否已正确注册
5. 对于复杂的指标转换，考虑分步测试，先验证基本查询再添加复杂逻辑

总结

在k8s-prometheus-adapter中配置自定义指标时，resources部分的正确配置至关重要。它不仅影响指标能否正确显示，还关系到查询的性能和稳定性。通过遵循正确的配置模式和简化查询逻辑，可以有效地解决自定义指标查询中的各种问题，为Kubernetes的自动伸缩和监控提供可靠的数据支持。