アラート: Pub/Sub トピックへの稼働時間チェック

1. はじめに

最終更新日: 2023 年 6 月 21 日

可用性の稼働時間チェックに関するアラート

稼働時間チェックに関するアラートを使用すると、サービスに影響する可能性のある問題を迅速に特定して解決できます。サービス停止のアラートを受け取ることで、ユーザーや顧客への影響を最小限に抑えるための対策を講じることができます。

アップタイムチェックは間隔を置いて行われます。最短の間隔は 60 秒です。60 秒を超える粒度が必要な場合は、ログベースのアラートを通じてエラーコードを動的イベントとしてモニタリングすることも、可用性の追加の指標として役立ちます。60 秒以上の間隔が許容される場合は、稼働時間チェックを使用すると、追加の構成をほとんど行わずにサービスを簡単に測定できます。

サービスが利用できない場合、トラフィックがなくても稼働時間チェックで問題が検出されます。一方、トラフィックは、メンテナンスやアップグレードなどの要因だけでなく、悪天候やスポーツイベントなど、システムの外部要因によっても影響を受ける可能性があります。

アップタイムチェックを使用するタイミングの詳細については、Google Cloud リソースのアップタイムを確保するをご覧ください。

アラート通知チャネルとしての Pub/Sub トピック

Pub/Sub トピックは、Google Cloud Monitoring 通知チャンネルとして使用して、Pub/Sub サブスクリプションにアラートを送信できます。これにより、Cloud Monitoring アラートをサードパーティの通知サービスなどの他のシステムと統合できます。

Pub/Sub トピックを通知チャンネルとして使用するには、まず Pub/Sub トピックと Pub/Sub サブスクリプションを作成する必要があります。次に、Pub/Sub トピックを宛先として使用する Cloud Monitoring 通知チャンネルを作成する必要があります。

アラートがトリガーされると、Cloud Monitoring は Pub/Sub トピックにメッセージを送信します。Pub/Sub サブスクリプションのサブスクライバーは、メッセージを処理して適切な措置を講じることができます。

作成するアプリの概要

この Codelab では、アプリをデプロイし、Pub/Sub トピックを作成し、Pub/Sub トピックを通知チャネルとして使用するアプリの稼働時間チェックアラートを作成します。

学習内容

Pub/Sub トピックを作成する方法
稼働時間チェックとアラートを作成する方法

この Codelab では、稼働時間チェックのアラートを作成する方法について説明します。関連のない概念とアプリケーションコードについては軽く触れるにとどめ、そのままコピーして貼り付けられるようにしています。

必要なもの

次の権限を持つ Google Cloud アカウント。
Cloud Run アプリケーションをデプロイする
Pub/Sub トピックを作成する
稼働時間チェックを作成する
アラートを作成する

2. 設定方法

Google Cloud プロジェクトを選択または作成する

既存のプロジェクトを選択するには、プルダウンを使用します。

Google Cloud で新しいプロジェクトを作成する手順は次のとおりです。

Google Cloud Platform Console に移動します。
[プロジェクトを作成] ボタンをクリックします。
プロジェクトの名前を入力します。
プロジェクトの請求先アカウントを選択します。
[作成] ボタンをクリックします。

プロジェクトが作成され、プロジェクトダッシュボードが表示されます。これで、Google Cloud サービスの使用を開始できます。

各ステップの詳細は次のとおりです。

名前: プロジェクト名は組織内で一意である必要があります。
請求先アカウント: 既存の請求先アカウントを使用することも、新しいアカウントを作成することもできます。
作成: 必要な情報をすべて入力したら、[作成] ボタンをクリックしてプロジェクトを作成します。

詳細については、プロジェクトの作成に関する Google Cloud のドキュメントをご覧ください。

3. API アプリケーションをデプロイする

サンプルアプリケーションまたは API の概要

このアプリケーションは、在庫アイテムのリストと特定のアイテムの在庫数を取得する 2 つのオペレーションで REST API エンドポイントを公開するシンプルな Inventory API アプリケーションです。

API をデプロイし、https://<somehost> でホストされていると仮定すると、次のように API エンドポイントにアクセスできます。

https://<somehost>/inventory

これにより、在庫レベルがわかるすべての商品アイテムが一覧表示されます。

https://<somehost>/inventory/{productid}

これにより、その商品の productid と手持ち在庫レベルを含む単一のレコードが提供されます。

返されるレスポンスデータは JSON 形式です。

注: この API アプリケーションはデモ専用であり、安全で堅牢な API 実装を表すものではありません。このラボの主な目的である Google Cloud Operations を理解するために、すぐに利用できるアプリケーションを用意することを目的としています。

サンプルデータと API リクエスト/レスポンス

簡単にするため、このアプリはバックエンドのデータベースで動作していません。これには、3 つの商品 ID のサンプルと、その在庫レベルが含まれています。

製品 ID	手持ち在庫レベル
I-1	10
I-2	20
I-3	30

API リクエストとレスポンスの例を以下に示します。

API リクエスト	API レスポンス
https://<somehost>/inventory	[ { "I-1": 10, "I-2": 20, "I-3": 30 }]
https://<somehost>/inventory/I-1	{ "productid": "I-1", "qty": 10}
https://<somehost>/inventory/I-2	{ "productid": "I-2", "qty": 20}
https://<somehost>/inventory/I-200	{ "productid": I-200, "qty": -1}

リポジトリのクローンを作成する

Google Cloud はノートパソコンからリモートで操作できますが、この Codelab では、Google Cloud Shell（Cloud 上で動作するコマンドライン環境）を使用します。

GCP Console で右上のツールバーにある Cloud Shell アイコンをクリックします。

プロビジョニングと環境への接続にはそれほど時間はかかりません。完了すると、次のように表示されます。

この仮想マシンには、必要な開発ツールがすべて用意されています。永続的なホームディレクトリが 5 GB 用意されており、Google Cloud で稼働します。そのため、ネットワークのパフォーマンスと認証機能が大幅に向上しています。このラボでの作業はすべて、ブラウザから実行できます。

gcloud を設定する

Cloud Shell でプロジェクト ID を設定し、PROJECT_ID 変数として保存します。

PROJECT_ID=[YOUR-PROJECT-ID]

gcloud config set project $PROJECT_ID

次のコマンドを実行します。

$ git clone https://github.com/rominirani/cloud-code-sample-repository.git

これにより、このフォルダに cloud-code-sample-repository というフォルダが作成されます。

（省略可）Cloud Shell でアプリケーションを実行する

次の手順に沿って、アプリケーションをローカルで実行します。

ターミナルから、次のコマンドを使用して API の Python バージョンに移動します。

$ cd cloud-code-sample-repository

$ cd python-flask-api

ターミナルで次のコマンドを入力します（このドキュメントの作成時点では、Cloud Shell に Python 3.9.x がインストールされており、デフォルトバージョンを使用します）。ノートパソコンでローカルに実行する場合は、Python 3.8 以上を使用できます。

$ python app.py

次のコマンドを実行して、Python サーバーをローカルで起動できます。

[ポート 8080 でプレビュー] をクリックします。5. ブラウザウィンドウが開きます。404 エラーが表示されますが、問題ありません。URL を変更して、ホスト名の後に /inventory だけが続くようにします。

たとえば、私のマシンでは次のようになります。

https://8080-cs-557561579860-default.cs-asia-southeast1-yelo.cloudshell.dev/inventory

これにより、前述のように在庫アイテムのリストが表示されます。

ターミナルに移動して Ctrl+C キーを押すと、サーバーを停止できます。

アプリケーションをデプロイする

この API アプリケーションを Cloud Run にデプロイします。このプロセスでは、gcloud コマンドラインクライアントを使用して、コードを Cloud Run にデプロイするコマンドを実行しました。

ターミナルから、次の gcloud コマンドを実行します。

$ gcloud run deploy --source .

このツールでは複数の質問が表示されます。以下に、その一部を示します。

サービス名（python-flask-api）: このデフォルトを使用するか、my-inventory-api などの名前を選択します。
API [run.googleapis.com] not enabled on project [613162942481]. 有効にして再試行しますか？（数分かかります）(y/N)? Y
リージョンを指定してください: 31（us-west-1）を選択します。
API [artifactregistry.googleapis.com] not enabled on project [613162942481]. 有効にして再試行しますか？（数分かかります）(y/N)? Y
ソースからデプロイするには、ビルドされたコンテナを保存する Artifact Registry Docker リポジトリが必要です。リージョン [us-west1] に [cloud-run-source-deploy] という名前のリポジトリが作成されます。
Do you want to continue (Y/n)? Y
Allow unauthenticated invocations to [my-inventory-api] (y/N)? Y

最終的に、このプロセスが開始され、ソースコードが取得されてコンテナ化され、Artifact Registry に push されてから、Cloud Run サービスとリビジョンがデプロイされます。このプロセスには 3 ～ 4 分かかることがあります。プロセスが完了すると、サービスの URL が表示されます。

実行例を以下に示します。

アプリケーションをテストする

アプリケーションを Cloud Run にデプロイしたので、次のように API アプリケーションにアクセスできます。

前の手順で取得したサービス URL をメモします。たとえば、私の設定では https://my-inventory-api-bt2r5243dq-uw.a.run.app と表示されます。これを <SERVICE_URL> とします。
ブラウザを開き、API エンドポイントの次の 3 つの URL にアクセスします。
<SERVICE_URL>/inventory
<SERVICE_URL>/inventory/I-1
<SERVICE_URL>/inventory/I-100

これは、前のセクションで API リクエストとレスポンスのサンプルとともに提供した仕様に準拠している必要があります。

Cloud Run からサービスの詳細を取得する

API サービスをサーバーレスコンピューティング環境である Cloud Run にデプロイしました。Google Cloud コンソールから Cloud Run サービスにいつでもアクセスできます。

メインメニューから Cloud Run に移動します。これにより、Cloud Run で実行されているサービスのリストが表示されます。デプロイしたサービスが表示されます。選択した名前に応じて、次のような画面が表示されます。

[サービス名] をクリックして、詳細を表示します。サンプルの詳細は次のとおりです。

URL は、ブラウザに入力して、デプロイしたばかりの Inventory API にアクセスできるサービス URL です。指標などの詳細を確認します。

それでは、Google Cloud Operations Suite から始めましょう。

4. アラート通知を受信する Pub/Sub トピックを作成する

Pub/Sub トピックを作成するには、Google Cloud コンソールで次の手順を行います。

検索ボックスで Pub/Sub を検索し、Pub/Sub に移動します。
[トピック] タブをクリックします（まだクリックしていない場合）。
[トピックを作成] ボタンをクリックします。
トピックの名前を入力します。

[作成] ボタンをクリックします。
コピーアイコンボタンを使用して、トピック名をコピーします。これは次のセクションで必要になります。

5. 稼働時間チェックを作成する

Google Cloud Run アプリケーションの稼働時間チェックを作成するには:

Google Cloud Platform Console に移動します。
[モニタリング] タブをクリックします。
[稼働時間チェック] タブをクリックします。
ページの上部にある [アップタイムチェックを作成] ボタンをクリックします。

次の値を使用します。
プロトコル : HTTPS
リソースの種類 : URL
ホスト名 : Cloud Run サービス URL の一部を https なしで入力します。以下の画面に例を示します。サービス URL がわからない場合は、メインの Google Cloud コンソールから Cloud Run に移動し、前述のように Cloud Run サービスの詳細に移動して、サービス URL を取得します。
パス : healthy
確認頻度: 1 分

[続行] をクリックする
[コンテンツマッチングが有効] をオンにする
[Response Content] に「All Izz Well」と入力します。この文字列は、完全なレスポンスを送信するときにアプリケーションにすでに含まれています。
Keep

[許容される HTTP レスポンスコード] を [レスポンスコードクラス] に設定し、[2xx] を唯一のレスポンスコードクラスとして設定します。これにより、2xx のレスポンスコードのみが文字列に対して評価され、それ以外のものは自動的にチェック失敗とカウントされます。
[続行] をクリックする
通知チャネルとして Cloud Pub/Sub トピックを選択し、[OK] をクリックします。