本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
範本參考
本文件主題是針對支援 Grafana 9.x 版的 Grafana 工作區所設計。
如需支援 Grafana 10.x 版的 Grafana 工作區,請參閱。在 Grafana 第 10 版工作
如需支援 Grafana 8.x 版的 Grafana 工作區,請參閱。在 Grafana 第 8 版中工作
本節提供建立範本的參考資訊。
範本資料
下列資料會傳遞至訊息範本。
名稱 | Type | 備註 |
---|---|---|
|
string |
要傳送通知的聯絡點名稱。 |
|
string |
如果至少有一個警報正在觸發,則觸發,否則解決。 |
|
警示 |
包含在此通知中的警示物件清單 (請參閱下方)。 |
|
KeyValue |
這些警示的標籤依據分組。 |
|
KeyValue |
此通知中包含之所有警示的通用標籤。 |
|
KeyValue |
此通知中包含的所有警示的通用註釋。 |
|
string |
返回鏈接到發送通知的 Grafana。如果使用外部警報管理器,請返回此警報管理器的鏈接。 |
該Alerts
類型公開了兩個函數,用於過濾返回的警報。
-
Alerts.Firing
— 傳回觸發警示的清單。 -
Alerts.Resolved
— 傳回已解決警示的清單。
警示 (類型)
警示類型包含下列資料。
名稱 | Type | 備註 |
---|---|---|
Status |
string |
|
標籤 |
KeyValue |
附加至警示的一組標籤。 |
註釋 |
KeyValue |
附加至警示的一組註釋。 |
值 | KeyValue | 所有運算式的值,包括傳統條件 |
StartsAt |
時間. 時間 |
警報開始發射的時間。 |
EndsAt |
時間. 時間 |
僅在已知警示結束時間時才設定。否則,請設定為自上次收到警示之後的可設定逾時期間。 |
生成器網址 |
string |
一個反向鏈接到 Grafana 或外部警報管理器。 |
沉默網址 |
string |
將警示設為靜音的連結 (已預先填入此警示的標籤)。僅適用於 Grafana 管理的警示。 |
儀表板 |
string |
鏈接到圖標儀表板,如果警報規則屬於一個。僅適用於 Grafana 管理的警示。 |
面板網址 |
string |
如果警示規則屬於一個,則連結至圖標面板。僅適用於 Grafana 管理的警示。 |
指紋 |
string |
可用於識別警示的指紋。 |
ValueString |
string |
包含警示中每個減少運算式的標籤和值的字串。 |
ExtendedData
該 ExtendedData 對象包含以下屬性。
名稱 | Kind | 描述 | 範例 |
---|---|---|---|
接收器 |
|
傳送通知的聯絡點名稱。 |
|
Status |
|
狀態為 |
|
Alerts (提醒) |
|
此通知中所有觸發和已解決警示的清單。 |
|
射擊警報 |
|
此通知中所有觸發警示的清單。 |
|
已解決警示 |
|
此通知中所有已解決警示的清單。 |
|
GroupLabels |
|
群組這些警示的標籤整合他的通知。 |
|
CommonLabels |
|
此通知中所有警示通用的標籤。 |
|
CommonAnnotations |
|
此通知中所有警示通用的註釋。 |
|
外部網址 |
|
傳送此通知之 Grafana 工作區或警示管理員的連結。 |
|
KeyValue 類型
該KeyValue
類型是一組代表標籤和註釋的鍵/值字符串對。
除了直接訪問存儲為數據KeyValue
,還有用於排序,刪除和轉換數據的方法。
名稱 | 引數 | 傳回值 | 備註 | 範例 |
---|---|---|---|---|
SortedPairs |
鍵和值字符串對的排序列表 |
|
||
Remove (移除) |
[] 字符串 |
KeyValue |
返回沒有給定鍵的鍵/值映射的副本。 |
|
名稱 |
[] 字符串 |
標籤名稱清單 |
|
|
值 |
[] 字符串 |
標籤值清單 |
|
Time (時間)
時間來自 Go time
Monday, 1st January 2022 at 10:00AM
,您可以撰寫下列範本:
{{ .StartsAt.Format "Monday, 2 January 2006 at 3:04PM" }}
您可以在
模板函數
使用範本函數,您可以處理標籤和註釋以產生動態通知。以下是可用的功能。
名稱 | 引數類型 | 傳回類型 | 描述 |
---|---|---|---|
|
數字或字串 |
string |
使用度量前置詞,將數字轉換為更易讀的格式。 |
|
數字或字串 |
string |
喜歡人性化,但使用 1024 作為基礎,而不是 1000。 |
|
數字或字串 |
string |
將持續時間 (以秒為單位) 轉換為更易讀的格式。 |
|
數字或字串 |
string |
將比率值轉換為 100 的分數。 |
|
數字或字串 |
string |
以秒為單位的 Unix 時間戳轉換為更易讀的格式。 |
|
string |
string |
字符串。標題,大寫每個單詞的第一個字符。 |
|
string |
string |
字符串。 ToUpper,將所有字元轉換為大寫。 |
|
string |
string |
字符串。 ToLower,將所有字元轉換為小寫。 |
|
圖案,文字 |
Boolean |
正則表達式。 MatchString 測試未錨定正則表達式匹配。 |
|
圖案取代文字 |
string |
正則表達式。 ReplaceAllString 正則表達式替換,未錨定。 |
|
字符串-JSON 對象 |
string |
針對指定的運算式和資料來源,傳回 Explore 中圖形檢視的路徑。 |
|
字符串-JSON 對象 |
string |
針對指定的運算式和資料來源,傳回 Explore 中表格檢視的路徑。 |
|
[] 介面 {} |
映射 [字符串] 接口 {} |
將物件清單轉換為具有索引鍵的地圖,例如 arg0, arg1。使用此函數可將多個引數傳遞給模板。 |
|
什麼都沒有 |
string |
返回表示外部 URL 的字符串。 |
|
什麼都沒有 |
string |
返回外部 URL 的路徑。 |
下表顯示使用每個函數的範例。
函式 | TemplateString | 輸入 | 預期 |
---|---|---|---|
人性化 |
{人性化 $ 值} |
1234567.0 |
米 |
人文化 |
{人性化 1024$ 值} |
1048576.0 |
1 米 |
人性化 |
{人性化 $ 值} |
899.99 |
十四米 |
人性百分比 |
{人性百分比 $ 值} |
0.1234567 |
12.35% |
人性化時間戳 |
{人性化時間戳 $ 值} |
1435065584.128 |
2015-06-23 世界標準時間 13:44.128 |
標題 |
{$ 值 | 標題} |
bB 抄送 |
AA BB 抄送 |
toUpper |
{$ 值 | toUpper} |
bB 抄送 |
BB 抄送 |
toLower |
{$ 值 | toLower} |
bB 抄送 |
BB 抄送 |
match |
{匹配「A +」$ 標籤。實例} |
aa |
true |
reReplaceAll |
{{ reReplaceAll 「本地主機 :( .*)」「我的域名:$1」$ 標籤。實例}} |
本地主機: |
我的. 網域名稱:3000 |
圖形連結 |
{{圖形連結「{\" EXPR\」:\ "向上\」,\ "資料來源\」:\ "gdev-Prometheus\"}」}} |
/探索? 左 = [「現在 -1 小時」,「現在」,「gdev-Prometheus」,{「數據源」:「gdev-Prometheus」,「EXPR」:「向上」,「即時」:假,「範圍」:真}] |
|
表格連結 |
{{表格連結「{\" EXPR\」:\ "向上\」,\ "資料來源\」:\ "gdev-Prometheus\"}」}} |
/探索? 左 = [「現在 -1 小時」,「現在」,「gdev-Prometheus」,{「數據源」:「gdev-Prometheus」,「EXPR」:「向上」,「即時」:真,「範圍」:假}] |
|
args |
{{定義 "x"}} {{.arg0}} {{結束} {模板「x」(參數 1「2」)}} |
1 2 |
|
外部網址 |
{外部網址} |
http://localhost/path/prefix |
|
路徑前綴 |
{路徑前綴} |
/路徑/前綴 |