如何为 prometheus-operator 创建 ServiceMonitor？

Question

最近，prometheus-operator 被提升为 stable helm chart (https://github.com/helm/charts/tree/master/stable/prometheus-operator)。

我想了解如何在 k8s 集群中添加自定义应用程序以通过 prometheus-operator 进行监控。举个例子，比如 gitlab runner，它默认提供 9252 的指标，将不胜感激 (https://docs.gitlab.com/runner/monitoring/#configuration-of-the-metrics-http-server)。

我有一个基本的 yaml，它显然不起作用，但也没有提供任何关于 什么 不起作用的反馈：

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: gitlab-monitor
  # Change this to the namespace the Prometheus instance is running in
  namespace: default
  labels:
    app: gitlab-runner-gitlab-runner
    release: prometheus
spec:
  selector:
    matchLabels:
      app: gitlab-runner-gitlab-runner
  namespaceSelector:
    # matchNames:
    # - default
    any: true
  endpoints:
  - port: http-metrics
    interval: 15s

这是prometheus的配置：

> kubectl get prometheus -o yaml

...
serviceMonitorNamespaceSelector: {}
serviceMonitorSelector:
  matchLabels:
    release: prometheus
...

所以选择器应该匹配。 “不工作”是指端点没有出现在 prometheus UI 中。

Answer 1

感谢彼得向我展示了原则上的想法并不完全不正确，我找到了缺失的链接。作为servicemonitor 监控服务（哈哈），我错过了创建不属于 gitlab helm chart 的服务的部分。最后，这个 yaml 为我解决了问题，指标出现在 Prometheus 中：

# Service targeting gitlab instances
apiVersion: v1
kind: Service
metadata:
  name: gitlab-metrics
  labels:
    app: gitlab-runner-gitlab-runner
spec:
  ports:
  - name: metrics # expose metrics port
    port: 9252 # defined in gitlab chart
    targetPort: metrics
    protocol: TCP
  selector:
    app: gitlab-runner-gitlab-runner # target gitlab pods
---
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: gitlab-metrics-servicemonitor
  # Change this to the namespace the Prometheus instance is running in
  # namespace: default
  labels:
    app: gitlab-runner-gitlab-runner
    release: prometheus
spec:
  selector:
    matchLabels:
      app: gitlab-runner-gitlab-runner # target gitlab service
  endpoints:
  - port: metrics
    interval: 15s

很高兴知道：metrics targetPort 在 gitlab runner 图表中定义。

Answer 2

我知道这个问题已经得到解答。但是当使用 Helm 的 stable/prometheus-operator 图表部署在 Kubernetes 中的 Prometheus 找不到我的ServiceMonitor 的任何活动目标时，我遇到了类似的问题。 原来我的服务暴露了一个我没有明确命名的端口：

  - protocol: TCP
    port: 8080
    targetPort: uwsgi

我可以通过定位uwsgi 端口在 Ingress 中使用它。但似乎ServiceMonitor 需要在Service 中明确命名端口，即使它与自己的tgetPort 同名：

  - name: uwsgi
    protocol: TCP
    port: 8080
    targetPort: uwsgi

我已经写了一篇关于这个问题的博文here

Answer 3

到目前为止，上述解决方案都运行良好。

发布标签很重要。没有这个，Prom 就无法将应用指标添加到其目标列表中。

确保通过检查 Prometheus 本身的 ServiceMonitor 来添加正确的发布标签。还要确保在元数据和规范部分中也将发布标签添加到服务和部署文件中。

如果您遇到 Prometheus 显示目标但不显示端点的情况，请查看：https://github.com/prometheus-operator/prometheus-operator/issues/3053

Answer 4

这张图完美展示了Prometheus、ServiceMonitors和Services之间的联系

如果任何匹配项不正确，目标将不会显示。

阅读更多：https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/troubleshooting.md#troubleshooting-servicemonitor-changes