ドキュメント テンプレートの変数

このページでは、アラート ポリシーに関連付けられているドキュメント テンプレートで使用可能な変数とチャネル固有のコントロールについて説明します。

変数の使用

Markdown に加えて、${varname} 形式の変数を使用してドキュメントの内容を調整できます。ドキュメントが通知とともに送信されるときに、文字列 ${varname} は varname の値に置き換えられます。次のスクリーンショットは、ドキュメントの追加で説明しているドキュメント テンプレートから作成されたメール通知に含まれるドキュメントを示しています。

ドキュメント フィールドで使用できる変数は次のとおりです。

変数	値
condition.name	条件の REST リソース名（例: projects/foo/alertPolicies/1234/conditions/5678）
condition.display_name	条件の表示名（例: CPU usage increasing rapidly）
metric.type	指標タイプ（例: compute.googleapis.com/instance/cpu/utilization）
metric.display_name	指標タイプの表示名（例: CPU utilization）
metric.label.[KEY]	指標ラベル key の値^1
policy.user_label.[KEY]	ユーザーラベル key の値^1、2
policy.name	ポリシーの REST リソース名（例: projects/foo/alertPolicies/1234）
policy.display_name	ポリシーの表示名（例: High CPU rate of change）
project	ワークスペースのプロジェクト ID（例: a-gcp-project）
resource.project	アラート ポリシーのモニタリング対象リソースのプロジェクト ID
resource.type	モニタリング対象リソースのタイプ（例: api）
resource.label.[KEY]	リソースラベル key の値^1

¹ たとえば、${resource.label.zone} は zone ラベルの値に置き換えられます。
² ポリシーのユーザーラベルは、Monitoring API を使用してのみ設定できます。

注:

• 表に記載している変数のみがサポートされています。${varname1 + varname2} ような、より複雑な式に組み合わせることはできません。

• リテラル文字列 ${ をドキュメントに含めるには、$ 記号を 2 つ目の $ 記号でエスケープします。$${ はドキュメントでは ${ としてレンダリングされます。

チャネル コントロールの使用

ドキュメント フィールド内のテキストには、通知チャネル自体がフォーマットや通知を制御するために使用する特殊文字を含めることもできます。

たとえば、Slack では @ が使用されます。これを使用して、通知を特定のユーザーにリンクできます。ドキュメント フィールドに次のような文字列を含めているとします。

<@backendoncall> policy ${policy.display_name} triggered an incident

このドキュメント フィールドが、関連する Slack チャネルによって通知の一部として受信されると、この行によって、ユーザー backendoncall への追加メッセージ（例: policy High CPU rate of change triggered an incident）がトリガーされます。

これらの追加オプションはチャネルに固有です。利用可能な追加オプションの詳細については、チャネル ベンダーが提供しているドキュメントをご覧ください。