アラートポリシーを使用して SQL クエリの結果をモニタリングする

このドキュメントでは、オブザーバビリティ分析で実行したクエリの結果をモニタリングするアラートポリシーを作成する方法について説明します。これらのクエリは SQL で記述され、_AllSpans という名前のオブザーバビリティビューに対してクエリを実行する必要があります。アラートポリシーは、クエリ結果が指定した条件を満たしたときに通知します。

[オブザーバビリティ分析] ページから作成したアラートポリシーは、BigQuery エンジンで実行されます。したがって、クエリ対象のデータには、リンクされた BigQuery データセットからアクセスできる必要があります。

オブザーバビリティ分析の概要については、オブザーバビリティ分析でトレースのクエリと分析を行うをご覧ください。

アラートポリシーの仕組み

アラートポリシーでは、アラートを受け取る状況とインシデントの通知方法を記述します。トレースデータにコンテンツやパターンが検出されたときに通知を受け取るには、次の方法があります。

1 か月あたりの Cloud Trace 取り込みスパン数、割り当て使用量、スパン取り込み率をモニタリングするには、Cloud Monitoring でアラートポリシーを作成します。アラートポリシーを作成したことがない場合は、アラートポリシーを作成するで Cloud Monitoring コンソールに関する詳細をご覧ください。
個々のトレースやスパンを表示または調査したり、スパンにアタッチされている属性を表示したりするには、[Trace エクスプローラ] ページを使用します。このページの詳細については、トレースを検索して調査するをご覧ください。
トレースデータの集計分析をモニタリングするには、オブザーバビリティ分析とアラートポリシーを組み合わせます。このシナリオでは、SQL クエリを使用して、_Trace という名前のオブザーバビリティバケットの _AllSpans ビューに対してクエリを実行します。最後に、SQL クエリの結果をモニタリングするアラートポリシーを作成します。このタイプのアラートポリシーは、SQL ベースのアラートポリシーと呼ばれます。

トレースデータの保存方法について詳しくは、ストレージの概要をご覧ください。

このドキュメントの残りの部分では、SQL ベースのアラートポリシーの使用方法について説明します。

通知ポリシーのコンポーネント

SQL ベースのアラートポリシーには、条件とスケジュールが含まれます。

条件には、データにクエリを実行する SQL クエリであるクエリが含まれます。この条件では、クエリ結果が原因で Monitoring がインシデントを作成する状況も定義します。
スケジュールは、アラートポリシーがクエリを実行する頻度を定義します。スケジュールでは、ルックバックウィンドウのサイズも定義します。これは、クエリが前回評価されてから受信されたデータのみを選択するフィルタです。たとえば、スケジュールを 60 分に設定すると、クエリは 60 分ごとに実行され、直近 60 分間のデータを選択するルックバックウィンドウが使用されます。

アラートポリシーには、通知チャネルのリストも含まれています。アラートポリシーの条件が満たされると、Cloud Monitoring はインシデントを作成し、これらのチャネルを通じてインシデントに関する通知を送信します。インシデントは、条件が満たされた原因となったデータとその他の関連情報を記録したものです。この情報は、インシデントの原因となった問題のトラブルシューティングに役立ちます。インシデントは、 Google Cloud 　コンソールを使用して表示できます。

SQL ベースのアラートポリシーの評価タイプ

SQL クエリの結果をモニタリングする条件は、次の 2 種類の評価をサポートしています。

行数しきい値: クエリ結果の行数がしきい値の値より大きい場合、または同じか小さい場合に条件が満たされます。
ブール値: クエリ結果テーブルの特定のブール列に true の値を持つ行が含まれている場合、条件が満たされます。

SQL クエリの結果をモニタリングするアラートポリシーに含めることができる条件は 1 つだけです。

アラートポリシーと BigQuery

アラートポリシーでトレースデータにクエリを実行するには、リンクされた BigQuery データセットを構成する必要があります。リンクされたデータセットを使用すると、BigQuery はトレースデータを読み取り、SQL クエリから返されたデータに対して BigQuery 関数を実行できます。

アラートポリシーが SQL クエリを実行すると、そのクエリは、アラートポリシーが定義されているプロジェクトの Google Cloud BigQuery エンジンで実行されます。デフォルトでは、BigQuery エンジンで実行されるクエリはオンデマンドのスロットを使用します。オンデマンドスロットと予約スロットには、 BigQuery の料金が適用されます。

プロジェクトの専用 BigQuery スロット予約を構成することもできます。

専用スロットを使用して予約を作成するか、既存の予約を特定します。
プロジェクトの予約割り当てを作成します。

ルックバックウィンドウとインシデントの伝播時間

アラートポリシーの条件の評価がスケジュールされている場合、オブザーバビリティ分析は SQL クエリの実行を 5 分遅らせます。これは、Cloud Logging がルックバックウィンドウ中に受信したデータをインデックスに登録する時間を確保するためです。たとえば、アラートポリシーで午後 2 時に終了するルックバックウィンドウを使用している場合、オブザーバビリティ分析は午後 2 時 5 分まで SQL クエリを実行しません。

クエリの実行後にアラート条件が満たされた場合、インシデントがシステム全体に伝播するまでさらに最大 2 分かかることがあります。

クエリの失敗数

SQL ベースのアラートポリシーによって発行されたクエリは、次のようなさまざまな理由で失敗することがあります。

Monitoring サービスアカウントが存在しなくなったか、クエリ対象のトレースデータを読み取る権限がなくなった。
クエリの実行時間が 5 分を超えている。
内部エラーが発生する。

クエリが失敗すると、アラートポリシー ID とエラーステータスを含むログエントリが生成されます。ログベースのアラートポリシーを使用して、エラーがログに記録されたときにアラートを作成できます。

始める前に

このセクションでは、トレースデータのリンクされた BigQuery データセットがあることを前提としています。

SQL ベースのアラートポリシーを作成する前に、次の手順を行います。

トレースデータにクエリを実行して SQL ベースのアラートポリシーを作成するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。
- トレースデータにクエリを実行する: Cloud Trace ユーザー（roles/cloudtrace.user）
- SQL ベースのアラートポリシーを作成する:
  - モニタリング編集者（roles/monitoring.editor）
  - Logging SqlAlertWriter (roles/logging.sqlAlertWriter)
Monitoring サービスアカウントが存在し、次のロールが付与されていることを確認します。
1. プロジェクトに対する Monitoring サービスエージェント（roles/monitoring.notificationServiceAgent）。
2. リンクされたデータセットに対する BigQuery データ閲覧者（roles/bigquery.dataViewer）。
Monitoring サービスアカウントが存在しない場合は、トラブルシューティング: Monitoring サービスアカウントがないをご覧ください。
インシデントの通知の受信に使用する通知チャンネルを構成します。冗長性を確保するために、複数のタイプの通知チャンネルを作成することをおすすめします。詳細については、通知チャンネルを作成して管理するをご覧ください。

SQL ベースのアラートポリシーを作成する

SQL ベースのアラートポリシーを作成するには、次の操作を行います。

Google Cloud コンソール

コンソールで、 [ログ分析] ページに移動します。 Google Cloud
[ログ分析] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Logging] の結果を選択します。
[オブザーバビリティ分析] ページのクエリエディタで、トレースデータにクエリを実行する SQL クエリを入力します。
ツールバーで [BigQuery で実行] をクリックします。

オブザーバビリティ分析は BigQuery エンジンでクエリを実行し、結果を [結果] テーブルに表示します。

If [Run on BigQuery] isn't shown, then click [Select query engine] and then click [BigQuery].[クエリを実行] ボタンが [BigQuery で実行] に変わります。
[オブザーバビリティ分析] ページの [結果] 表で、 [アラートを作成] をクリックします。

[オブザーバビリティ分析] ページに [SQL アラートポリシーを作成] ウィンドウが表示されます。[SQL クエリ] セクションにクエリが表示されます。
[アラート条件] セクションで、アラートポリシーの条件とスケジュールを構成します。
アラートポリシーのアラートの詳細を構成します。
1. 通知チャンネルを追加し、カスタムの件名など、通知コンテンツを構成します。
2. 省略可: アラートポリシーのラベルとドキュメントを追加します。
3. [次へ] をクリックします。
アラートポリシーを確認し、[保存] をクリックして作成します。

Cloud Monitoring API

alertPolicies.create メソッドを使用して、アラートポリシーをプログラムで作成します。アラートポリシーの Condition タイプは MonitoringQueryLanguageConditionにする必要があります。これは SqlConditionのインスタンスです。この条件タイプを使用すると、アラートポリシーの条件を SQL で定義できます。

スケジュールを定義するには、minutes、hours、または days フィールドのいずれかに periodicity 値を設定します。たとえば、クエリを 12 時間ごとに実行する場合は、hours フィールドの周期を 12 に設定します。

条件を定義するには、次のフィールドを使用します。

boolean_test: クエリ結果テーブルのブール列の行に true 値が含まれている場合に条件が満たされるようにアラートポリシーを構成します。
row_count_test: クエリ結果テーブルの行数が特定のしきい値に達したときに条件が満たされるように、アラートポリシーを構成します。

フィールドと定義の一覧については、Cloud Monitoring API ドキュメントの SqlCondition をご覧ください。

アラートポリシー用の Monitoring API の詳細については、API によるアラートポリシーの管理をご覧ください。

Terraform

プロジェクトに Terraform をインストールして構成します。App Hub の構成には、App Hub ホストプロジェクトまたは管理プロジェクトを選択します。
Cloud Shell で、Terraform 構成を含むディレクトリに移動します。
Terraform 構成で、google_monitoring_alert_policy リソースのインスタンスを構成します（condition_sql など）。
Cloud Shell で、「terraform apply」と入力します。

アラートポリシーを変更するには、Terraform の構成を編集して再適用します。詳細については、Terraform でアラートポリシーを作成するをご覧ください。

Terraform で Google Cloud を使用する場合の一般的な情報については、 Google Cloudでの Terraform をご覧ください。

制限事項

SQL ベースのアラートポリシーごとに 1 つの条件を設定できます。

SQL ベースのアラートポリシーでは、アナリティクスビューをクエリできません。

SQL ベースのアラートポリシーによって発行されたクエリは、実行時間が 5 分を超えると失敗します。
クエリのスケジュール設定からインシデントの作成までには、最大 7 分の遅延とクエリの実行時間がかかります。

アラートポリシーに関連付けられている上限の一覧については、モニタリングの上限をご覧ください。

アラート ポリシーを使用して SQL クエリの結果をモニタリングする コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

アラート ポリシーの仕組み