說明文件範本中的變數

這個頁面說明可在與快訊政策相關聯的說明文件範本中使用的變數與管道特定控制項。

使用變數

除了 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] 指標標籤的值 key1
policy.user_label.[KEY] 使用者標籤的值 key1,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] 資源標籤的值 key1

1 例如,${resource.label.zone} 會取代為 zone 標籤的值。
2 政策中的使用者標籤只能使用 Monitoring API 設定。

附註:

  • 系統僅支援表格中的變數。您無法將這些變數合併為更複雜的運算式,像是 ${varname1 + varname2}

  • 如要將文字字串 ${ 包含在您的說明文件中,請使用一個 $ 符號逸出另一個 $ 符號,且 $${ 會以 ${ 形式顯示在您的說明文件中。

使用管道控制項

說明文件欄位中的文字也可以包含通知管道本身使用的特殊字元,以控制格式設定與通知。

例如,Slack 會將 @ 用於提及,您可以使用該符號來將通知連結至特定使用者。假設您在文件說明欄位中包含如下的字串:

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

相關 Slack 管道收到說明文件欄位做為通知的一部分時,這一行會向使用者 backendoncall 觸發其他訊息,例如 policy High CPU rate of change triggered an incident

這些額外選項是管道特有的選項;如要進一步瞭解可能提供的選項,請參閱管道廠商提供的說明文件。

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Stackdriver Monitoring
需要協助嗎?請前往我們的支援網頁