合成モニターを管理する

このドキュメントでは、合成モニターを管理する方法について説明します。合成モニターのリストを表示でき、合成モニターごとに構成の表示と変更、実行履歴の表示、各実行の詳細の表示を行うことができます。合成モニターは、Google Cloud コンソールまたは Cloud Monitoring API を使用して管理できます。

合成モニターの実行結果と、指標とログを確認する方法については、合成モニターの結果を調べるをご覧ください。

始める前に

• Google Cloud コンソールを使用して合成モニターを表示して変更するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールの付与を管理者に依頼してください。

  • モニタリング編集者（roles/monitoring.editor）
  • Cloud Functions デベロッパー（roles/cloudfunctions.developer）

  ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

  必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

• このページの API の手順は、API Explorer を対象としています。しかし、curl コマンドを発行することもできます。API Explorer には curl 構文が用意されています。

合成モニターを一覧表示する

Console

Google Cloud プロジェクトの合成モニターを一覧表示する手順は次のとおりです。

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

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

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

2. 省略可: 一覧表示される合成モニターを制限するには、フィルタを追加します。

   各フィルタは、名前と値で構成されています。値は、合成モニタリングの名前に完全に一致するように設定することも、部分一致するように設定することもできます。一致結果では大文字と小文字は区別されません。たとえば、名前に default を含むすべての合成モニターを一覧表示するには、次の操作を行います。

   • [表をフィルタリング] をクリックし、[表示名] を選択します。
   • default と入力して、Return キーを押します。

   複数のフィルタがある場合、OR フィルタを挿入しない限り、論理 AND によって自動的に結合されます。上記の例では、OR フィルタを使用して、名前が default または Testing check と一致した場合に、稼働時間チェックが表示されるようにしています。

[合成モニター] ページには、合成モニターごとに次の情報が表示されます。

• 直近の実行のステータス。
• その合成モニターに関する詳細情報へのリンク。
• 成功率と平均実行時間。
• アラート ポリシーの数。
• 合成モニターを編集、コピー、削除したり、アラート ポリシーを作成したりするには、 [その他のオプション] メニューを使用します。

gcloud

稼働時間チェックと合成モニターを一覧表示するには、gcloud monitoring uptime list-configs コマンドを実行します。

gcloud monitoring uptime list-configs

返されるデータには次の情報が含まれます。

• 名前と表示名
• ID を確認します。
• モニタリング対象リソース
• チェックの間隔。

結果にフィルタを適用して並べ替えるよう Google Cloud CLI コマンドを構成できます。

API

稼働時間チェックなど、Google Cloud プロジェクト内の合成モニターを一覧表示するには、projects.uptimeCheckConfigs.list メソッドを呼び出します。

1. projects.uptimeCheckConfigs.list をクリックします。

2. API Explorer を使用します。

   メソッドの 親 をプロジェクトの名前に設定します。必ず次の形式を使用してください。

   projects/PROJECT_ID
   

   前の式で、PROJECT_ID は Google Cloud プロジェクト ID です。

合成モニターの場合、結果には syntheticMonitor というラベルの付いたフィールドが含まれます。

合成モニターの詳細を表示する

Console

Google Cloud プロジェクトの合成モニターの詳細を表示する手順は次のとおりです。

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

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

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

2. [合成モニターの詳細] ページを開くには、表示する合成モニターを見つけて、その名前をクリックします。

   Cloud Run 関数が提供する [関数の詳細] ページから Cloud Run の関数を表示するには、[コード] タブを選択してから、関数の名前をクリックします。[関数の詳細] ページが新しいウィンドウで開きます。このページのタブでは、指標、ログ、構成情報を表示できます。

gcloud

稼働時間チェックまたは合成モニターの詳細を一覧表示するには、gcloud monitoring uptime describe コマンドを実行します。

gcloud monitoring uptime describe CHECK_ID

前述のコマンドを実行する前に、CHECK_ID を稼働時間チェックまたは合成モニターの ID に置き換えます。ID を確認するには、gcloud monitoring uptime list-configs コマンドを実行して name フィールドを確認します。詳細については、合成モニターの固有識別子を確認するをご覧ください。

稼働時間チェックで返されるデータには、次の情報が含まれます。

• 名前と表示名
• ID を確認します。
• モニタリング対象リソース
• チェックの間隔。

API

Google Cloud プロジェクトの特定の合成モニターの詳細を一覧表示するには、projects.uptimeCheckConfigs.get メソッドを呼び出します。

1. projects.uptimeCheckConfigs.get をクリックします。

2. API Explorer を使用します。

   メソッドの 親 を合成モニターの ID に設定します。次の形式を使用してください。

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
   

   前の式で、PROJECT_ID は Google Cloud プロジェクト ID、CHECK_ID は合成モニター ID です。

   たとえば、親フィールドの値は次のようになります。

   projects/my-project/uptimeCheckConfigs/10863117100295372627
   

   projects.uptimeCheckConfigs.list メソッドを発行すると、CHECK_ID の値を確認できます。返される結果の数を減らすには、フィルタを設定します。たとえば、フィルタ displayName="MySyntheticMonitor" を追加します。

合成モニターまたは Cloud Run 関数を編集する

Console

注: Cloud Run 関数のみを変更する場合は、[関数の詳細] ページまたは [合成モニターの詳細] ページを使用できます。どちらの場合も、編集オプションを選択して変更を加え、変更した Cloud Run 関数をデプロイする必要があります。

[合成モニターの詳細] ページを使用して、合成モニターまたはその Cloud Run 関数を編集するには、次の操作を行います。

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

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

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

2. 編集する合成モニターを見つけて、 [その他のオプション] をクリックし、[編集] を選択します。

3. 省略可: Cloud Run 関数を編集するには、[関数を編集] をクリックして変更を加え、[関数を適用] をクリックします。

   無効なリンク チェッカーの場合、元の URI またはテストするリンクを定義するオプションを変更するには、Cloud Run 関数を編集し、index.js ファイルの options オブジェクトを更新します。このオブジェクトのフィールドと構文については、broken-links-ok/index.js をご覧ください。

4. 変更を維持するには、[保存] をクリックします。解除しない場合は、[キャンセル] をクリックします。

gcloud

稼働時間チェックまたは合成モニターを変更するには、gcloud monitoring uptime update コマンドを実行します。

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS

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

• CHECK_ID は、稼働時間チェックまたは合成モニターの ID に置き換えます。ID を確認するには、gcloud monitoring uptime list-configs コマンドを実行して name フィールドを確認します。詳細については、稼働時間チェックの固有識別子を確認するをご覧ください。

• 変更するフィールドを定義します。合成モニターの場合は、次のフィールドのみを更新できます。

  • 期間
  • 表示名
  • タイムアウト
  • ユーザーラベル

たとえば、合成モニターの期間を 10 分に設定するには、次のコマンドを実行します。

gcloud monitoring uptime update CHECK_ID --period=10

API

アラート ポリシーと関数は合成モニターに含まれていないため、このセクションで説明する手順で編集することはできません。

• アラート ポリシーを変更するには、Google Cloud コンソールを使用するか、alertPolicies.patch メソッドを呼び出します。詳細については、API によるアラート ポリシーの管理をご覧ください。

• Cloud Run 関数を変更するには、関数ソースを更新した後に関数を再デプロイする必要があります。詳細については、Cloud Run 関数 をデプロイするをご覧ください。

合成モニターを編集するには、projects.uptimeCheckConfigs.patch メソッドを呼び出します。

1. projects.uptimeCheckConfigs.patch をクリックします。

2. API Explorer を使用します。

   1. メソッドの 親 を合成モニターの ID に設定します。次の形式を使用してください。

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
      

      前の式で、PROJECT_ID は Google Cloud プロジェクト ID、CHECK_ID は合成モニター ID です。

      projects.uptimeCheckConfigs.list メソッドを発行すると、CHECK_ID の値を確認できます。返される結果の数を減らすには、フィルタを設定します。たとえば、フィルタ displayName="MySyntheticMonitor" を追加します。

   2. メソッドのクエリ パラメータ updateMask を設定して、オブジェクト内の変更するフィールドを特定します。たとえば、displayName の値を更新する場合、クエリ パラメータは次のようになります。

      updateMask=displayName
      

合成モニターをコピーする

Console

Google Cloud プロジェクトで合成モニターをコピーする手順は次のとおりです。

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

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

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

2. 編集する合成モニターを見つけて、 [その他のオプション] をクリックし、[コピー] を選択します。

   [合成チェックのコピー] ダイアログが開きます。ダイアログには、Cloud Run 関数のコピーなどのフィールドが事前入力されています。

3. [関数を作成] をクリックし、必要に応じて関数を更新して、[関数を適用] をクリックします。

4. 変更を維持するには、[作成] をクリックします。解除しない場合は、[キャンセル] をクリックします。

   [作成] をクリックすると、Cloud Run 関数が作成されてデプロイされ、合成モニターが作成されます。

gcloud

合成モニターをコピーできる Google Cloud CLI メソッドはありません。

API

合成モニターをコピーできる API メソッドはありません。ただし、次の手順を行うことでコピーを作成できます。

1. projects.uptimeCheckConfigs.get メソッドを呼び出してレスポンスを保存します。詳細については、合成モニターの詳細を表示するをご覧ください。
2. 応答文を編集します。
3. projects.uptimeCheckConfigs.create メソッドを呼び出し、編集したレスポンスをメソッドに渡します。

合成モニターを削除する

Console

注: Google Cloud コンソールを使用して稼働時間チェックまたは合成モニターを削除すると、関連するアラート ポリシーも削除されます。ただし、合成モニターを削除しても Cloud Run 関数は削除されません。

合成モニターと、関連するアラート ポリシーを削除する手順は次のとおりです。

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

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

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

2. 削除する合成モニターを見つけて、名前をクリックします。

3. 省略可: Cloud Run 関数を削除する場合は、[コード] タブを選択してから、関数の名前をクリックします。[関数の詳細] ページが新しいウィンドウで開きます。

4. 合成モニターの詳細ページをクリックし、[削除] をクリックして、ダイアログを完了します。

   これで、合成モニターが削除されました。

5. Cloud Run 関数を削除するには、[関数の詳細] ページに移動し、 [削除] をクリックして、ダイアログを完了します。

gcloud

注: 稼働時間チェックまたは合成モニターに関連付けられたアラート ポリシーがある場合、Google Cloud CLI または Cloud Monitoring API を使用して稼働時間チェックまたは合成モニターを削除することはできません。まず、アラート ポリシーを削除する必要があります。合成モニターを削除しても、Cloud Run 関数は削除されません。

稼働時間チェックまたは合成モニターを削除するには、gcloud monitoring uptime delete コマンドを実行します。

gcloud monitoring uptime delete CHECK_ID

前述のコマンドを実行する前に、CHECK_ID を稼働時間チェックまたは合成モニターの ID に置き換えます。ID を確認するには、gcloud monitoring uptime list-configs コマンドを実行して name フィールドを確認します。詳細については、合成モニターの固有識別子を確認するをご覧ください。

API

注: 稼働時間チェックまたは合成モニターに関連付けられたアラート ポリシーがある場合、Google Cloud CLI または Cloud Monitoring API を使用して稼働時間チェックまたは合成モニターを削除することはできません。まず、アラート ポリシーを削除する必要があります。合成モニターを削除しても、Cloud Run 関数は削除されません。

合成モニターと関連するアラート ポリシーを削除するには、projects.uptimeCheckConfigs.delete メソッドを呼び出します。

1. projects.uptimeCheckConfigs.delete をクリックします。

2. API Explorer を使用します。

   メソッドの 親 を合成モニターの ID に設定します。次の形式を使用してください。

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
   

   前の式で、PROJECT_ID は Google Cloud プロジェクト ID、CHECK_ID は合成モニター ID です。

   projects.uptimeCheckConfigs.list メソッドを発行すると、CHECK_ID の値を確認できます。返される結果の数を減らすには、フィルタを設定します。たとえば、フィルタ displayName="MySyntheticMonitor" を追加します。

合成モニターの固有識別子を確認する

合成モニターが作成されると、Monitoring によって ID が割り当てられます。この ID は、合成モニターのリソース名に埋め込まれ、次の形式で指定されます。

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

CHECK_ID は、合成モニターを作成または一覧表示する Google Cloud CLI と Cloud Monitoring API メソッドのレスポンスに含まれています。

次のステップ

• 合成モニターを作成する
• 合成モニターの結果を調べる