Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

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

当 AMQ Streams 部署到 OpenShift Container Platform 时，通过 监控用户定义的项目提供指标数据。此 OpenShift 功能允许开发人员访问单独的 Prometheus 实例来监控其自己的项目（如 Kafka 项目）。

如果启用了对用户定义的项目的监控，openshift-user-workload-monitoring 项目包含以下组件：

  • Prometheus Operator
  • Prometheus 实例（由 Prometheus Operator 自动部署）
  • Thanos Ruler 实例

AMQ Streams 使用这些组件来消耗指标。

集群管理员必须为用户定义的项目启用监控，然后授予开发人员和其他用户权限来监控其自己的项目中的应用程序。

Grafana 部署

您可以将 Grafana 实例部署到包含 Kafka 集群的项目中。然后，可以使用 Grafana 仪表板示例来视觉化 Grafana 用户界面中 AMQ Streams 的 Prometheus 指标。

重要

openshift-monitoring 项目为核心平台组件提供监控。不要在 OpenShift Container Platform 4.x 上使用 Prometheus 和 Grafana 组件来为 AMQ Streams 配置监控。

流程概述

要在 OpenShift Container Platform 中设置 AMQ Streams 监控，请按照以下步骤执行：

  1. 先决条件： 部署 Prometheus 指标配置
  2. 部署 Prometheus 资源
  3. 为 Grafana 创建服务帐户
  4. 使用 Prometheus 数据源部署 Grafana
  5. 创建到 Grafana Service 的路由
  6. 导入 Grafana 仪表板示例

8.5.1. 先决条件
复制链接

  • 已使用示例 YAML 文件 部署了 Prometheus 指标配置。
  • 启用了 对用户定义的项目的监控。集群管理员已在 OpenShift 集群中创建了 cluster-monitoring-config 配置映射。
  • 集群管理员已为您分配了 monitoring-rules-edit 或 monitoring-edit 角色。

有关创建 cluster-monitoring-config 配置映射并授予用户监控用户定义的项目的权限的更多信息，请参阅 OpenShift Container Platform Monitoring。

8.5.3. 部署 Prometheus 资源
复制链接

使用 Prometheus 获取 Kafka 集群中的监控数据。

您可以使用自己的 Prometheus 部署，或使用 AMQ Streams 提供的示例指标配置文件 部署 Prometheus。要使用示例文件，您需要配置和部署 PodMonitor 资源。PodMonitor 直接从 Apache Kafka、ZooKeeper、Operator、Kafka Bridge 和 Cruise Control 的 pod 中提取数据。

然后，您要为 Alertmanager 部署示例警报规则。

先决条件

流程

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

    oc get pods -n openshift-user-workload-monitoring
    Copy to Clipboard Toggle word wrap

    如果启用，则返回监控组件的 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
    Copy to Clipboard Toggle word wrap

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

  2. 在 example /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
# ...
    Copy to Clipboard Toggle word wrap
    1
    要从中提取指标的 Pod 的项目，如 Kafka。

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

    oc apply -f strimzi-pod-monitor.yaml -n MY-PROJECT
    Copy to Clipboard Toggle word wrap

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

    oc apply -f prometheus-rules.yaml -n MY-PROJECT
    Copy to Clipboard Toggle word wrap

8.5.4. 为 Grafana 创建服务帐户
复制链接

AMQ Streams 的 Grafana 实例需要使用为 cluster-monitoring-view 角色的服务帐户运行。

如果您使用 Grafana 呈现用于监控指标，请创建一个服务帐户。

先决条件

流程

  1. 为 Grafana 创建 ServiceAccount。此处的资源名为 grafana-serviceaccount。 

    apiVersion: v1
kind: ServiceAccount
metadata:
  name: grafana-serviceaccount
  labels:
    app: strimzi
    Copy to Clipboard Toggle word wrap

  2. 将 ServiceAccount 部署到包含 Kafka 集群的项目： 

    oc apply -f GRAFANA-SERVICEACCOUNT -n MY-PROJECT
    Copy to Clipboard Toggle word wrap

  3. 创建一个 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-serviceaccount
    namespace: <my-project>
    1 
    
roleRef:
  kind: ClusterRole
  name: cluster-monitoring-view
  apiGroup: rbac.authorization.k8s.io
    Copy to Clipboard Toggle word wrap
    1
    项目的名称。

  4. 将 ClusterRoleBinding 部署到包含 Kafka 集群的项目： 

    oc apply -f <grafana-cluster-monitoring-binding> -n <my-project>
    Copy to Clipboard Toggle word wrap

8.5.5. 使用 Prometheus 数据源部署 Grafana
复制链接

将 Grafana 部署到 present Prometheus 指标。Grafana 应用程序需要配置 OpenShift Container Platform 监控堆栈。

OpenShift Container Platform 在 openshift-monitoring 项目中包含一个 Thanos Querier 实例。Thanos Querier 用于聚合平台指标。

要使用所需的平台指标，您的 Grafana 实例需要一个可连接到 Thanos Querier 的 Prometheus 数据源。要配置这个连接，您可以创建一个配置映射来进行身份验证，使用令牌到与 Thanos Querier 一起运行的 oauth-proxy sidecar。datasource.yaml 文件被用作配置映射的来源。

最后，您要使用挂载为卷的配置映射部署 Grafana 应用程序到包含 Kafka 集群的项目。

先决条件

流程

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

    oc serviceaccounts get-token grafana-serviceaccount -n MY-PROJECT
    Copy to Clipboard Toggle word wrap

    复制访问令牌以在下一步中使用。

  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
    Copy to Clipboard Toggle word wrap
    1
    GRAFANA-ACCESS-TOKEN ：Grafana ServiceAccount 的访问令牌值。

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

    oc create configmap grafana-config --from-file=datasource.yaml -n MY-PROJECT
    Copy to Clipboard Toggle word wrap

  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-serviceaccount
      containers:
      - name: grafana
        image: grafana/grafana:7.5.15
        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
    Copy to Clipboard Toggle word wrap

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

    oc apply -f <grafana-application> -n <my-project>
    Copy to Clipboard Toggle word wrap

8.5.6. 创建到 Grafana 服务的路由
复制链接

您可以通过公开 Grafana 服务的路由访问 Grafana 用户界面。

先决条件

流程

  • 创建到 grafana 服务的边缘路由： 

    oc create route edge <my-grafana-route> --service=grafana --namespace=KAFKA-NAMESPACE
    Copy to Clipboard Toggle word wrap

8.5.7. 导入 Grafana 仪表板示例
复制链接

使用 Grafana 在可自定义仪表板上提供 Prometheus 指标的视觉化。

AMQ Streams 以 JSON 格式为 Grafana 提供示例仪表板配置文件。

  • examples/metrics/grafana-dashboards

此流程使用 Grafana 仪表板示例。

示例仪表板是监控密钥指标的良好起点，但它们不会显示 Kafka 支持的所有指标。您可以修改示例仪表板，或根据您的基础架构添加其他指标。

先决条件

流程

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

    oc get routes

NAME               HOST/PORT                         PATH  SERVICES
MY-GRAFANA-ROUTE   MY-GRAFANA-ROUTE-amq-streams.net        grafana
    Copy to Clipboard Toggle word wrap
  2. 在 Web 浏览器中，使用 Route 主机和端口的 URL 访问 Grafana 登录屏幕。

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

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

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

从 Dashboards 主页中查看导入的 Grafana 仪表板。

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2026 Red Hat