3.3. コアプラットフォームモニタリングのデータの保存と記録

手順

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

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

2. 保持期間およびサイズ設定を data/config.yaml に追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusK8s:
         retention: <time_specification> 1
         retentionSize: <size_specification> 2

   1

   保持時間: ms (ミリ秒)、s (秒)、m (分)、h (時)、d (日)、w (週)、y (年) が直接続く数値。1h30m15s などの特定の時間に時間値を組み合わせることもできます。

   2

   保持サイズ: B (バイト)、KB (キロバイト)、MB (メガバイト)、GB (ギガバイト)、TB (テラバイト)、PB (ペタバイト)、および EB (エクサバイト) が直接続く数値。

   次の例では、Prometheus インスタンスの保持時間を 24 時間、保持サイズを 10 ギガバイトに設定します。

   Prometheus の保持期間を設定する例

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusK8s:
         retention: 24h
         retentionSize: 10GB

3. 変更を適用するためにファイルを保存します。新しい設定の影響を受ける Pod は自動的に再デプロイされます。

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

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

2. k8sPrometheusAdapter/audit セクションに profile: を data/config.yaml の下に追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       k8sPrometheusAdapter:
         audit:
           profile: <audit_log_level> 1

   1

   Prometheus アダプターに適用する監査ログレベル。

3. profile: パラメーターに以下のいずれかの値を使用して、監査ログレベルを設定します。

   • None: イベントをログに記録しません。
   • Metadata: ユーザー、タイムスタンプなど、リクエストのメタデータのみをログに記録します。リクエストテキストと応答テキストはログに記録しないでください。metadata はデフォルトの監査ログレベルです。
   • Request: メタデータと要求テキストのみをログに記録しますが、応答テキストはログに記録しません。このオプションは、リソース以外の要求には適用されません。
   • RequestResponse: イベントのメタデータ、要求テキスト、および応答テキストをログに記録します。このオプションは、リソース以外の要求には適用されません。
4. 変更を適用するためにファイルを保存します。新しい設定の影響を受ける Pod は自動的に再デプロイされます。

検証

1. config map の k8sPrometheusAdapter/audit/profile で、ログレベルを Request に設定し、ファイルを保存します。

2. Prometheus アダプターの Pod が実行されていることを確認します。以下の例は、openshift-monitoring プロジェクトの Pod のステータスを一覧表示します。

   $ oc -n openshift-monitoring get pods

3. 監査ログレベルと監査ログファイルのパスが正しく設定されていることを確認します。

   $ oc -n openshift-monitoring get deploy prometheus-adapter -o yaml

   出力例

   ...
     - --audit-policy-file=/etc/audit/request-profile.yaml
     - --audit-log-path=/var/log/adapter/audit.log

4. 正しいログレベルが openshift-monitoring プロジェクトの prometheus-adapter デプロイメントに適用されていることを確認します。

   $ oc -n openshift-monitoring exec deploy/prometheus-adapter -c prometheus-adapter -- cat /etc/audit/request-profile.yaml

   出力例

   "apiVersion": "audit.k8s.io/v1"
   "kind": "Policy"
   "metadata":
     "name": "Request"
   "omitStages":
   - "RequestReceived"
   "rules":
   - "level": "Request"

   注記

   ConfigMap オブジェクトで Prometheus アダプターに認識されない profile 値を入力すると、Prometheus アダプターには変更が加えられず、Cluster Monitoring Operator によってエラーがログに記録されます。

5. Prometheus アダプターの監査ログを確認します。

   $ oc -n openshift-monitoring exec -c <prometheus_adapter_pod_name> -- cat /var/log/adapter/audit.log

手順

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

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

2. コンポーネントの logLevel: <log_level> を data/config.yaml の下に追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       <component>: 1
         logLevel: <log_level> 2

   1

   ログレベルを設定するモニタリングスタックコンポーネント。使用可能なコンポーネントの値は、prometheusK8s、alertmanagerMain、prometheusOperator、および thanosQuerier です。

   2

   コンポーネントに設定するログレベル。使用可能な値は、error、warn、info、および debug です。デフォルト値は info です。

3. 変更を適用するためにファイルを保存します。新しい設定の影響を受ける Pod は自動的に再デプロイされます。

4. 関連するプロジェクトでデプロイメントまたは Pod 設定を確認し、ログレベルが適用されていることを確認します。以下の例では、prometheus-operator デプロイメントのログレベルを確認します。

   $ oc -n openshift-monitoring get deploy prometheus-operator -o yaml | grep "log-level"

   出力例

           - --log-level=debug

5. コンポーネントの Pod が実行中であることを確認します。次の例では、Pod のステータスをリスト表示します。

   $ oc -n openshift-monitoring get pods

   注記

   認識されない logLevel 値が ConfigMap オブジェクトに含まれる場合は、コンポーネントの Pod が正常に再起動しない可能性があります。

手順

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

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

2. Prometheus の queryLogFile パラメーターを data/config.yaml の下に追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusK8s:
         queryLogFile: <path> 1

   1

   クエリーが記録されるファイルへの完全なパスを追加します。

3. 変更を適用するためにファイルを保存します。新しい設定の影響を受ける Pod は自動的に再デプロイされます。

4. コンポーネントの Pod が実行中であることを確認します。次のコマンド例は、Pod のステータスを表示します。

   $ oc -n openshift-monitoring get pods

   出力例

   ...
   prometheus-operator-567c9bc75c-96wkj   2/2     Running   0          62m
   prometheus-k8s-0                       6/6     Running   1          57m
   prometheus-k8s-1                       6/6     Running   1          57m
   thanos-querier-56c76d7df4-2xkpc        6/6     Running   0          57m
   thanos-querier-56c76d7df4-j5p29        6/6     Running   0          57m
   ...

5. クエリーログを読みます。

   $ oc -n openshift-monitoring exec prometheus-k8s-0 -- cat <path>

   重要

   ログに記録されたクエリー情報を確認した後、config map の設定を元に戻します。

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

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

2. 以下の例のように thanosQuerier セクションを data/config.yaml に追加し、値を追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       thanosQuerier:
         enableRequestLogging: <value> 1
         logLevel: <value> 2

   1

   ロギングを有効にするには、値を true に設定し、ロギングを無効にするには false を設定します。デフォルト値は false です。

   2

   この値は debug、info、warn、または error に設定します。logLevel に値が存在しない場合、ログレベルはデフォルトで error に設定されます。

3. 変更を適用するためにファイルを保存します。新しい設定の影響を受ける Pod は自動的に再デプロイされます。

検証

1. Thanos Querier Pod が実行されていることを確認します。次のコマンドの例は、openshift-monitoring プロジェクトの Pod のステータスを一覧表示します。

   $ oc -n openshift-monitoring get pods

2. 以下のサンプルコマンドをモデルとして使用して、テストクエリーを実行します。

   $ token=`oc create token prometheus-k8s -n openshift-monitoring`
   $ oc -n openshift-monitoring exec -c prometheus prometheus-k8s-0 -- curl -k -H "Authorization: Bearer $token" 'https://thanos-querier.openshift-monitoring.svc:9091/api/v1/query?query=cluster_version'

3. 以下のコマンドを実行してクエリーログを読み取ります。

   $ oc -n openshift-monitoring logs <thanos_querier_pod_name> -c thanos-query

   注記

   thanos-querier Pod は高可用性 (HA) Pod であるため、1 つの Pod でのみログを表示できる可能性があります。

4. ログに記録されたクエリー情報を確認したら、config map で enableRequestLogging の値を false に変更してクエリーロギングを無効にします。