このドキュメントでは、Google Cloud コンソール、Google Cloud CLI、Cloud Monitoring API、クライアント ライブラリを使用して稼働時間チェックを管理する方法について説明します。
すべての稼働時間チェックを一覧表示する
Console
-
Google Cloud コンソールで、 [稼働時間チェック] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
次の例は、サンプルの [稼働時間チェック] ページを示しています。
(省略可)表示される稼働時間チェックを制限するには、フィルタを追加します。
各フィルタは、名前と値で構成されています。値は稼働時間チェック名の完全一致または部分一致に設定できます。一致結果では大文字と小文字は区別されません。たとえば、名前に
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
稼働時間チェックと合成モニターを一覧表示するには、projects.uptimeCheckConfigs.list
メソッドを呼び出します。次のパラメータを指定します。
parent: 稼働時間チェックのリストを取得する対象のプロジェクト。書式は次のとおりです。
projects/PROJECT_ID
特定の稼働時間チェックを取得するには、projects.uptimeCheckConfigs.get
メソッドを呼び出します。次のパラメータを指定します。
name: 稼働時間チェック構成の完全な名前。
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
稼働時間チェック ID の詳細については、稼働時間チェックの一意の識別子を確認するをご覧ください。
C#
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
PHP
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
稼働時間チェックの詳細を表示する
Console
-
Google Cloud コンソールで、 [稼働時間チェック] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
表示する稼働時間チェックを見つけて、その名前をクリックします。
次のスクリーンショットは、「My Uptime Check」という名前の稼働時間チェックの稼働時間の詳細を示しています。
[稼働時間の詳細] ページには以下の情報が含まれます。
- 選択した時間間隔。デフォルトの間隔は 1 時間です。
- 稼働時間チェックの名前。この例では、チェックの名前は My Uptime Check です。
- 稼働時間チェックに追加したラベル。
稼働率と平均レイテンシ。[Percent uptime] の値は、
(S/T)*100
として計算されるパーセンテージです。ここで、S
は成功したチェック レスポンスの数で、T
は、すべてのロケーションからのチェック レスポンスの合計数です。グループ チェックの場合、S
およびT
の値は、現在のすべてのグループ メンバーにわたって合計されます。たとえば、すべてのリージョンで 1 分間の稼働時間チェックを 25 分間にわたって実行すると、6 つのロケーションそれぞれから 25 件のリクエストが取得されるため、合計で 150 件のリクエストになります。また、ダッシュボードで 83.3% の稼働時間がレポートされた場合、150 件のリクエストのうち 125 件が成功したことを意味します。
[Passed checks] と [Uptime check latency] ペインには、渡されたチェックの数と各チェックのレイテンシを時間の関数としてグラフで表示します。
[Current status] ペインには、最新のチェックのステータスが表示されます。リージョンの隣にあるチェックマークのついた緑色の丸は、そのリージョンで最後に実行されたチェックが成功したことを示します。バツ印のついた赤い丸は失敗を示します。
[Configuration] ペインに、稼働時間チェックの構成が表示されます。このデータは、稼働時間チェックの作成時に割り当てられます。[Check Id] の値は、API 呼び出しの
CHECK_ID
値に対応しています。[アラート ポリシー] ペインには、関連するアラート ポリシーの情報が表示されます。このサンプル ダッシュボードでは、1 つのアラート ポリシーが構成されています。
gcloud
稼働時間チェックまたは合成モニターの詳細を一覧参照するには、gcloud monitoring uptime describe
コマンドを実行します。
gcloud monitoring uptime describe CHECK_ID
前述のコマンドを実行する前に、CHECK_ID を稼働時間チェックまたは合成モニターの ID に置き換えます。ID を確認するには、gcloud monitoring uptime list-configs
コマンドを実行して name フィールドを確認します。詳細については、稼働時間チェックの固有識別子を確認するをご覧ください。
稼働時間チェックで返されるデータには、次の情報が含まれます。
- 名前と表示名
- ID を確認します。
- モニタリング対象リソース
- チェックの間隔。
API
稼働時間チェックまたは合成モニターの詳細を一覧参照するには、projects.uptimeCheckConfigs.get
メソッドを呼び出します。次のパラメータを指定します。
name: 稼働時間チェック構成の完全な名前。
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
稼働時間チェック ID の詳細については、稼働時間チェックの一意の識別子を確認するをご覧ください。
C#
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
PHP
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
稼働時間チェックの編集
稼働時間チェックの一部は変更できます。たとえば、チェックの頻度を増やす場合や、レスポンスの検証に関連するタイムアウトを増やす場合などです。ただし、稼働時間チェックで正しいプロトコル、リソースタイプ、リソースが構成されていない場合は、現在の稼働時間チェックを削除して新しい稼働時間チェックを作成します。
稼働時間チェックをモニタリングするアラート ポリシーを編集する方法については、次のドキュメントをご覧ください。
公開稼働時間チェックを編集するには、次のいずれかのタブでプロセスを使用できます。非公開稼働時間チェックを編集するには、[コンソール] または [API] タブを使用します。
Console
-
Google Cloud コンソールで、 [稼働時間チェック] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
編集する稼働時間チェックを見つけ、次のいずれかの操作を行います。
- クリック[その他] をクリックしてmore_vert、[編集] を選択します。
- 稼働時間チェックの詳細を表示し、[Edit] をクリックします。
必要に応じてフィールドの値を変更します。一部のフィールドは変更できません。チェックのカスタム ヘッダーの値が非表示になっている場合は、表示できません。
チェックが動作するかどうかを確認するには、[テスト] をクリックします。テストが失敗した場合は、チェックの失敗を参照して考えられる原因を特定します。
[保存] をクリックします。
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
projects.uptimeCheckConfigs.patch
メソッドを呼び出します。メソッドのパラメータを次のように設定します。
uptimeCheckConfig.name: 必須。これは REST URL の一部で、編集する稼働時間チェックのリソース名です。
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
稼働時間チェック ID の詳細については、稼働時間チェックの一意の識別子を確認するをご覧ください。
updateMask: 任意。これは次のようなクエリ パラメータになります。
?updateMask=[FIELD_LIST]
[FIELD_LIST]
には、変更するUptimeCheckConfig
オブジェクト内のフィールドをカンマ区切りのリストとして指定します。次に例を示します。"resource.type,httpCheck.path"
リクエスト本文には、新しいフィールド値を指定した
UptimeCheckConfig
を含める必要があります。
updateMask
が設定されている場合は、updateMask
にリストされたフィールドについてのみ、既存構成の対応するフィールドが置換されます。サブフィールドが存在するフィールドについては、フィールド マスクのリストにフィールドだけ含まれ、サブフィールドが含まれていない場合でも、そのフィールド値に応じてサブフィールドの値が適宜置き換えられます。
updateMask
が設定されていない場合、リクエスト本文中の構成が既存の構成全体と置き換わります。
patch
メソッドは、変更後の構成が反映された UptimeCheckConfig
オブジェクトを返します。
C#
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
PHP
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
新しい稼働時間チェックの結果が表示されるまでに最大 5 分の遅延が発生する可能性があります。その間は、変更前の稼働時間チェックの結果がダッシュボードに表示され、アラート ポリシーで使用されます。
稼働時間チェックの削除
モニタリング対象のサービスまたはリソースを停止する場合は、稼働時間チェックを削除することをおすすめします。注: 稼働時間チェックを削除する前に、稼働時間チェックをモニタリングするアラート ポリシーがないことを確認してください。アラート ポリシーで稼働時間チェックがモニタリングされると、Google Cloud コンソールでは稼働時間チェックの削除が防止されます。ただし、Cloud Monitoring API では、エラーは生成されないか、削除が防止されません。存在しないチェックに対し、インシデントは作成されません。
稼働時間チェックを削除するには、次の手順に従います。
Console
-
Google Cloud コンソールで、 [稼働時間チェック] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
編集する稼働時間チェックを見つけ、次のいずれかの操作を行います。
- [その他] をクリックしてmore_vert、[削除] を選択します。
- 稼働時間チェックの詳細を表示して、[Delete] をクリックします。
gcloud
稼働時間チェックまたは合成モニターを削除するには、gcloud monitoring uptime delete
コマンドを実行します。
gcloud monitoring uptime delete CHECK_ID
前述のコマンドを実行する前に、CHECK_ID を稼働時間チェックまたは合成モニターの ID に置き換えます。ID を確認するには、gcloud monitoring uptime list-configs
コマンドを実行して name フィールドを確認します。詳細については、稼働時間チェックの固有識別子を確認するをご覧ください。
API
稼働時間チェックまたは合成モニターを削除するには、projects.uptimeCheckConfigs.delete
メソッドを呼び出します。パラメータを次のように設定します。
name: 必須。削除する稼働時間チェック構成のリソース名を次の書式で指定します。
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
稼働時間チェック ID の詳細については、稼働時間チェックの一意の識別子を確認するをご覧ください。
C#
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
PHP
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Monitoring への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
稼働時間チェックをモニタリングする
稼働時間チェックが失敗したときに通知するアラート ポリシーを作成することをおすすめします。詳細については、稼働時間チェックのアラート ポリシーを作成するをご覧ください。
稼働時間チェックの一意の識別子を確認する
稼働時間チェックが作成されると、Monitoring によって識別子が割り当てられます。この識別子は稼働時間チェック ID と呼ばれています。この ID は稼働時間チェックのリソース名に埋め込まれます。
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
稼働時間チェック ID は、稼働時間チェックを作成または一覧表示する Cloud Monitoring API メソッドのレスポンスに含まれます。稼働時間チェック ID は、Google Cloud コンソールの [稼働時間の詳細] ページの [構成] ペインにも表示されます。[稼働時間の詳細] ページを表示する方法については、このドキュメントの稼働時間チェックの詳細を表示するをご覧ください。