合成モニターを作成する

Console

Google Cloud コンソールを使用して合成モニターを作成すると、新しい Cloud Run 関数（第 2 世代）がデプロイされ、その Cloud Run 関数のモニターが作成されます。既存の Cloud Run 関数をモニタリングする合成モニターは作成できません。

1. 必要な API が有効になっていること、プロジェクトにデフォルトの Compute Engine サービス アカウントが含まれていること、このアカウントに編集者（roles/editor）のロールが付与されていることを確認します。詳細については、始める前にをご覧ください。

2. Google Cloud コンソールで、 [合成モニタリング] ページに移動します。

   [合成モニタリング] に移動

   検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。

3. [合成モニターを作成] を選択します。

4. Cloud Run functions のテンプレートを選択します。

   • カスタム合成モニター: 送信 HTTP リクエストのログデータまたはトレースデータを収集する場合は、このテンプレートを使用します。

   • Mocha 合成モニター: Mocha テストスイートを作成するときにこのテンプレートを使用します。

   • 無効なリンクのチェッカー: このテンプレートを使用して、その URI で見つかった URI と構成可能な数のリンクをテストします。このチェッカーのフィールドについては、無効なリンクのチェッカーを作成するをご覧ください。

5. モニターの名前を入力します。

6. 省略可: [レスポンスのタイムアウト] と [チェック頻度] を更新し、ユーザー定義のラベルを追加します。

7. 次のいずれかを行います。

   • このプロジェクトの Gemini Code Assist へのアクセス権があり、コード作成のサポートが必要な場合は、[コーディングをサポート] をクリックします。この機能は公開プレビュー版です。プロンプトのガイダンスについては、合成モニターのプロンプトの作成方法を学習するをご覧ください。

     コードに問題がなければ、[Cloud Functions の関数に挿入] をクリックします。

   • [ファンクションを作成] をクリックします。

8. Cloud Run functions のダイアログで、次の操作を行います。

   1. 表示名を入力し、リージョンを選択します。名前はリージョン内で一意でなければなりません。

   2. [ランタイム、ビルド、接続、セキュリティの設定] セクションで、次の操作を行います。

      • デフォルト設定を確認し、必要に応じて更新します。

      • [Runtime サービス アカウント] フィールドで、サービス アカウントを選択します。

   3. 生成されたコードを編集するか、Cloud Run functions のコードを記述またはアップロードします。

      • 生成されたコードを編集したり、独自のコードやデフォルトのサンプル関数を読み込んだりする場合は、[インライン エディタ] を選択します。サンプル関数は、前に選択したテンプレートに依存し、特定の URL にリクエストを送信します。デフォルト関数を変更できます。

      • ローカル システムから zip ファイルを読み込むには、[ZIP アップロード] を選択します。

        ローカル システムから ZIP ファイルをアップロードする場合は、ZIP ファイルの Cloud Storage バケットも指定する必要があります。適切な Cloud Storage バケットがない場合は、作成します。

      • Cloud Storage から ZIP ファイルを読み込むには、[Cloud Storage の ZIP] を選択し、ストレージ バケットを選択して、読み込む ZIP ファイルを選択します。

        Google Cloud コンソールの Cloud Run functions ページを使用して、Cloud Run functions を作成することもできます。その Cloud Run functions のコピーをモニタリングする合成モニターを作成するには、[ソース] タブに移動して [zip をダウンロードする] をクリックします。その後、zip ファイルをアップロードできます。

   4. [関数を適用する] をクリックします。

9. アラート ポリシーを構成します。

   1. 省略可: アラート ポリシー名と、通知が送信されるまでの障害継続期間を更新します。

   2. 通知チャンネルを追加します。

10. [作成] をクリックします。

    定義した Cloud Run functions が第 2 世代としてビルドされ、デプロイされ、合成モニターが作成されます。

gcloud

Google Cloud CLI または Cloud Monitoring API を使用して合成モニターを作成する場合は、関数名を API 呼び出しに渡します。したがって、既存の Cloud Run functions をモニタリングする合成モニターのみを作成できます。

1. 必要な API が有効になっていること、プロジェクトにデフォルトの Compute Engine サービス アカウントが含まれていること、このアカウントに編集者（roles/editor）のロールが付与されていることを確認します。詳細については、始める前にをご覧ください。
2. 第 2 世代の Cloud Run functions を書き込み、デプロイします。

   たとえば、Google Cloud/synthetics-sdk-nodejs リポジトリに synthetics-sdk-nodejs サンプルをデプロイするには、次のようにします。

   1. リポジトリのクローンを作成し、ソースコードのロケーションに移動します。

      git clone https://github.com/GoogleCloudPlatform/synthetics-sdk-nodejs.git
      cd synthetics-sdk-nodejs/samples/generic-synthetic-nodejs
      

   2. gcloud functions deploy コマンドを使用して Cloud Run functions をデプロイします。

      gcloud functions deploy FUNCTION_NAME \
      --gen2 --region="us-west2" --source="." \
      --entry-point=SyntheticFunction --trigger-http --runtime=nodejs18
      

      gcloud functions deploy コマンドで、次のようにします。

      • FUNCTION_NAME フィールドの値がデプロイ リージョン内で一意であることを確認します。

      • --gen2 フラグを指定して、デプロイ リージョンを設定します。

      • 次のように --entry-point フィールドを設定します。

        • Mocha: SyntheticMochaSuite
        • Mocha 以外: SyntheticFunction。

      • --runtime フィールドを nodejs18 に設定します。

      • フラグ --trigger-http を追加します。

      • すべてのトラフィックを許可するデフォルト設定を使用しない場合は、--ingress-settings フィールドを設定します。

      Cloud Run functions は、Cloud Run functions をビルドしてデプロイします。Google Cloud CLI コマンドの結果には、関数の完全修飾名などの関数に関する情報が含まれます。

      name: projects/PROJECT_ID/locations/REGION/functions/FUNCTION_NAME
      

      関数のデプロイについては、Cloud Run functions をデプロイするをご覧ください。

   Google Cloud プロジェクト内の Cloud Run functions を一覧表示するには、gcloud functions list コマンドを使用します。

   gcloud functions list
   

   この呼び出しのレスポンスはリストエントリです。各エントリには Cloud Run functions が一覧表示されます。

   NAME: function-1
   STATE: ACTIVE
   TRIGGER: HTTP Trigger
   REGION: us-west2
   ENVIRONMENT: 2nd gen
   

   特定の Cloud Run functions の完全修飾名を確認するには、gcloud monitoring uptime describe コマンドを実行します。

3. 合成モニターを作成するには、gcloud monitoring uptime create コマンドを実行します。

   gcloud monitoring uptime create DISPLAY_NAME --synthetic-target=TARGET
   

   前述のコマンドを実行する前に、次のようにしてください。

   • DISPLAY_NAME は、合成モニターの名前に置き換えます。
   • TARGET は、Cloud Run functions の完全修飾名に置き換えます。

4. アラート ポリシーを作成します。

   アラート ポリシーの構成の複雑さのため、Google Cloud コンソールで [合成モニター] ページに移動し、オプションを使用してアラート ポリシーを作成することをおすすめします。このアプローチでは、ほとんどのアラート ポリシー フィールドに値が自動入力されます。Google Cloud コンソールを使用してアラート ポリシーを作成するには、合成モニター ページで ポリシーを作成するをクリックします。

   Google Cloud CLI または Cloud Monitoring API を使用する場合は、次のように条件のフィルタを構成します。

   "filter": "resource.type = \"cloud_run_revision\" AND
               metric.type = \"monitoring.googleapis.com/uptime_check/check_passed\" AND
               metric.labels.check_id = \"CHECK_ID\"",
   

   条件は、合成モニターによって書き込まれた uptime_check/check_passed 時系列をモニタリングします。CHECK_ID は、合成モニターの識別子に置き換えるようにしてください。これは create コマンドのレスポンス データに含まれます。

   アラート ポリシーの作成方法については、API を使用してアラート ポリシーを作成するをご覧ください。

API

Google Cloud CLI または Cloud Monitoring API を使用して合成モニターを作成する場合は、関数名を API 呼び出しに渡します。したがって、既存の Cloud Run functions をモニタリングする合成モニターのみを作成できます。

1. 必要な API が有効になっていること、プロジェクトにデフォルトの Compute Engine サービス アカウントが含まれていること、このアカウントに編集者（roles/editor）のロールが付与されていることを確認します。詳細については、始める前にをご覧ください。
2. 第 2 世代の Cloud Run functions を書き込み、デプロイします。

   たとえば、Google Cloud/synthetics-sdk-nodejs リポジトリに synthetics-sdk-nodejs サンプルをデプロイするには、次のようにします。

   1. リポジトリのクローンを作成し、ソースコードのロケーションに移動します。

      git clone https://github.com/GoogleCloudPlatform/synthetics-sdk-nodejs.git
      cd synthetics-sdk-nodejs/samples/generic-synthetic-nodejs
      

   2. gcloud functions deploy コマンドを使用して Cloud Run functions をデプロイします。

      gcloud functions deploy FUNCTION_NAME \
      --gen2 --region="us-west2" --source="." \
      --entry-point=SyntheticFunction --trigger-http --runtime=nodejs18
      

      gcloud functions deploy コマンドで、次のようにします。

      • FUNCTION_NAME フィールドの値がデプロイ リージョン内で一意であることを確認します。

      • --gen2 フラグを指定して、デプロイ リージョンを設定します。

      • 次のように --entry-point フィールドを設定します。

        • Mocha: SyntheticMochaSuite
        • Mocha 以外: SyntheticFunction。

      • --runtime フィールドを nodejs18 に設定します。

      • フラグ --trigger-http を追加します。

      • すべてのトラフィックを許可するデフォルト設定を使用しない場合は、--ingress-settings フィールドを設定します。

      Cloud Run functions は、Cloud Run functions をビルドしてデプロイします。Google Cloud CLI コマンドの結果には、関数の完全修飾名などの関数に関する情報が含まれます。

      name: projects/PROJECT_ID/locations/REGION/functions/FUNCTION_NAME
      

      関数のデプロイについては、Cloud Run functions をデプロイするをご覧ください。

   Google Cloud プロジェクト内の Cloud Run functions を一覧表示するには、gcloud functions list コマンドを使用します。

   gcloud functions list
   

   この呼び出しのレスポンスはリストエントリです。各エントリには Cloud Run functions が一覧表示されます。

   NAME: function-1
   STATE: ACTIVE
   TRIGGER: HTTP Trigger
   REGION: us-west2
   ENVIRONMENT: 2nd gen
   

   特定の Cloud Run functions の完全修飾名を確認するには、gcloud monitoring uptime describe コマンドを実行します。

3. 合成モニターを作成する手順は次のとおりです。

   1. [projects.uptimeCheckConfigs.create] をクリックして、メソッドの API リファレンス ページを開きます。
   2. [試す] をクリックして API Explorer を開きます。

   3. 次のフィールドを設定して、コマンドを実行します。

      • 親フィールド: projects/PROJECT_ID。

      • リクエスト本文には、次のように指定します。

        • displayName: 合成モニターの表示名に設定します。
        • syntheticMonitor: Cloud Run functions の完全修飾名に設定します。

      成功すると、API 呼び出しのレスポンスは次のようになります。

      {
      "name": "projects/myproject/uptimeCheckConfigs/17272586127463315332",
      "displayName": "MyMonitor",
      ...
      "syntheticMonitor": {
       "cloudFunctionV2": {
          "name": "projects/myproject/locations/us-west2/functions/function-1",
          "cloudRunRevision": {
          "type": "cloud_run_revision",
          "labels": {
             "project_id": "myproject",
             "configuration_name": "",
             "location": "us-west2",
             "revision_name": "",
             "service_name": "function-1"
          }
          }
       }
      }
      }
      

4. アラート ポリシーを作成します。

   アラート ポリシーの構成の複雑さのため、Google Cloud コンソールで [合成モニター] ページに移動し、オプションを使用してアラート ポリシーを作成することをおすすめします。このアプローチでは、ほとんどのアラート ポリシー フィールドに値が自動入力されます。Google Cloud コンソールを使用してアラート ポリシーを作成するには、合成モニター ページで ポリシーを作成するをクリックします。

   Google Cloud CLI または Cloud Monitoring API を使用する場合は、次のように条件のフィルタを構成します。

   "filter": "resource.type = \"cloud_run_revision\" AND
               metric.type = \"monitoring.googleapis.com/uptime_check/check_passed\" AND
               metric.labels.check_id = \"CHECK_ID\"",
   

   条件は、合成モニターによって書き込まれた uptime_check/check_passed 時系列をモニタリングします。CHECK_ID は、合成モニターの識別子に置き換えるようにしてください。これは create コマンドのレスポンス データに含まれます。

   アラート ポリシーの作成方法については、API を使用してアラート ポリシーを作成するをご覧ください。

Terraform

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。 詳細については、Terraform プロバイダのリファレンス ドキュメントをご覧ください。

合成モニターと、そのチェックをモニタリングするアラート ポリシーを作成するには、次の手順を行います。

1. 必要な API が有効になっていること、プロジェクトにデフォルトの Compute Engine サービス アカウントが含まれていること、このアカウントに編集者（roles/editor）のロールが付与されていることを確認します。詳細については、始める前にをご覧ください。

2. Terraform 構成ファイルを編集して google_storage_bucket リソースを追加し、変更を適用します。

   次のコードは、US ロケーションに Cloud Storage バケットを定義します。

   resource "google_storage_bucket" "gcf_source" {
      name = "gcf-v2-source-9948673986912-us"
      location = "US"
      uniform_bucket_level_access = true
   }
   

3. Terraform 構成ファイルを編集して google_storage_bucket_object リソースを追加し、変更を適用します。

   このリソースでは、バケット内のオブジェクトの名前と、ローカル システム上の zip ファイルのロケーションを指定します。たとえば、次のコードを適用すると、example-function.zip という名前のファイルがストレージ バケットに追加されます。

   resource "google_storage_bucket_object" "object" {
      name = "example-function.zip"
      bucket = google_storage_bucket.gcf_source.name
      source = "generic-synthetic-node.js.zip"
   }
   

4. Terraform 構成ファイルを編集して google_cloudfunctions2_function リソースを追加し、変更を適用します。

   google_cloudfunctions2_function リソースで、Node.js ランタイムと合成モニターで使用されるエントリ ポイントを指定していることを確認します。たとえば、次のコードを適用すると、sm-central1 という名前の関数がデプロイされます。

   resource "google_cloudfunctions2_function" "central1" {
      name = "sm-central1"
      location = "us-central1"
   
      build_config {
         runtime = "nodejs20"
         entry_point = "SyntheticFunction"
         source {
               storage_source {
                  bucket = google_storage_bucket.gcf_source.name
                  object = google_storage_bucket_object.object.name
               }
         }
      }
   
      service_config {
         max_instance_count = 1
         available_memory = "256Mi"
         timeout_seconds  = 60
      }
   }
   

5. 合成モニターを作成するには、Terraform 構成ファイルを編集して google_monitoring_uptime_check_config リソースを追加し、変更を適用します。

   このリソースには、synthetic_monitor ブロックを指定します。

   resource "google_monitoring_uptime_check_config" "synthetic" {
      display_name = "sm-central1"
      timeout = "30s"
   
      synthetic_monitor {
         cloud_function_v2 {
               name = google_cloudfunctions2_function.central1.id
         }
      }
   }
   

6. 省略可: 通知チャンネルとアラート ポリシーを作成します。

   次の手順では、Google Cloud コンソールを使用して通知チャンネルとアラート ポリシーを作成します。このアプローチにより、アラート ポリシーは合成モニターによって生成されたデータのみをモニタリングします。

   1. 通知チャネルを作成する方法は、次のとおりです。

      1. Google Cloud コンソールで、notifications [アラート] ページに移動します。

         [アラート] に移動

         検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。

      2. [通知チャンネルを管理] を選択します。
      3. 追加するチャネルの種類に移動し、[追加] をクリックして、ダイアログを完了します。

   2. アラート ポリシーを作成するには:

      1. Google Cloud コンソールで、 [合成モニタリング] ページに移動します。

         [合成モニタリング] に移動

         検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。

      2. 合成モニターを見つけて、more_vert [その他] を選択し、[アラート ポリシーを追加] を選択します。
      3. ダイアログで [通知と名前] セクションに移動し、[通知チャンネル] を展開して選択します。
      4. アラート ポリシーに名前を付けて、[ポリシーを作成] をクリックします。