第14章 モニタリング関連の問題のトラブルシューティング
14.1. ユーザー定義のメトリックが利用できない理由の調査 リンクのコピーリンクがクリップボードにコピーされました!
ServiceMonitor リソースを使用すると、ユーザー定義プロジェクトでサービスによって公開されるメトリックの使用方法を判別できます。ServiceMonitor リソースを作成している場合で、メトリクス UI に対応するメトリクスが表示されない場合は、この手順で説明されるステップを実行します。
前提条件
-
cluster-adminクラスターロールを持つユーザーとしてクラスターにアクセスできる。 -
OpenShift CLI (
oc) がインストールされている。 - ユーザー定義のプロジェクトのモニタリングを有効にし、設定している。
-
ServiceMonitorリソースを作成している。
手順
ユーザーのワークロードモニタリングからプロジェクトが除外されていないことを確認してください。以下の例では、
ns1プロジェクトを使用します。プロジェクトに
openshift.io/user-monitoring=falseラベルが割り当てられて いない ことを確認します。oc get namespace ns1 --show-labels | grep 'openshift.io/user-monitoring=false'
$ oc get namespace ns1 --show-labels | grep 'openshift.io/user-monitoring=false'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記ユーザーワークロードプロジェクトに設定されたデフォルトのラベルは
openshift.io/user-monitoring=trueです。ただし、ラベルを手動で適用しない限り、このラベルは表示されません。ラベルが割り当てられている場合は、ラベルを削除します。
プロジェクトからラベルを削除する例
oc label namespace ns1 'openshift.io/user-monitoring-'
$ oc label namespace ns1 'openshift.io/user-monitoring-'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
namespace/ns1 unlabeled
namespace/ns1 unlabeledCopy to Clipboard Copied! Toggle word wrap Toggle overflow
サービスおよび
ServiceMonitorリソース設定で、対応するラベルの一致を確認 します。以下の例では、prometheus-example-appサービス、prometheus-example-monitorサービスモニター、およびns1プロジェクトを使用します。サービスに定義されたラベルを取得します。
oc -n ns1 get service prometheus-example-app -o yaml
$ oc -n ns1 get service prometheus-example-app -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
labels: app: prometheus-example-applabels: app: prometheus-example-appCopy to Clipboard Copied! Toggle word wrap Toggle overflow ServiceMonitorリソース設定のmatchLabels定義が、直前の手順のラベルの出力と一致することを確認します。oc -n ns1 get servicemonitor prometheus-example-monitor -o yaml
$ oc -n ns1 get servicemonitor prometheus-example-monitor -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
apiVersion: v1 kind: ServiceMonitor metadata: name: prometheus-example-monitor namespace: ns1 spec: endpoints: - interval: 30s port: web scheme: http selector: matchLabels: app: prometheus-example-appapiVersion: v1 kind: ServiceMonitor metadata: name: prometheus-example-monitor namespace: ns1 spec: endpoints: - interval: 30s port: web scheme: http selector: matchLabels: app: prometheus-example-appCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注記プロジェクトの表示権限を持つ開発者として、サービスおよび
ServiceMonitorリソースラベルを確認できます。
openshift-user-workload-monitoringプロジェクトの Prometheus Operator のログを検査します。openshift-user-workload-monitoringプロジェクトの Pod をリスト表示します。oc -n openshift-user-workload-monitoring get pods
$ oc -n openshift-user-workload-monitoring get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
NAME READY STATUS RESTARTS AGE prometheus-operator-776fcbbd56-2nbfm 2/2 Running 0 132m prometheus-user-workload-0 5/5 Running 1 132m prometheus-user-workload-1 5/5 Running 1 132m thanos-ruler-user-workload-0 3/3 Running 0 132m thanos-ruler-user-workload-1 3/3 Running 0 132m
NAME READY STATUS RESTARTS AGE prometheus-operator-776fcbbd56-2nbfm 2/2 Running 0 132m prometheus-user-workload-0 5/5 Running 1 132m prometheus-user-workload-1 5/5 Running 1 132m thanos-ruler-user-workload-0 3/3 Running 0 132m thanos-ruler-user-workload-1 3/3 Running 0 132mCopy to Clipboard Copied! Toggle word wrap Toggle overflow prometheus-operatorPod のprometheus-operatorコンテナーからログを取得します。以下の例では、Pod はprometheus-operator-776fcbbd56-2nbfmになります。oc -n openshift-user-workload-monitoring logs prometheus-operator-776fcbbd56-2nbfm -c prometheus-operator
$ oc -n openshift-user-workload-monitoring logs prometheus-operator-776fcbbd56-2nbfm -c prometheus-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow サービスモニターに問題がある場合、ログには以下のようなエラーが含まれる可能性があります。
level=warn ts=2020-08-10T11:48:20.906739623Z caller=operator.go:1829 component=prometheusoperator msg="skipping servicemonitor" error="it accesses file system via bearer token file which Prometheus specification prohibits" servicemonitor=eagle/eagle namespace=openshift-user-workload-monitoring prometheus=user-workload
level=warn ts=2020-08-10T11:48:20.906739623Z caller=operator.go:1829 component=prometheusoperator msg="skipping servicemonitor" error="it accesses file system via bearer token file which Prometheus specification prohibits" servicemonitor=eagle/eagle namespace=openshift-user-workload-monitoring prometheus=user-workloadCopy to Clipboard Copied! Toggle word wrap Toggle overflow
OpenShift Container Platform Web コンソール UI の Metrics targets ページで、エンドポイントのターゲットステータスを確認 します。
-
OpenShift Container Platform の Web コンソールにログインし、管理者 パースペクティブの Observe
Targets に移動します。 - リストでメトリクスのエンドポイントを探し、Status 列でターゲットのステータスを確認します。
- Status が Down の場合、エンドポイントの URL をクリックすると、そのメトリクスターゲットの Target Details ページで詳細情報を見ることができます。
-
OpenShift Container Platform の Web コンソールにログインし、管理者 パースペクティブの Observe
openshift-user-workload-monitoringプロジェクトで Prometheus Operator のデバッグレベルのロギングを設定 します。openshift-user-workload-monitoringプロジェクトでuser-workload-monitoring-configConfigMapオブジェクトを編集します。oc -n openshift-user-workload-monitoring edit configmap user-workload-monitoring-config
$ oc -n openshift-user-workload-monitoring edit configmap user-workload-monitoring-configCopy to Clipboard Copied! Toggle word wrap Toggle overflow prometheusOperatorのlogLevel: debugをdata/config.yamlに追加し、ログレベルをdebugに設定します。apiVersion: v1 kind: ConfigMap metadata: name: user-workload-monitoring-config namespace: openshift-user-workload-monitoring data: config.yaml: | prometheusOperator: logLevel: debug # ...apiVersion: v1 kind: ConfigMap metadata: name: user-workload-monitoring-config namespace: openshift-user-workload-monitoring data: config.yaml: | prometheusOperator: logLevel: debug # ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
変更を適用するためにファイルを保存します。影響を受ける
prometheus-operatorPod は自動的に再デプロイされます。 debugログレベルがopenshift-user-workload-monitoringプロジェクトのprometheus-operatorデプロイメントに適用されていることを確認します。oc -n openshift-user-workload-monitoring get deploy prometheus-operator -o yaml | grep "log-level"
$ oc -n openshift-user-workload-monitoring get deploy prometheus-operator -o yaml | grep "log-level"Copy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
- --log-level=debug
- --log-level=debugCopy to Clipboard Copied! Toggle word wrap Toggle overflow debug レベルのロギングにより、Prometheus Operator によって行われるすべての呼び出しが表示されます。
prometheus-operatorPod が実行されていることを確認します。oc -n openshift-user-workload-monitoring get pods
$ oc -n openshift-user-workload-monitoring get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注記認識されない Prometheus Operator の
loglevel値が config map に含まれる場合、prometheus-operatorPod が正常に再起動されない可能性があります。-
デバッグログを確認し、Prometheus Operator が
ServiceMonitorリソースを使用しているかどうかを確認します。ログで他の関連するエラーの有無を確認します。