合成モニターを作成する

このドキュメントでは、合成モニターを作成して、サービス、アプリケーション、ウェブページ、API の可用性、整合性、パフォーマンスをテストする方法について説明します。アプリケーションのテストはユーザーが作成します。合成モニターは、そのスクリプトを実行して、テスト結果やレイテンシなどの追加データを記録します。テストに失敗したときに通知を受け取るようにするには、テスト結果をモニタリングするアラートポリシーを構成します。

この機能は Google Cloud プロジェクトでのみサポートされています。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。

合成モニターについて

合成モニターは、Cloud Run にデプロイされた単一目的の Cloud Run functions の関数（第 2 世代）を定期的に実行します。合成モニターの作成時に、Cloud Run functions の関数（Node.js で記述）と実行頻度を定義します。たとえば、Puppeteer を使用して、ウェブページとやり取りするように Cloud Run functions の関数を構成できます。また、Axios モジュールを使用して API とやり取りするように Cloud Run functions の関数を構成することもできます。VPC ネットワーク内にあるリソースをテストすることもできます。

Cloud Run functions の関数を作成するには、インラインエディタを使用するか、zip ファイルをアップロードします。インラインエディタを使用する場合は、指定したスケルトンを使って開始できます。合成モニターを作成すると、Cloud Monitoring は、Cloud Run functions の関数の定期的な実行をスケジューリングするスケジューリングシステムを使用します。Cloud Run functions の関数が存在するリージョンを指定している場合、実行をトリガーするコマンドは、稼働時間チェックサーバーでサポートされている任意のリージョンで指定できます。詳細については、稼働時間チェックサーバーの IP アドレスを一覧表示するをご覧ください。

テストが失敗したときに通知されるようにアラートポリシーを作成できます。

Google Cloud コンソールで合成モニターを作成するときに、デフォルトではアラートポリシーが作成されます。ユーザーが通知チャンネルを指定します。デフォルトのアラートポリシーは、連続して 2 回以上テストが失敗した場合に通知するように構成されています。
Cloud Monitoring API を使用して合成モニターを作成する場合は、アラートポリシーを作成して、Cloud Run functions の関数が実行される Cloud Run リソースの uptime_check/check_passed 指標タイプをモニタリングする必要があります。

実行頻度に関する考慮事項

Cloud Run functions の関数の実行頻度を構成します。実行頻度は、サービスのサービスレベル目標（SLO）を考慮して決定します。潜在的な SLO 違反を捕捉するには、テストを頻繁に実行する必要があります。ただし、サービスの SLO だけを考慮するわけではありません。また、実行頻度がサービスの負荷と費用にどのように影響するかも考慮する必要があります。実行ごとにサービスの負荷がかかるため、Cloud Run functions の関数を実行する頻度が高いほど、サービスに対する負荷が増加します。なお、稼働時間チェックのデフォルトの実行間隔は 1 分です。

実行頻度によって、テストに失敗したときに通知される速度も決まります。Monitoring は、インシデントを開き、テストに 2 回連続失敗した後に通知を送信します。たとえば、実行頻度が 5 分の場合、テストが 2 回失敗するまでに 10 分かかることになります。テストが 2 回失敗した後に通知されます。

Cloud Run functions の関数のサンプルコード

テンプレートとサンプルについては、合成モニターのサンプルをご覧ください。これらのサンプルを Cloud Run functions の関数の開始点として使用できます。経験豊富なデベロッパーの方は、Gemini を使用して合成モニターのコードを生成し、開発時間を短縮することも検討してください。Gemini を使用してコードを生成する機能は公開プレビュー版です。

Google Cloud コンソールを使用して合成モニターを作成するときに、汎用テンプレートを選択できます。このテンプレートは、アウトバウンド HTTP リクエストのトレースデータとログデータを収集するように構成されています。このソリューションでは、OpenTelemetry auto-instrumentation-node モジュールと winston ロガーを利用します。オープンソースプロダクトに依存しているため、トレースデータとログデータの構造が変更される可能性があります。したがって、収集されたトレースデータとログデータは、デバッグ目的でのみ使用してください。

独自のアプローチを実装して、アウトバウンド HTTP リクエストのトレースデータとログデータを収集できます。カスタムアプローチの例については、クラス SyntheticAutoInstrumentation をご覧ください。

Cloud Run functions の関数の構成

Cloud Run functions の関数を構成する場合は、ランタイム、ビルド、接続、セキュリティの設定を指定するか、デフォルト設定をそのまま使用します。

割り当てられたメモリのデフォルト値では十分ではない場合があります。このフィールドは 2 GiB 以上に設定することをおすすめします。
Cloud Run functions の関数のインバウンドデータ転送設定のデフォルト値では、すべてのトラフィックが許可されます。この設定を使用することも、より制限の厳しい設定に変更することもできます。

すべてのトラフィックを許可すると、Cloud Run functions で実行される検証の最初のフェーズがネットワークレベルで行われ、常に合格します。検証の 2 番目のフェーズでは、呼び出し元に Cloud Run functions の関数の実行権限が付与されているかどうかを確認します。認可は、呼び出し元の Identity and Access Management（IAM）ロールによって異なります。デフォルトでは、Cloud Monitoring には Cloud Run functions の関数を実行する権限が付与されています。インバウンドデータ転送設定を表示または変更する方法については、上り（内向き）設定をご覧ください。

Cloud Run functions の関数の制限

Cloud Run functions の関数の名前にアンダースコアを使用することはできません。
アウトバウンド HTTP リクエストのトレースデータとログデータを収集できるのは、汎用テンプレートを使用する場合のみです。
HTTP 関数のみがサポートされています。Google Cloud コンソールを使用して合成モニターを作成する場合は、URL をクエリするデフォルト関数が提供されます。デフォルト関数のソースは変更可能で、generic-synthetic-nodejs Git リポジトリで入手できます。

HTTP 関数の詳細については、HTTP 関数を作成するをご覧ください。
API を使用する場合、デプロイコマンドでは Cloud Run functions の関数が第 2 世代であることを指定する必要があります。Google Cloud コンソールでは、デプロイが自動的に処理されます。詳細については、Cloud Run functions の関数をデプロイするをご覧ください。
ランタイム環境は Node.js に制限されています。詳細については、ノードをご覧ください。サポートされている Node.js のバージョンは 12、14、16、18、20 です。

合成モニターによって収集されるデータ

このセクションでは、合成モニター用に収集されるデータについて説明します。実行結果を表示する方法については、合成モニターの結果を探索するをご覧ください。

実行履歴

合成モニターごとに、実行結果の履歴が収集されます。このデータには次のものが含まれます。

時間の経過に合わせて実行の成功または失敗を記録する時系列。
コードの実行時間を記録する時系列。関数の実行時間は記録されません。レイテンシデータは、Cloud Run functions の関数が実行されている Cloud Run リソースの uptime_check/request_latency 時系列として書き込まれます。このデータのチャートは、[合成モニターの詳細] ページにあります。
合成モニターの実行に関する情報（テストと障害の詳細など）を含むログ。使用可能なログは、Cloud Run functions の関数によって異なります。たとえば、Mocha テンプレートを使用する場合、テストの成否とテスト時間に関する情報がログに含まれます。スタックトレースが含まれる場合は、失敗したコード行、エラータイプ、エラーメッセージが一覧表示されます。
アウトバウンド HTTP リクエストのトレースとログ（必要な場合）。このデータを収集する方法については、リクエストレイテンシをご覧ください。

Cloud Run functions の関数の指標とログ

Cloud Run functions の関数の指標とログ。このデータは Cloud Run functions によって収集され、関数の 1 秒あたりの実行回数、実行時間、メモリ使用量に関する情報が含まれます。

リクエストのレイテンシ

合成モニターによる HTTP リクエストのレイテンシデータは Cloud Trace によって自動的に収集され、保存されます。

合成モニターにより、アウトバウンド HTTP リクエストのトレースデータ、ログデータ、レイテンシデータを収集するには、汎用テンプレートを使用する必要があります。詳細については、合成モニターのサンプルをご覧ください。

始める前に

合成モニターを保存する Google Cloud プロジェクトで、次の手順を完了します。

Google Cloud コンソールを使用して合成モニターを表示して変更するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。
- モニタリング編集者（roles/monitoring.editor）
- Cloud Functions デベロッパー（roles/cloudfunctions.developer）
ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
Enable the Cloud Monitoring API, Artifact Registry API, Cloud Build API, Cloud Functions API, Cloud Logging API, Pub/Sub API, and Cloud Run Admin API APIs.
Enable the APIs
Google Cloud プロジェクトにデフォルトの Compute Engine サービスアカウントが含まれていることを確認します。このサービスアカウントは、Compute Engine API を有効にしたときに作成され、名前は 12345-compute@developer.gserviceaccount.com のようになります。

Google Cloud コンソールで、[サービスアカウント] ページに移動します。
[サービスアカウント] に移動

このページを検索バーで検索する場合は、小見出しが「IAM と管理」の結果を選択します。

デフォルトの Compute Engine サービスアカウントが存在しない場合は、[サービスアカウントを作成] をクリックしてダイアログを完了します。
デフォルトの Compute Engine サービスアカウントまたは作成したサービスアカウントに、編集者（roles/editor）ロールが付与されていることを確認します。

サービスアカウントに付与されているロールを確認する方法は次のとおりです。
1. Google Cloud コンソールで [IAM] ページに移動します。
  [IAM] に移動
  
  このページを検索バーで検索する場合は、小見出しが「IAM と管理」の結果を選択します。
2. [Google 提供のロール付与を含む] を選択します。
3. 合成モニターで使用されるサービスアカウントがリストにない場合、または Cloud Trace エージェント（roles/cloudtrace.agent）ロールの権限を含むロールが付与されていない場合は、このロールをサービスアカウントに付与します。
通知の受信に使用する通知チャンネルを構成します。複数の種類の通知チャンネルを作成することをおすすめします。詳細については、通知チャンネルの作成と管理と API による通知チャンネルの作成と管理をご覧ください。
Select the tab for how you plan to use the samples on this page:
Console

When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloud
合成モニターを作成する

警告: https://www.google.com をテストするように合成モニターを構成しないでください。サンプルコードを使用する場合は、サンプルコードをデプロイする前に url フィールドを変更してください。
コンソール

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

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

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

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。

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

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

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

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

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

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

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

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

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

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

[関数を作成] をクリックします。

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

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

注: Cloud Run functions の関数の名前にアンダースコアは使用できません。

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

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

注: 割り当てられたメモリ、CPU、セキュリティのデフォルト設定では十分ではない場合があります。メモリは 2 GiB 以上に設定することをおすすめします。

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

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

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

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

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

注: 新しいストレージバケットを作成すると、バケットがすぐに開き、「No objects found」というメッセージとオプション（選択またはキャンセル）が表示されます。[キャンセル] をクリックして [関数の作成] ダイアログに戻ります。次に、宛先バケットで [参照] を選択し、Cloud Storage バケットを選択します。

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

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

[Apply function] をクリックします。

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

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

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

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

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

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

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

gcloud config set コマンドを使用して、デフォルトのプロジェクトを設定するように Google Cloud CLI を構成します。

gcloud config set project PROJECT_ID

前述のコマンドを実行する前に、次のように置き換えます。

PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。

第 2 世代の Cloud Run functions の関数を書き込み、デプロイします。

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

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

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

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 フィールドの値がデプロイリージョン内で一意であることを確認します。

注: Cloud Run functions の関数の名前にアンダースコアは使用できません。

--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 コマンドを実行します。

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

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

前述のコマンドを実行する前に、次のように置き換えます。

DISPLAY_NAME: 合成モニターの名前。

TARGET: Cloud Run functions の関数の完全修飾名。

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

アラートポリシーの構成は複雑なため、 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 プロバイダのリファレンスドキュメントをご覧ください。

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

プロジェクトに Terraform をインストールして構成します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。

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

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 }

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" }

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

注: Cloud Run functions の関数の名前にアンダースコアは使用できません。

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 } }

合成モニターを作成するには、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 } } }

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

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

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

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

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

[通知チャンネルを管理] を選択します。

追加するチャンネルの種類に移動し、[追加] をクリックして、ダイアログを完了します。

アラートポリシーを作成するには、次の操作を行います。

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

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

合成モニターを見つけて、[ その他] を選択し、[アラートポリシーを追加] を選択します。

ダイアログで [通知と名前] セクションに移動し、[通知チャンネル] を開いて選択します。

アラートポリシーに名前を付けて、[ポリシーを作成] をクリックします。
REST

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

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

gcloud config set コマンドを使用して、デフォルトのプロジェクトを設定するように Google Cloud CLI を構成します。

gcloud config set project PROJECT_ID

前述のコマンドを実行する前に、次のように置き換えます。

PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。

第 2 世代の Cloud Run functions の関数を書き込み、デプロイします。

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

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

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

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 フィールドの値がデプロイリージョン内で一意であることを確認します。

注: Cloud Run functions の関数の名前にアンダースコアは使用できません。

--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 コマンドを実行します。

合成モニターを作成するには、次の操作を行います。

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

[試してみる] をクリックして API Explorer を開きます。

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

親フィールド: 合成モニターを作成するプロジェクト。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。このフィールドの形式は次のとおりです。

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" } } } } }

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

アラートポリシーの構成は複雑なため、 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 を使用してアラートポリシーを作成するをご覧ください。
料金

一般に、Cloud Monitoring システムの指標は無料であり、外部システム、エージェント、またはアプリケーションの指標はそうではありません。課金対象の指標は、取り込まれたバイト数とサンプル数のいずれかによって課金されます。

Cloud Monitoring の料金の詳細については、次のドキュメントをご覧ください。
- Cloud Monitoring の料金概要
- Cloud Monitoring の料金
合成モニターのトラブルシューティング

このセクションでは、合成モニターのトラブルシューティングに役立つ情報を提供します。

API を有効にした後のエラーメッセージ

合成モニターの作成フローを開くと、少なくとも 1 つの API を有効にするように求められます。API を有効にすると、次のようなメッセージが表示されます。
```
An error occurred during fetching available regions: Cloud Functions API has
not been used in project PROJECT_ID before or it is disabled.
```
このエラーメッセージでは、API が有効であることを確認し、有効な場合は、しばらくしてから再試行するように助言しています。

API が有効になっていることを確認するには、プロジェクトの [API とサービス] ページに移動します。

[API とサービス] に移動

API が有効になっていることを確認したら、作成フローを続行できます。条件は、API が有効になったことがバックエンドを介して伝播されると自動的に解決されます。

アウトバウンド HTTP リクエストがトレースされない

出力の HTTP リクエストのトレースデータを収集するように合成モニターを構成します。次のスクリーンショットと同様に、トレースデータにはスパンが 1 つだけ表示されます。

この状況を解決するには、サービスアカウントに Cloud Trace エージェント（roles/cloudtrace.agent）ロールが付与されていることを確認します。編集者（roles/editor）ロールでも十分です。

サービスアカウントに付与されているロールを確認する方法は次のとおりです。
1. Google Cloud コンソールで [IAM] ページに移動します。
  [IAM] に移動
  
  このページを検索バーで検索する場合は、小見出しが「IAM と管理」の結果を選択します。
2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
3. [Google 提供のロール付与を含む] を選択します。
4. 合成モニターで使用されるサービスアカウントがリストにない場合、または Cloud Trace エージェント（roles/cloudtrace.agent）ロールの権限を含むロールが付与されていない場合は、このロールをサービスアカウントに付与します。
  
  サービスアカウントの名前がわからない場合は、ナビゲーションメニューで [サービスアカウント] を選択します。
進行中のステータス

[合成モニター] ページには、ステータスが In progress の合成モニターが一覧表示されます。ステータスが In progress であることは、合成モニターが最近作成され、表示するデータがないか、関数のデプロイに失敗したことを意味します。

関数のデプロイに失敗したかどうかを判断するには、次のようにします。
- Cloud Run functions の関数の名前にアンダースコアが含まれていないことを確認してください。アンダースコアが含まれている場合は、アンダースコアを削除して Cloud Run functions の関数を再デプロイします。
- 合成モニターの [合成モニターの詳細] ページを開きます。
  
  次のメッセージが表示された場合は、合成モニターを削除します。
  Cloud Function not found for this Synthetic monitor. Please confirm it exists or delete this monitor.
  このエラーメッセージは、関数が削除されているため、合成モニターで関数を実行できないことを示しています。
- 関数の Cloud Run functions ページを開きます。[合成モニターの詳細] ページからこのページを開くには、[コード]、関数名の順にクリックします。
  
  次のようなメッセージが表示された場合は、関数のデプロイに失敗しています。
  This function has failed to deploy and will not work correctly. Please edit and redeploy
  この問題を解決するには、関数コードを確認して、関数のビルドまたはデプロイを妨げるエラーを修正します。
合成モニターを作成すると、関数のデプロイと実行に数分かかる場合があります。

警告ステータス

[合成モニター] には、ステータスが Warning の合成モニターが一覧表示されます。ステータスが Warning の場合、実行結果には整合性がないことを意味します。これは、テストの設計上の問題を示しているか、テスト対象に不整合な動作があることを示している可能性があります。

失敗ステータス

[合成モニター] には、ステータスが Failing の合成モニターが一覧表示されます。失敗の詳しい理由については、最新の実行履歴を確認します。
- 「Request failed with status code 429」というエラーメッセージが表示されている場合、HTTP リクエストのターゲットがコマンドを拒否しています。このエラーを解決するには、合成モニターのターゲットを変更する必要があります。
  
  エンドポイント https://www.google.com が、合成モニターによって行われたリクエストを拒否しています。
- 失敗で実行時間 0ms が返された場合は、Cloud Run functions のメモリ不足が原因である可能性があります。このエラーを解決するには、Cloud Run functions の関数を編集してから、メモリを 2 GiB 以上に増やし、CPU フィールドを 1 に設定します。
合成モニターで削除が失敗する

Cloud Monitoring API を使用して合成モニターを削除しようとすると、API 呼び出しが失敗し、次のようなレスポンスが返されます。
```
{
  "error": {
    "code": 400,
    "message": "Request contains an invalid argument.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.DebugInfo",
        "detail": "[ORIGINAL ERROR] generic::invalid_argument: Cannot delete check 1228258045726183344. One or more alerting policies is using it.Delete the alerting policy with id projects/myproject/alertPolicies/16594654141392976482 and any other policies using this uptime check and try again."
      }
    ]
  }
}
```
問題を解決するには、合成モニターの結果をモニタリングするアラートポリシーを削除してから、合成モニターを削除します。

次のステップ