5.2. 在时间序列和警报中附加额外标签

流程

1. 编辑 ConfigMap 对象：

   • 对于监控 OpenShift Container Platform 核心项目的 Prometheus 实例，要将自定义标签附加到离开的所有时间序列和警报：

     1. 编辑 openshift-monitoring 项目中的 cluster-monitoring-config ConfigMap 对象：

        $ oc -n openshift-monitoring edit configmap cluster-monitoring-config

     2. 在 data/config.yaml 下定义每个指标要添加的标签映射:

        apiVersion: v1
        kind: ConfigMap
        metadata:
          name: cluster-monitoring-config
          namespace: openshift-monitoring
        data:
          config.yaml: |
            prometheusK8s:
              externalLabels:
                <key>: <value> 1

        1

        使用键值对替换 <key>: <value>，其中 <key> 是新标签的唯一名称，<value> 是它的值。

        警告
        • 不要使用 prometheus 或 prometheus_replica 作为键的名称，因为它们是保留的并会被覆盖。
        • 不要使用 cluster 或 managed_cluster 作为密钥名称。使用它们可能会导致您无法在开发人员仪表板中看到数据的问题。

        例如，要将关于区域和环境的元数据添加到所有时间序列和警报中，请使用以下示例：

        apiVersion: v1
        kind: ConfigMap
        metadata:
          name: cluster-monitoring-config
          namespace: openshift-monitoring
        data:
          config.yaml: |
            prometheusK8s:
              externalLabels:
                region: eu
                environment: prod

     3. 保存文件以使改变生效。新的配置会被自动应用。

   • 对于监控用户定义的项目的 Prometheus 实例，要将自定义标签附加到离开的所有时间序列和警报：

     1. 在 openshift-user-workload-monitoring 项目中编辑 user-workload-monitoring-config ConfigMap 对象：

        $ oc -n openshift-user-workload-monitoring edit configmap user-workload-monitoring-config

     2. 在 data/config.yaml 下定义每个指标要添加的标签映射:

        apiVersion: v1
        kind: ConfigMap
        metadata:
          name: user-workload-monitoring-config
          namespace: openshift-user-workload-monitoring
        data:
          config.yaml: |
            prometheus:
              externalLabels:
                <key>: <value> 1

        1

        使用键值对替换 <key>: <value>，其中 <key> 是新标签的唯一名称，<value> 是它的值。

        警告
        • 不要使用 prometheus 或 prometheus_replica 作为键的名称，因为它们是保留的并会被覆盖。
        • 不要使用 cluster 或 managed_cluster 作为密钥名称。使用它们可能会导致您无法在开发人员仪表板中看到数据的问题。
        注意

        在 openshift-user-workload-monitoring 项目中，Prometheus 负责处理指标，而 Thanos Ruler 负责处理警报和记录规则。在 user-workload-monitoring-config ConfigMap 中为 prometheus 设置 externalLabels 只会为指标配置外部标签，而不会为任何规则配置外部标签。

        例如，要将有关地区和环境的元数据添加到与用户定义的项目相关的所有时间序列和警报中，请使用以下示例：

        apiVersion: v1
        kind: ConfigMap
        metadata:
          name: user-workload-monitoring-config
          namespace: openshift-user-workload-monitoring
        data:
          config.yaml: |
            prometheus:
              externalLabels:
                region: eu
                environment: prod

     3. 保存文件以使改变生效。受新配置影响的 Pod 会自动重新部署。