合成モニターを管理する

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

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

準備

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

    ロールの付与の詳細については、アクセスの管理をご覧ください。

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

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

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

コンソール

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

返されるデータには、次の対象が含まれます。

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

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 というラベルの付いたフィールドが含まれます。

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

コンソール

Google Cloud プロジェクトで合成モニターの詳細を表示するには、次の手順を行います。

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

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

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

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

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

gcloud

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

gcloud monitoring uptime describe CHECK_ID

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

稼働時間チェックで返されるデータには次のものがあります。

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

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 Functions の関数を編集する

コンソール

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

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

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

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

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

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

    無効なリンク チェッカーの場合は、送信元の URI またはテストするリンクを定義するオプションを変更するには、Cloud Functions の関数を編集し、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 に置き換えます。識別子を確認するには、gcloud monitoring uptime list-configs コマンドを実行して、[名前] フィールドを調べます。詳細については、稼働時間チェックの一意の識別子を確認するをご覧ください。

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

    • 期間
    • Display name
    • タイムアウト
    • ユーザーラベル

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

gcloud monitoring uptime update CHECK_ID --period=10

API

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

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

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

コンソール

Google Cloud プロジェクトで合成モニターをコピーするには、次の操作を行います。

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

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

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

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

    [Synthetic Check] ダイアログが開きます。Cloud Function のコピーなどのフィールドが事前入力されています。

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

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

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

gcloud

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

API

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

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

合成モニターを削除する

コンソール

合成モニターと関連するアラート ポリシーを削除するには、次の手順を行います。

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

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

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

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

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

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

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

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

gcloud

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

gcloud monitoring uptime delete CHECK_ID

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

API

合成モニターと関連するアラート ポリシーを削除するには、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 メソッドのレスポンスに含まれます。

次のステップ