21.4. 設定による Prometheus メトリクスの有効化

手順

1. Prometheus 設定でカスタムリソースのサンプルをデプロイします。

   たとえば、Kafka リソースごとに kafka-metrics.yaml ファイルを適用できます。

   サンプル設定のデプロイ

   oc apply -f kafka-metrics.yaml

   または、kafka-metrics.yaml の設定例を独自の Kafka リソースにコピーすることもできます。

   サンプル設定のコピー

   oc edit kafka <kafka_configuration_file>

   metricsConfig プロパティーと、Kafka リソースを参照する ConfigMap をコピーします。

   Kafka のメトリクス設定例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: Kafka
   metadata:
     name: my-cluster
   spec:
     kafka:
       # ...
       metricsConfig: 1
         type: jmxPrometheusExporter
         valueFrom:
           configMapKeyRef:
             name: kafka-metrics
             key: kafka-metrics-config.yml
   ---
   kind: ConfigMap 2
   apiVersion: v1
   metadata:
     name: kafka-metrics
     labels:
       app: strimzi
   data:
     kafka-metrics-config.yml: |
     # metrics configuration...

   1

   メトリクス設定が含まれる ConfigMap を参照する metricsConfig プロパティーをコピーします。

   2

   メトリクス設定を指定する ConfigMap 全体をコピーします。

2. Kafka Exporter をデプロイするには、kafkaExporter 設定を追加します。

   KafkaExporter 設定は、Kafka リソースでのみ指定されます。

   Kafka Exporter のデプロイの設定例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: Kafka
   metadata:
     name: my-cluster
   spec:
     # ...
     kafkaExporter:
       image: my-registry.io/my-org/my-exporter-cluster:latest 1
       groupRegex: ".*" 2
       topicRegex: ".*" 3
       groupExcludeRegex: "^excluded-.*" 4
       topicExcludeRegex: "^excluded-.*" 5
       resources: 6
         requests:
           cpu: 200m
           memory: 64Mi
         limits:
           cpu: 500m
           memory: 128Mi
       logging: debug 7
       enableSaramaLogging: true 8
       template: 9
         pod:
           metadata:
             labels:
               label1: value1
           imagePullSecrets:
             - name: my-docker-credentials
           securityContext:
             runAsUser: 1000001
             fsGroup: 0
           terminationGracePeriodSeconds: 120
       readinessProbe: 10
         initialDelaySeconds: 15
         timeoutSeconds: 5
       livenessProbe: 11
         initialDelaySeconds: 15
         timeoutSeconds: 5
   # ...

   1

   高度なオプション: コンテナーイメージの設定。特別な状況でのみ推奨されます。

   2

   メトリクスに含まれるコンシューマーグループを指定する正規表現。

   3

   メトリクスに含まれるトピックを指定する正規表現。

   4

   メトリクスから除外するコンシューマーグループを指定する正規表現。

   5

   メトリクスから除外するトピックを指定する正規表現。

   6

   予約する CPU およびメモリーリソース。

   7

   指定の重大度 (debug、info、warn、error、fatal) 以上でメッセージをログに記録するためのログ設定。

   8

   Sarama ロギングを有効にするブール値 (Kafka Exporter によって使用される Go クライアントライブラリー)。

   9

   デプロイメントテンプレートおよび Pod のカスタマイズ。

   10

   ヘルスチェックの readiness プローブ。

   11

   ヘルスチェックの liveness プローブ。