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 が返されなければ、ユーザー定義プロジェクトのモニタリングは無効になっています。「OpenShift での Kafka メトリクスおよびダッシュボードの表示」 の前提条件を参照してください。

2. 複数の PodMonitor リソースは、examples/metrics/prometheus-install/strimzi-pod-monitor.yaml で定義されます。

   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

   この例では、grafana-service-account という名前のサービスアカウントが my-project namespace に作成されます。

2. cluster-monitoring-view ロールを Grafana ServiceAccount に割り当てる ClusterRoleBinding リソースを作成します。ここでは、リソースの名前は 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. サービスアカウントのトークンシークレットを作成します。

   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

   サービスアカウントトークンシークレットを指定します。

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 という名前の config map を作成します。

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

4. Deployment および Service で設定される Grafana アプリケーションを作成します。

   grafana-config config map はデータソース設定のボリュームとしてマウントされます。

   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 データソースが作成済みであることを確認します。データソースは 「Prometheus データソースを使用した Grafana のデプロイ」 に作成されています。
5. + アイコンをクリックしてから、Import をクリックします。
6. examples/metrics/grafana-dashboards で、インポートするダッシュボードの JSON をコピーします。
7. JSON をテキストボックスに貼り付け、Load をクリックします。
8. 他の Grafana ダッシュボードのサンプル用に、ステップ 5-7 を繰り返します。