合成モニターを管理する

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

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

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

始める前に

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

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

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

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

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

  • 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

      In the Google Cloud console, activate Cloud Shell.

      Activate Cloud Shell

      At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

      REST

      このページの REST API サンプルをローカル開発環境で使用するには、gcloud CLI に指定した認証情報を使用します。

        After installing the Google Cloud CLI, initialize it by running the following command:

        gcloud init

        If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      詳細については、 Google Cloud 認証ドキュメントの REST を使用して認証するをご覧ください。

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

コンソール

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

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

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

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

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
  3. 省略可: 一覧表示される合成モニターを制限するには、フィルタを追加します。

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

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

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

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

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

gcloud

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

gcloud monitoring uptime list-configs --project=PROJECT_ID

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

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

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

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

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

REST

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

  1. projects.uptimeCheckConfigs.list をクリックします。
  2. API Explorer を使用します。

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

    projects/PROJECT_ID
    

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

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

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

コンソール

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

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

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

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

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
  3. [合成モニターの詳細] ページを開くには、表示する合成モニターを見つけて、その名前をクリックします。

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

gcloud

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

gcloud monitoring uptime describe CHECK_ID --project=PROJECT_ID

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

  • PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
  • CHECK_ID: 稼働時間チェックまたは合成モニターの ID。ID を確認するには、gcloud monitoring uptime list-configs コマンドを実行して name フィールドを確認します。詳細については、合成モニターの固有識別子を確認するをご覧ください。

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

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

REST

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

  1. projects.uptimeCheckConfigs.get をクリックします。
  2. API Explorer を使用します。

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

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
    

    上の式で:

    • PROJECT_ID は Google Cloud のプロジェクト ID です。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
    • CHECK_ID は、合成モニターの ID です。

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

    projects/my-project/uptimeCheckConfigs/10863117100295372627
    

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

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

コンソール

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

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

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

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

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
  3. 編集する合成モニターを見つけて、その他のオプション)をクリックし、[編集] を選択します。
  4. 省略可: Cloud Run functions の関数を編集するには、[関数を編集] をクリックして変更を加え、[関数を適用] をクリックします。

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

  5. 変更を維持するには、[保存] をクリックします。それ以外の場合は、[キャンセル] をクリックします。

gcloud

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

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS --project=PROJECT_ID

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

  • PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
  • CHECK_ID: 稼働時間チェックまたは合成モニターの ID。ID を確認するには、gcloud monitoring uptime list-configs コマンドを実行して name フィールドを確認します。詳細については、稼働時間チェックの固有識別子を確認するをご覧ください。

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

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

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

gcloud monitoring uptime update CHECK_ID --period=10 --project=PROJECT_ID

REST

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

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

  1. projects.uptimeCheckConfigs.patch をクリックします。
  2. API Explorer を使用します。

    1. メソッドの を合成モニターの ID に設定します。ID は次の形式になります。

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
      

      上の式で:

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

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

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

      updateMask=displayName
      

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

コンソール

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

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

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

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

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
  3. 編集する合成モニターを見つけて、その他のオプション)をクリックし、[コピー] を選択します。

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

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

  5. 変更を維持するには、[作成] をクリックします。それ以外の場合は、[キャンセル] をクリックします。

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

gcloud

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

REST

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

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

合成モニターを削除する

コンソール

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

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

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

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

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
  3. 削除する合成モニターを見つけて、名前をクリックします。

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

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

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

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

gcloud

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

gcloud monitoring uptime delete CHECK_ID  --project=PROJECT_ID

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

  • PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
  • CHECK_ID: 稼働時間チェックまたは合成モニターの ID。ID を確認するには、gcloud monitoring uptime list-configs コマンドを実行して name フィールドを確認します。詳細については、合成モニターの固有識別子を確認するをご覧ください。

REST

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

  1. projects.uptimeCheckConfigs.delete をクリックします。
  2. API Explorer を使用します。

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

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
    

    上の式で:

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

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

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

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

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

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

次のステップ