21.5. 在 OpenShift 中查看 Kafka 指标和仪表板

流程

1. 检查是否启用了监控用户定义的项目：

   oc get pods -n openshift-user-workload-monitoring

   如果启用，则返回监控组件的 pod。例如：

   NAME                                   READY   STATUS    RESTARTS   AGE
   prometheus-operator-5cc59f9bc6-kgcq8   1/1     Running   0          25s
   prometheus-user-workload-0             5/5     Running   1          14s
   prometheus-user-workload-1             5/5     Running   1          14s
   thanos-ruler-user-workload-0           3/3     Running   0          14s
   thanos-ruler-user-workload-1           3/3     Running   0          14s

   如果没有返回 pod，则禁用对用户定义的项目的监控。请参阅 第 21.5 节 “在 OpenShift 中查看 Kafka 指标和仪表板” 中的先决条件。

2. 在 examples/metrics/prometheus-install/strimzi-pod-monitor.yaml 中定义多个 PodMonitor 资源。

   对于每个 PodMonitor 资源，编辑 spec.namespaceSelector.matchNames 属性：

   apiVersion: monitoring.coreos.com/v1
   kind: PodMonitor
   metadata:
     name: cluster-operator-metrics
     labels:
       app: strimzi
   spec:
     selector:
       matchLabels:
         strimzi.io/kind: cluster-operator
     namespaceSelector:
       matchNames:
         - <project-name> 1
     podMetricsEndpoints:
     - path: /metrics
       port: http
   # ...

   1

   从其中提取指标的 pod 正在运行的项目，如 Kafka。

3. 将 strimzi-pod-monitor.yaml 文件部署到运行 Kafka 集群的项目中：

   oc apply -f strimzi-pod-monitor.yaml -n MY-PROJECT

4. 将示例 Prometheus 规则部署到同一项目中：

   oc apply -f prometheus-rules.yaml -n MY-PROJECT

流程

1. 在包含 Kafka 集群的项目中为 Grafana 创建 ServiceAccount ：

    oc create sa grafana-service-account -n my-project

   在本例中，在 my-project 命名空间中创建一个名为 grafana-service-account 的服务帐户。

2. 创建一个 ClusterRoleBinding 资源，将 cluster-monitoring-view 角色分配给 Grafana ServiceAccount。此处的资源名为 grafana-cluster-monitoring-binding。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: grafana-cluster-monitoring-binding
     labels:
       app: strimzi
   subjects:
     - kind: ServiceAccount
       name: grafana-service-account
       namespace: my-project
   roleRef:
     kind: ClusterRole
     name: cluster-monitoring-view
     apiGroup: rbac.authorization.k8s.io

3. 将 ClusterRoleBinding 部署到同一项目中：

   oc apply -f grafana-cluster-monitoring-binding.yaml -n my-project

4. 为服务帐户创建令牌 secret：

   apiVersion: v1
   kind: Secret
   metadata:
     name: secret-sa
     annotations:
       kubernetes.io/service-account.name: "grafana-service-account" 1
   type: kubernetes.io/service-account-token 2

   1

   指定服务帐户。

   2

   指定服务帐户令牌 secret。

5. 创建 Secret 对象和访问令牌：

   oc create -f <secret_configuration>.yaml

   部署 Grafana 时需要访问令牌。

流程

1. 获取 Grafana ServiceAccount 的访问令牌：

   oc describe sa/grafana-service-account | grep Tokens:
   oc describe secret grafana-service-account-token-mmlp9 | grep token:

   在本例中，服务帐户名为 grafana-service-account。复制要在下一步中使用的访问令牌。

2. 创建包含 Grafana 的 Thanos Querier 配置的 datasource.yaml 文件。

   将访问令牌粘贴到 httpHeaderValue1 属性中，如下所示。

   apiVersion: 1
   
   datasources:
   - name: Prometheus
     type: prometheus
     url: https://thanos-querier.openshift-monitoring.svc.cluster.local:9091
     access: proxy
     basicAuth: false
     withCredentials: false
     isDefault: true
     jsonData:
       timeInterval: 5s
       tlsSkipVerify: true
       httpHeaderName1: "Authorization"
     secureJsonData:
       httpHeaderValue1: "Bearer ${GRAFANA-ACCESS-TOKEN}" 1
     editable: true

   1

   GRAFANA-ACCESS-TOKEN ：Grafana ServiceAccount 的访问令牌值。

3. 从 datasource.yaml 文件创建一个名为 grafana-config 的配置映射：

   oc create configmap grafana-config --from-file=datasource.yaml -n MY-PROJECT

4. 创建由 Deployment 和 Service 组成的 Grafana 应用程序。

   grafana-config 配置映射作为数据源配置的卷挂载。

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: grafana
     labels:
       app: strimzi
   spec:
     replicas: 1
     selector:
       matchLabels:
         name: grafana
     template:
       metadata:
         labels:
           name: grafana
       spec:
         serviceAccountName: grafana-service-account
         containers:
         - name: grafana
           image: grafana/grafana:10.4.2
           ports:
           - name: grafana
             containerPort: 3000
             protocol: TCP
           volumeMounts:
           - name: grafana-data
             mountPath: /var/lib/grafana
           - name: grafana-logs
             mountPath: /var/log/grafana
           - name: grafana-config
             mountPath: /etc/grafana/provisioning/datasources/datasource.yaml
             readOnly: true
             subPath: datasource.yaml
           readinessProbe:
             httpGet:
               path: /api/health
               port: 3000
             initialDelaySeconds: 5
             periodSeconds: 10
           livenessProbe:
             httpGet:
               path: /api/health
               port: 3000
             initialDelaySeconds: 15
             periodSeconds: 20
         volumes:
         - name: grafana-data
           emptyDir: {}
         - name: grafana-logs
           emptyDir: {}
         - name: grafana-config
           configMap:
             name: grafana-config
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: grafana
     labels:
       app: strimzi
   spec:
     ports:
     - name: grafana
       port: 3000
       targetPort: 3000
       protocol: TCP
     selector:
       name: grafana
     type: ClusterIP

5. 将 Grafana 应用程序部署到包含 Kafka 集群的项目中：

   oc apply -f <grafana-application> -n <my-project>

流程

1. 获取到 Grafana 服务的路由详情。例如：

   oc get routes
   
   NAME               HOST/PORT                         PATH  SERVICES
   MY-GRAFANA-ROUTE   MY-GRAFANA-ROUTE-amq-streams.net        grafana

2. 在 Web 浏览器中，使用 Route 主机和端口的 URL 访问 Grafana 登录屏幕。

3. 输入您的用户名和密码，然后单击 Log In。

   默认的 Grafana 用户名和密码都是 admin。第一次登录后，您可以更改密码。

4. 在 Configuration > Data Sources 中，检查是否创建了 Prometheus 数据源。数据源是在 第 21.5.4 节 “使用 Prometheus 数据源部署 Grafana” 中创建的。
5. 单击 + 图标，然后单击 Import。
6. 在 examples/metrics/grafana-dashboards 中，复制要导入的仪表板的 JSON。
7. 将 JSON 粘贴到文本框中，然后点 Load。
8. 为其他 Grafana 仪表板重复步骤 5-7。