2.9. リモート書き込みストレージの設定

手順

1. openshift-monitoring プロジェクトで cluster-monitoring-config ConfigMap オブジェクトを編集します。

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

2. data/config.yaml/prometheusK8s に remoteWrite: セクションを追加します。

3. このセクションにエンドポイント URL および認証情報を追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusK8s:
         remoteWrite:
         - url: "https://remote-write.endpoint"
           <endpoint_authentication_credentials>

   endpoint_authentication_credentials の場合には、エンドポイントの認証情報を置き換えます。現時点で、サポートされている認証方法は Basic 認証 (basicAuth) およびクライアント TLS(tlsConfig) 認証です。

   • 以下の例では、Basic 認証を設定します。

     basicAuth:
       username:
         <usernameSecret>
       password:
         <passwordSecret>

     <usernameSecret> および <passwordSecret> は随時置き換えます。

     以下の例では、name に remoteWriteAuth、 key に user と password を指定した Basic 認証です。これらの値には、エンドポイント認証情報が含まれます。

     apiVersion: v1
     kind: ConfigMap
     metadata:
       name: cluster-monitoring-config
       namespace: openshift-monitoring
     data:
       config.yaml: |
         prometheusK8s:
           remoteWrite:
           - url: "https://remote-write.endpoint"
             basicAuth:
               username:
                 name: remoteWriteAuth
                 key: user
               password:
                 name: remoteWriteAuth
                 key: password

   • 以下の例では、クライアント TLS 認証を設定します。

     tlsConfig:
       ca:
         <caSecret>
       cert:
         <certSecret>
       keySecret:
         <keySecret>

     それに応じて、<caSecret>、<certSecret> および <keySecret> を置き換えます。

     以下の例では、name 値に selfsigned-mtls-bundle、ca key 値に ca.crt、cert key 値に client.crt、keySecret key 値に client.key を使用した TLS 認証設定を示します。

     apiVersion: v1
     kind: ConfigMap
     metadata:
       name: cluster-monitoring-config
       namespace: openshift-monitoring
     data:
       config.yaml: |
         prometheusK8s:
           remoteWrite:
           - url: "https://remote-write.endpoint"
             tlsConfig:
               ca:
                 secret:
                   name: selfsigned-mtls-bundle
                   key: ca.crt
               cert:
                 secret:
                   name: selfsigned-mtls-bundle
                   key: client.crt
               keySecret:
                 name: selfsigned-mtls-bundle
                 key: client.key

4. 認証クレデンシャルの後に、書き込みの再ラベル設定値を追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusK8s:
         remoteWrite:
         - url: "https://remote-write.endpoint"
           <endpoint_authentication_credentials>
           <write_relabel_configs>

   <write_relabel_configs> は、リモートエンドポイントに送信する必要のあるメトリクスの書き込みラベル一覧に置き換えます。

   以下の例では、my_metric という単一のメトリックを転送する方法を紹介します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusK8s:
         remoteWrite:
         - url: "https://remote-write.endpoint"
           writeRelabelConfigs:
           - sourceLabels: [__name__]
             regex: 'my_metric'
             action: keep

   書き込み再ラベル設定オプションについては、Prometheus relabel_config documentation を参照してください。

5. 必要な場合は、以下のように name および namespace metadata の値を変更して、ユーザー定義のプロジェクトをモニターする Prometheus インスタンスのリモート書き込みを設定します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: user-workload-monitoring-config
     namespace: openshift-user-workload-monitoring
   data:
     config.yaml: |
       prometheus:
         remoteWrite:
         - url: "https://remote-write.endpoint"
           <endpoint_authentication_credentials>
           <write_relabel_configs>

   注記

   Prometheus 設定マップコンポーネントは、 cluster-monitoring-config ConfigMap オブジェクトで prometheusK8s と呼ばれ、 user-workload-monitoring-config ConfigMap オブジェクトで prometheus と呼ばれます。

6. ファイルを保存して、変更を ConfigMap オブジェクトに適用します。新規設定の影響を受けた Pod は自動的に再起動します。

   注記

   user-workload-monitoring-config ConfigMap オブジェクトに適用される設定は、クラスター管理者がユーザー定義プロジェクトのモニタリングを有効にしない限りアクティブにされません。

   警告

   モニタリング ConfigMap オブジェクトへの変更を保存すると、関連するプロジェクトの Pod およびその他のリソースが再デプロイされる可能性があります。また、変更を保存すると、そのプロジェクトで実行中のモニタリングプロセスも再起動する可能性があります。