Harbor监控指标端口配置问题解析与解决方案

问题背景

在使用Harbor 2.9.1版本部署于Kubernetes环境时，用户希望通过VictoriaMetrics（功能类似Prometheus Operator）监控Harbor实例。按照常规做法，用户创建了VMServiceScrape资源来抓取Harbor的监控指标，但遇到了端口命名问题导致监控失败。

核心问题分析

Harbor默认部署时，其核心组件（Core、Jobservice、Registry和Exporter）的监控端口被命名为"https-metrics"而非通用的"metrics"。这种命名差异导致了以下问题：

1. 当使用标准ServiceMonitor配置（指定端口为"metrics"）时，监控系统无法正确发现和抓取指标
2. 即使显式指定端口为"https-metrics"，某些监控系统（如Prometheus）仍可能无法正常工作

技术细节

Harbor的Helm chart中，监控相关配置位于values.yaml文件的metrics部分。默认配置如下：

metrics:
  enabled: false
  exporter:
    path: /metrics
    port: 8001

虽然这里指定了指标路径和端口号，但并未直接控制Kubernetes Service中端口的命名方式。这导致了部署后的Service中端口名称与通用监控配置不匹配的问题。

解决方案

方案一：修改ServiceMonitor配置

对于能够识别"https-metrics"端口名的监控系统，可以直接修改VMServiceScrape/ServiceMonitor资源配置：

apiVersion: operator.victoriametrics.com/v1beta1
kind: VMServiceScrape
metadata:
  name: harbor
  namespace: harbor
spec:
  endpoints:
  - port: https-metrics
  selector:
    matchLabels:
      app: harbor

方案二：修改Harbor Helm配置

更彻底的解决方案是通过修改Harbor的Helm values来统一端口命名：

1. 创建自定义values文件（如custom-values.yaml）
2. 添加或修改以下配置：

metrics:
  enabled: true
  service:
    ports:
      metrics:
        name: metrics  # 将端口名从https-metrics改为metrics
        port: 8001

3. 使用修改后的values文件部署/升级Harbor

方案三：手动修改Kubernetes资源

对于已部署的环境，可以直接编辑Kubernetes Service资源：

kubectl edit svc -n harbor harbor-core

然后找到名为https-metrics的端口，将其name字段修改为metrics。此方法虽然直接，但不建议用于生产环境，因为修改可能在下次Helm升级时被覆盖。

最佳实践建议

1. 统一命名规范：在企业内部建立统一的监控端口命名规范，避免类似问题
2. 基础设施即代码：通过修改Helm values文件而非手动修改资源，确保配置可重复、可版本控制
3. 监控验证：部署后使用以下命令验证指标端点是否可达：

   kubectl port-forward -n harbor svc/harbor-core 8001:8001
   curl localhost:8001/metrics
   

4. TLS考虑：如果使用https-metrics名称，确保监控系统配置了正确的TLS设置来访问HTTPS端点

总结

Harbor默认的监控端口命名"https-metrics"与通用监控实践存在差异，这可能导致监控系统无法自动发现指标端点。通过修改Helm配置或调整监控系统配置，可以解决这一问题。建议采用基础设施即代码的方式，通过修改values.yaml文件来统一配置，确保部署的一致性和可维护性。