Prometheus サイドカーを使用して Prometheus 指標を書き込む

デフォルト構成

デフォルトの RunMonitoring 構成を使用する

カスタム RunMonitoring 構成を作成しない場合、サイドカー コレクタは次のデフォルト構成を合成して、/metrics 指標パスのポート 8080 から 30 秒ごとに指標をスクレイピングします。

apiVersion: monitoring.googleapis.com/v1beta
kind: RunMonitoring
metadata:
  name: run-gmp-sidecar
spec:
  endpoints:
  - port: 8080
    path: /metrics
    interval: 30s

デフォルト構成を使用する場合、Cloud Run サービスにサイドカーを追加する以外の追加設定は必要ありません。

Cloud Run サービスにサイドカーを追加する

デフォルトの RunMonitoring 構成でサイドカーを使用するには、既存の Cloud Run 構成を変更してサイドカーを追加する必要があります。サイドカーを追加するには、次の操作を行います。

• コンテナの起動とシャットダウンの順序を指定するコンテナ依存関係アノテーションを追加します。次の例では、collector という名前のサイドカー コンテナが、app という名前のアプリケーション コンテナの後に起動し、その後シャットダウンします。
• コレクタのコンテナを作成します。次の例では collector という名前にしています。

たとえば、+（プラス）記号で始まる行を Cloud Run 構成に追加して、サービスを再デプロイします。

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  annotations:
    run.googleapis.com/launch-stage: ALPHA
    run.googleapis.com/cpu-throttling: 'false'
  name: my-cloud-run-service
spec:
  template:
    metadata:
      annotations:
        run.googleapis.com/execution-environment: gen2
+       run.googleapis.com/container-dependencies: '{"collector":["app"]}'
    spec:
      containers:
      - image: "REGION-docker.pkg.dev/PROJECT_ID/run-gmp/sample-app"
        name: app
        startupProbe:
          httpGet:
            path: /startup
            port: 8000
        livenessProbe:
          httpGet:
            path: /liveness
            port: 8000
        ports:
        - containerPort: 8000
+     - image: "us-docker.pkg.dev/cloud-ops-agents-artifacts/cloud-run-gmp-sidecar/cloud-run-gmp-sidecar:1.1.1"
+       name: collector

構成ファイル run-service.yaml を使用して Cloud Run サービスを再デプロイするには、次のコマンドを実行します。

gcloud run services replace run-service.yaml --region=REGION

カスタム構成

カスタム RunMonitoring 構成を作成する

デフォルトの構成では不十分な場合は、Cloud Run サービスの RunMonitoring 構成を作成できます。たとえば、次のような構成を作成できます。

apiVersion: monitoring.googleapis.com/v1beta
kind: RunMonitoring
metadata:
  name: my-custom-cloud-run-job
spec:
  endpoints:
  - port: 8080
    path: /metrics
    interval: 10s
    metricRelabeling:
    - action: replace
      sourceLabels:
      - __address__
      targetLabel: label_key
      replacement: label_value
  targetLabels:
    metadata:
    - service
    - revision

この構成では、次の処理が行われます。

• ポート 8080 から指標を取得し、デフォルトの指標パス /metrics を使用します。
• 10 秒のスクレイピング間隔を使用します。
• ラベルの付け直しを行い、スクレイピングされたすべての指標に、値が label_value のラベル label_key を追加します。
• スクレイピングされたすべての指標に service メタデータ ラベルと revision メタデータ ラベルを追加します。

使用可能な構成オプションについては、RunMonitoring 仕様: 構成オプションをご覧ください。

カスタム RunMonitoring 構成を使用する場合は、次の追加構成を行う必要があります。

• Secret Manager API を有効にして、Cloud Run サービス アカウントに Secret Manager のロールを付与します。詳細については、始める前にをご覧ください。
• カスタム構成をシークレットとして保存します。
• Cloud Run サービスにサイドカーを追加します。

Secret Manager を使用して構成を保存する

カスタム RunMonitoring 構成を用意するには、次の操作を行います。

• カスタム構成を含むファイルを作成します。
• カスタム構成を含む Secret Manager シークレットを作成します。

次のコマンドでは、custom-config.yaml ファイルから mysecret という名前のシークレットを作成します。

gcloud secrets create mysecret --data-file=custom-config.yaml

custom-config.yaml ファイルの変更後に構成の変更を反映するには、シークレットを削除して再作成してから、Cloud Run サービスを再デプロイする必要があります。

Secret Manager での構成の更新

カスタ�� RunMonitoring 構成をいつでも更新できるようにするには、既存の Secret の新しいバージョンを Secret Manager に追加します。

たとえば、ファイル custom-config-updated.yaml に保存された新しい構成で mysecret を更新するには、次のコマンドを実行します。

gcloud secrets versions add mysecret --data-file=custom-config-updated.yaml

サイドカーが自動的に再読み込みされ、変更が構成に適用されます。

Cloud Run サービスにサイドカーを追加する

RunMonitoring 構成の Secret Manager シークレットを作成したら、Cloud Run の構成を次のように変更する必要があります。

• Managed Service for Prometheus サイドカーを追加します。
  • コンテナの起動とシャットダウンの順序を指定するコンテナ依存関係アノテーションを追加します。次の例では、collector という名前のサイドカー コンテナが、app という名前のアプリケーション コンテナの後に起動し、その後シャットダウンします。
  • コレクタのコンテナを作成します。次の例では collector という名前にしています。
• シークレットをロケーション /etc/rungmp/config.yaml にマウントして追加します。
  • カスタム RunMonitoring 構成を保持するシークレットを参照するシークレット アノテーションを追加します。
  • ファイル config.yaml を参照するシークレット用に、次の例では config という名前のボリュームを作成します。
  • コレクタ イメージの一部としてボリュームをマウントパス /etc/rungmp にマウントします。

たとえば、+（プラス）記号で始まる行を Cloud Run 構成に追加して、サービスを再デプロイします。

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  annotations:
    run.googleapis.com/launch-stage: ALPHA
    run.googleapis.com/cpu-throttling: 'false'
  name: my-cloud-run-service
spec:
  template:
    metadata:
      annotations:
        run.googleapis.com/execution-environment: gen2
+       run.googleapis.com/container-dependencies: '{"collector":["app"]}'
+       run.googleapis.com/secrets: 'mysecret:projects/PROJECT_ID/secrets/mysecret'
    spec:
      containers:
      - image: "REGION-docker.pkg.dev/PROJECT_ID/run-gmp/sample-app"
        name: app
        startupProbe:
          httpGet:
            path: /startup
            port: 8000
        livenessProbe:
          httpGet:
            path: /liveness
            port: 8000
        ports:
        - containerPort: 8000
+     - image: "us-docker.pkg.dev/cloud-ops-agents-artifacts/cloud-run-gmp-sidecar/cloud-run-gmp-sidecar:1.1.1"
+       name: collector
+       volumeMounts:
+       - mountPath: /etc/rungmp/
+         name: config
+     volumes:
+     - name: config
+       secret:
+         items:
+         - key: latest
+           path: config.yaml
+         secretName: 'mysecret'

構成ファイル run-service.yaml を使用して Cloud Run サービスを再デプロイするには、次のコマンドを実行します。

gcloud run services replace run-service.yaml --region=REGION

RunMonitoring 仕様: 構成オプション

このセクションでは、Managed Service for Prometheus サイドカーの RunMonitoring 構成仕様について説明します。カスタム構成の例を次に示します。

apiVersion: monitoring.googleapis.com/v1beta
kind: RunMonitoring
metadata:
  name: my-custom-cloud-run-job
spec:
  endpoints:
  - port: 8080
    path: /metrics
    interval: 10s
    metricRelabeling:
    - action: replace
      sourceLabels:
      - __address__
      targetLabel: label_key
      replacement: label_value
  targetLabels:
    metadata:
    - service
    - revision

RunMonitoring

RunMonitoring 構成は、Cloud Run サービスをモニタリングします。

RunMonitoringSpec

この仕様では、RunMonitoring 構成で Cloud Run サービスをモニタリングする方法を記述します。

RunTargetLabels

RunTargetLabels 構成を使用すると、検出された Prometheus ターゲットの Cloud Run ラベルを含めることができます。

Cloud Build を使用する

Cloud Build を使用する

run-gmp-sidecar リポジトリには、Cloud Build の構成ファイルが含まれています。これらのファイルには、サンプルアプリのビルドとデプロイに必要なステップがバンドルされています。

Cloud Build によって処理されるステップを手動で実行することもできます。詳細については、手動でビルドして実行するをご覧ください。

Cloud Build 用に設定する

これらの構成ファイルを使用するには、Cloud Build サービス アカウントと Artifact Registry リポジトリが必要です。run-gmp-sidecar リポジトリには、次の処理を行うスクリプト create-sa-and-ar.sh も含まれています。

• サービス アカウント run-gmp-sa@PROJECT_ID.iam.gserviceaccount.com を作成します。
• サービス アカウントに次のロールを付与します。
  • roles/iam.serviceAccountUser
  • roles/storage.objectViewer
  • roles/logging.logWriter
  • roles/artifactregistry.createOnPushWriter
  • roles/secretmanager.admin
  • roles/secretmanager.secretAccessor
  • roles/run.admin
• コンテナ イメージ用の Artifact Registry リポジトリ run-gmp を作成します。

run-gmp-sa サービス アカウントと run-gmp リポジトリを作成するには、次のコマンドを実行します。

./create-sa-and-ar.sh

権限が反映されるまでに時間がかかります。30 秒ほど待ってから次のステップに進むことをおすすめします。そうしないと、承認エラーが表示されることがあります。

Cloud Build リクエストを送信する

run-gmp-sa サービス アカウントと run-gmp リポジトリを設定したら、Cloud Build 構成ファイルを送信して Cloud Build ジョブを開始できます。次の gcloud builds submit コマンドを使用できます。

gcloud builds submit . --config=cloudbuild-simple.yaml --region=REGION

このコマンドの実行には数分かかりますが、Cloud Build ビルドの詳細を確認できる場所がすぐに表示されます。次のようなメッセージが表示されます。

Logs are available at [
https://console.cloud.google.com/cloud-build/builds/637860fb-7a14-46f2-861e-09c1dc4cea6b?project=PROJECT_NUMBER].

ビルドの進行状況を確認するには、ブラウザで、返された URL に移動します。Cloud Logging でサイドカーのログを確認することもできます。

サービスの URL を確認する

Cloud Build ジョブが終了したら、次のコマンドを実行して Cloud Run サービスのエンドポイント URL を確認します。

gcloud run services describe my-cloud-run-service --region=REGION --format="value(status.url)"

このコマンドは、次のようなサービス URL を返します。

https://my-cloud-run-service-abcdefghij-ue.a.run.app

この URL は、アプリが実行されていることを確認するで SERVICE_URL の値として使用します。

手動でビルドして実行する

手動でビルドして実行する

Cloud Build を使用するで説明しているように、Cloud Build によって処理されるステップを手動で実行することもできます。以降のセクションでは、同じタスクを手動で実行する方法について説明します。

後のステップで使用する変数を設定する

以降のいくつかのステップでは、共通の値として環境変数を使用します。これらの変数を設定するには、次のコマンドを使用します。

export GCP_PROJECT=PROJECT_ID
export REGION=REGION

コンテナ イメージ リポジトリを作成する

次のコマンドを実行して、コンテナ イメージの Artifact Registry リポジトリを作成します。

gcloud artifacts repositories create run-gmp \
    --repository-format=docker \
    --location=${REGION}

サンプルアプリをビルドして push する

この例では、Linux で Docker を使用してサンプルアプリをビルドし、Artifact Registry リポジトリに push します。Windows または macOS 環境で作業している場合は、これらのコマンドの調整が必要になることがあります。

サンプルアプリをビルドして Artifact Registry に push するには、次の操作を行います。

1. Google Cloud CLI を使用して Docker クライアントを認証します。

   gcloud auth configure-docker ${REGION}-docker.pkg.dev
   

2. run-gmp-sidecar リポジトリの simple-app ディレクトリに移動します。

   pushd sample-apps/simple-app
   

3. 次のコマンドを実行して、simple-app アプリをビルドします。

   docker build -t ${REGION}-docker.pkg.dev/${GCP_PROJECT}/run-gmp/sample-app .
   

4. 次のコマンドを実行して、ビルド済みアプリのイメージを push します。

   docker push ${REGION}-docker.pkg.dev/${GCP_PROJECT}/run-gmp/sample-app
   

5. run-gmp-sidecar ディレクトリに戻ります。

   popd
   

Cloud Run サービスを構成する

run-gmp-sidecar リポジトリの run-service-simple.yaml ファイルは、前の手順でビルドしたサンプルアプリとコレクタ イメージを使用するマルチコンテナ Cloud Run サービスを定義します。run-service-simple.yaml ファイルには、次の Service 仕様が含まれています。

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  annotations:
    run.googleapis.com/launch-stage: ALPHA
    run.googleapis.com/cpu-throttling: 'false'
  name: my-cloud-run-service
spec:
  template:
    metadata:
      annotations:
        run.googleapis.com/execution-environment: gen2
        run.googleapis.com/container-dependencies: '{"collector":["app"]}'
    spec:
      containers:
      - image: "%SAMPLE_APP_IMAGE%"
        name: app
        startupProbe:
          httpGet:
            path: /startup
            port: 8000
        livenessProbe:
          httpGet:
            path: /liveness
            port: 8000
        ports:
        - containerPort: 8000
      - image: "us-docker.pkg.dev/cloud-ops-agents-artifacts/cloud-run-gmp-sidecar/cloud-run-gmp-sidecar:1.1.1"
        name: collector

このファイルには、前の手順で作成したイメージ�������ースホルダ値が含まれているため、Google Cloud プロジェクトの実際の値でプレースホルダを更新する必要があります。

次のコマンドを実行して、%SAMPLE_APP_IMAGE% プレースホルダを置き換えます。

sed -i s@%SAMPLE_APP_IMAGE%@REGION-docker.pkg.dev/${GCP_PROJECT}/run-gmp/sample-app@g run-service-simple.yaml

Cloud Run サービスをデプロイする

値で run-service-simple.yaml ファイルを更新したら、次のコマンドで Cloud Run サービスを作成してデプロイできます。

gcloud run services replace run-service-simple.yaml --region=REGION
   

このコマンドは、次のようなサービス URL を返します。

https://my-cloud-run-service-abcdefghij-ue.a.run.app

この URL は、アプリが実行されていることを確認するで SERVICE_URL の値として使用します。

未認証の HTTP アクセスを許可する

サービス URL にリクエストを送信するには、未認証の HTTP アクセスを受け入れるように Cloud Run サービス ポリシーを変更する必要があります。run-gmp-sidecar リポジトリの policy.yaml ファイルには、必要な変更が含まれています。

サービス ポリシーを変更するには、次のコマンドを実行します。

gcloud run services set-iam-policy my-cloud-run-service policy.yaml --region=REGION