モニタリング

手順

1. cluster-monitoring-config ConfigMap オブジェクトが存在するかどうかを確認します。

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

2. ConfigMap オブジェクトが存在しない場合:

   1. 以下の YAML マニフェストを作成します。以下の例では、このファイルは cluster-monitoring-config.yaml という名前です。

      apiVersion: v1
      kind: ConfigMap
      metadata:
        name: cluster-monitoring-config
        namespace: openshift-monitoring
      data:
        config.yaml: |

   2. 設定を適用して ConfigMap を作成します。

      $ oc apply -f cluster-monitoring-config.yaml

手順

1. cluster-monitoring-config ConfigMap オブジェクトの編集を開始します。

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

2. 設定を、data/config.yaml の下に値とキーのペア <component_name>: <component_configuration> として配置します。

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

   <component> および <configuration_for_the_component> を随時置き換えます。

   たとえば、Prometheus の永続ボリューム要求 (PVC) を設定するために、この ConfigMap オブジェクトを作成します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusK8s:
         volumeClaimTemplate: spec: storageClassName: fast volumeMode: Filesystem resources: requests: storage: 40Gi

   ここで、prometheusK8s は Prometheus コンポーネントを定義し、続く行ではその設定を定義します。

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

手順

1. cluster-monitoring-config ConfigMap オブジェクトの編集を開始します。

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

2. コンポーネントの nodeSelector 制約を data/config.yaml に指定します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       <component>:
         nodeSelector:
           <node_key>: <node_value>
           <node_key>: <node_value>
           <...>

   <component> を適宜置き換え、<node_key>: <node_value> を、宛先ノードを指定するキーと値のペアのマップに置き換えます。通常は、単一のキーと値のペアのみが使用されます。

   コンポーネントは、指定されたキーと値のペアのそれぞれをラベルとして持つノードでのみ実行できます。ノードには追加のラベルを持たせることもできます。

   たとえば、コンポーネントを foo: bar というラベルが付けられたノードに移動するには、以下を使用します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusOperator: nodeSelector: foo: bar prometheusK8s: nodeSelector: foo: bar alertmanagerMain: nodeSelector: foo: bar kubeStateMetrics: nodeSelector: foo: bar grafana: nodeSelector: foo: bar telemeterClient: nodeSelector: foo: bar k8sPrometheusAdapter: nodeSelector: foo: bar
       openshiftStateMetrics:
         nodeSelector:
           foo: bar
       thanosQuerier:
         nodeSelector:
           foo: bar

3. 変更を適用するためにファイルを保存します。新しい設定の影響を受けるコンポーネントは新しいノードに自動的に移動します。

手順

1. cluster-monitoring-config ConfigMap オブジェクトの編集を開始します。

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

2. コンポーネントの tolerations を指定します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       <component>:
         tolerations:
           <toleration_specification>

   <component> および <toleration_specification> を随時置き換えます。

   たとえば、oc adm taint nodes node1 key1=value1:NoSchedule のテイントにより、スケジューラーが foo: bar ノードに Pod を配置するのを防ぎます。alertmanagerMain コンポーネントを、そのテイントを無視して、foo: bar に alertmanagerMain を配置するには、通常以下の容認を使用します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       alertmanagerMain:
         nodeSelector:
           foo: bar
         tolerations: - key: "key1" operator: "Equal" value: "value1" effect: "NoSchedule"

3. 変更を適用するためにファイルを保存します。新しいコンポーネントの配置設定が自動的に適用されます。

手順

1. cluster-monitoring-config ConfigMap の編集を開始します。

   $ 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:
         externalLabels:
           <key>: <value> 1

   1

   <key>: <value> をキーと値のペアのマップに置き換えます。ここで、<key> は新規ラベルの一意の名前で、<value> はその値になります。

   警告

   prometheus または prometheus_replica は予約され、上書きされるため、これらをキー名として使用しないでください。

   たとえば、リージョンおよび環境に関するメタデータをすべての時系列およびアラートに追加するには、以下を使用します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       prometheusK8s:
         externalLabels:
           region: eu
           environment: prod

3. 変更を適用するためにファイルを保存します。新しい設定は自動的に適用されます。

1. 名前によるアラートのフィルター。
2. 状態によるアラートのフィルター。アラートを実行するには、一部のアラートにおいて、タイムアウトの間に特定の条件が true である必要があります。アラートの条件が現時点で true であるが、タイムアウトに達していない場合、このアラートは Pending 状態になります。
3. アラート名。
4. アラートの説明。
5. アラートの重大度レベルの値。
6. アラートの現在の状態と、アラートがこの状態に切り替わった時。
7. アラートに関して実行できるアクション。

1. アラートのサイレンスの作成。
2. 名前によるサイレンスのフィルター。
3. 状態によるサイレンスのフィルター。サイレンスが保留中の場合、これは後で開始するようにスケジュールされているため、アクティブな状態ではありません。また、サイレンスの期間が過ぎると、終了時間に達したためにアクティブでなくなります。
4. サイレンスの説明。これには、サイレンス名および一致するアラートの仕様が含まれます。
5. サイレンス機能によってサイレンスにされているアラート数。
6. サイレンスの現在の状態。サイレンスがアクティブな場合は、サイレンスが終了するタイミングを示します。保留中のサイレンスについては、サイレンスが開始するタイミングを示します。
7. サイレンスを作成したユーザー。
8. サイレンスに関して実行できるアクション。

1. 名前によるアラートルールのフィルター。
2. 状態によるアラートルールのフィルター。
3. アラートルール名。
4. アラートルールの重大度レベルの値。
5. アラートルールで定義されるアラートの状態。

手順

1. OpenShift Container Platform Web コンソールを開き、Monitoring → Alerting → Alerts ページに移動します。
2. オプション: Filter Alerts by nameフィールドを使用して、名前でアラートをフィルター します。
3. オプション: 1 つ以上の状態ボタン Firing、Silenced、Pending を使用して、状態でアラートをフィルターします。
4. オプション: 1 つ以上の Name、Severity、および State 列ヘッダーをクリックして、アラートを並べ替えます。

5. 必要とするアラートの表示後に、アラートまたはアラートを規定するアラートルールの詳細のいずれかを表示できます。

   アラートの詳細を表示するには、アラートの名前をクリックします。開かれるページには、アラートの時系列を示すグラフがあります。また、以下をはじめとするアラートについての情報も含まれます。

   • アラートを規定するアラートルールへのリンク
   • アラートの説明。
   • アラートに割り当てられるラベル

   アラートルールの詳細を表示するには、最後の列のボタンをクリックし、View Alerting Rule を選択します。開かれるページには、以下をはじめとするアラートルールについての情報が含まれます。

   • アラートルール名、重大度、および説明
   • アラートを発生させるための条件を定義する式
   • アラートを発生させるための条件が true である期間
   • アラートルールに規定される各アラートのグラフ。 アラートを発生させる際に使用する値が表示されます。
   • アラートルールで規定されるすべてのアラートについての表

1. OpenShift Container Platform Web コンソールの Monitoring → Alerting → Silences ページに移動します。
2. Create Silence をクリックします。
3. Create Silence フォームにデータを設定します。
4. サイレンスを作成するには、Silence をクリックします。

1. OpenShift Container Platform Web コンソールの Monitoring → Alerting → Alerts ページに移動します。
2. サイレンスにする必要のあるアラートについて、最後の列のボタンをクリックし、Silence Alert をクリックします。Create Silence フォームが、選択したアラートの事前にデータが設定された仕様と共に表示されます。
3. オプション: サイレンスを変更します。
4. サイレンスを作成するには、Silence をクリックします。

手順

1. OpenShift Container Platform Web コンソールを開き、Monitoring → Alerting → Silences ページに移動します。
2. オプション: Filter Silences by name フィールドを使用して、名前でサイレンスをフィルターします。
3. オプション: 1 つ以上の状態ボタン Active、Pending、Expired を使用して、状態でサイレンスをフィルターします。
4. オプション: 1 つ以上の Name、Firing Alerts、State、および Creator 列ヘッダーをクリックしてサイレンスを並べ替えます。

5. サイレンスの表示後、その名前をクリックして、以下をはじめとする詳細情報を確認します。

   • アラート仕様
   • 状態
   • 開始時間
   • 終了時間
   • 発生するアラートの数および一覧

手順

1. Monitoring → Alerting → Silences ページに移動します。

2. 変更するサイレンスについて、最後の列のボタンをクリックし、Edit silence をクリックします。

   または、特定のサイレンスについて、 Silence Overview 画面で Actions → Edit Silence をクリックできます。

3. Edit Silence 画面では、変更を入力し、Save ボタンをクリックします。これにより、既存のサイレンスが期限切れとなり、選択された設定でサイレンスが作成されます。

手順

1. Monitoring → Alerting → Silences ページに移動します。

2. 期限切れにするサイレンスについては、最後の列のボタンをクリックし、Expire Silence をクリックします。

   または、特定のサイレンスについて、Silence Overview ページで Actions → Expire Silence ボタンをクリックできます。

3. Expire Silence をクリックして確定します。これにより、サイレンスが期限切れになります。

1. Web コンソールの Administration → Cluster Settings → Global Configuration → Alertmanager → YAML ページに移動します。
2. YAML 設定ファイルを変更します。
3. Save をクリックします。

1. アクション。

   • クエリーを追加します。
   • すべてのクエリーテーブルを展開するか、または折りたたみます。
   • すべてのクエリーを削除します。
2. プロットを非表示にします。
3. 対話式のプロット。
4. 利用可能なメトリクスのカタログ。
5. クエリーを追加します。
6. クエリーを実行します。
7. クエリーフォーム。
8. フォームを展開または折りたたみます。
9. クエリー。
10. クエリーをクリアします。
11. クエリーを有効または無効にします。

12. 特定のクエリーのアクション。

    • クエリーを有効または無効にします。
    • プロットからすべてのクエリーのシリーズを表示または非表示にします。
    • クエリーを削除します。
13. クエリーのメトリクステーブル。
14. メトリクスのグラフに割り当てられた色。四角をクリックして、メトリクスのグラフを表示するか、非表示にします。

手順

1. OpenShift Container Platform Web コンソールを開き、Monitoring → Metrics ページに移動します。

2. クエリーフィールドに PromQL クエリーを入力します。

   • 利用可能なすべてのメトリクスおよび PromQL 機能を表示するには、Insert Metric at Cursor をクリックします。
3. 複数のクエリーについて、Add Query をクリックします。
4. クエリーを削除するには、クエリーの をクリックしてから Delete query を選択します。
5. クエリーを実行せずに維持するには、Disable query ボタンをクリックします。

6. クエリーの作成が完了したら、Run Queries ボタンをクリックします。クエリーからのメトリクスはプロットで可視化されます。クエリーが無効な場合、UI にはエラーメッセージが表示されます。

   注記

   大量のデータで動作するクエリーは、時系列グラフの描画時にタイムアウトするか、またはブラウザーをオーバーロードする可能性があります。これを回避するには、グラフを非表示にし、メトリクステーブルのみを使用してクエリーを調整する必要があります。次に、使用できるクエリーを確認した後に、グラフを描画できるようにプロットを有効にします。

7. オプション: ページ URL には、実行したクエリーが含まれます。このクエリーのセットを再度使用できるようにするには、この URL を保存します。

手順

1. 最初に、有効なすべてのクエリーからのすべてのメトリクスがプロットに表示されます。表示されるメトリクスを選択できます。

   • クエリーからすべてのメトリクスを非表示にするには、クエリーの をクリックし、Hide all series をクリックします。
   • 特定のメトリクスを非表示にするには、クエリーテーブルに移動し、メトリクス名の横にある色の付いた四角をクリックします。

2. プロットをズームアップし、表示される時間範囲を変更するには、以下のいずれかを行います。

   • プロットを水平にクリックし、ドラッグして、時間範囲を視覚的に選択します。
   • 左上隅のメニューを使用して、時間範囲を選択します。

   時間の範囲をリセットするには、Reset Zoom をクリックします。

3. 特定の時点のすべてのクエリーの出力を表示するには、その時点のプロットにてマウスのカーソルを保持します。クエリーの出力はポップアップに表示されます。
4. 特定クエリーのメトリクスの詳細については、ドロップダウンボタンを使用してクエリーの表を展開します。すべてのメトリクスは現在の値で表示されます。
5. プロットを非表示にするには、Hide Graph をクリックします。

手順

1. OpenShift Container Platform Web コンソールに移動し、認証します。

2. Prometheus にアクセスするには、"Monitoring" → "Metrics" ページに移動します。

   Alerting UI にアクセスするには、"Monitoring" → "Alerting" ページに移動します。

   Grafana にアクセスするには、"Monitoring" → "Dashboards" ページに移動します。

手順

1. 以下を実行します。

   $ oc -n openshift-monitoring get routes

   出力例

   NAME                HOST/PORT                                                     ...
   alertmanager-main   alertmanager-main-openshift-monitoring.apps._url_.openshift.com ...
   grafana             grafana-openshift-monitoring.apps._url_.openshift.com           ...
   prometheus-k8s      prometheus-k8s-openshift-monitoring.apps._url_.openshift.com    ...

2. https:// をアドレスに追加します。 暗号化されていない接続を使用して Web UI にアクセスすることはできません。

   たとえば、以下は Alertmanager の生成される URL です。

   https://alertmanager-main-openshift-monitoring.apps._url_.openshift.com

3. web ブラウザーを使用してアドレスに移動し、認証します。