本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
註釋可視化
本文件主題是針對支援 Grafana 10.x 版的 Grafana 工作區所設計。
如需支援 Grafana 9.x 版的 Grafana 工作區,請參閱。在 Grafana 第 9 版中工作
如需支援 Grafana 8.x 版的 Grafana 工作區,請參閱。在 Grafana 第 8 版中工作
註釋提供了一種在具有豐富事件的視覺效果上標記點的方法。它們在所有圖形面板上被視覺化為垂直線和圖標。當您將游標停留在註解上時,您可以取得事件說明和事件標籤。文字欄位可以包含更詳細的其他系統的連結。
您可以透過三種方式註解視覺效果:
-
直接在面板中,使用內置註釋查詢。
-
使用 Grafana HTTP API。
-
在儀表板設定中配置註釋查詢。
在前兩種情況下,您正在創建新的註釋,而在最後一個查詢來自數據源的現有註釋。內置註釋查詢也支持這一點。
本節說明第一個和第三個選項;如需有關使用 Grafana HTTP API 的詳細資訊,請參閱。註解 API
下列視覺化類型支援註釋:
-
時間序列
-
狀態時間軸
-
蠟燭圖
在面板中建立註釋
Grafana 具有使用所有儀表板上存在的內建註解查詢,直接從面板新增註解事件的功能。您以這種方式建立的註解會儲存在 Grafana 中。
若要直接在面板中新增註解:
-
儀表板必須已經儲存。
-
必須啟用內建查詢。
加入註釋的步驟
-
在管控面板中,選取要新增註釋的面板。將出現一個上下文菜單。
-
在關聯式功能表中,選取「加入註解」。
-
(選擇性) 新增註釋說明和標籤。
-
選取 Save (儲存)。
或者,要添加註釋,請在選擇面板時按下Ctrl
(或Cmd
),添加註釋彈出窗口將出現。
區域註釋
您也可以建立涵蓋視覺效果中某個區域或時間段的註釋。
加入面域註釋的步驟
-
在管控面板中選取嵌板區域時,按下
Ctrl
(或Cmd
)。 -
新增註解說明和標籤 (選用)。
-
按一下 Save (儲存)。
若要編輯註釋
-
在管控面板中,將游標懸停在面板上的註釋指示器上。
-
在註釋工具提示中選取「編輯」(鉛筆) 圖示。
-
修改描述和/或標籤。
-
選取 Save (儲存)。
若要刪除註釋
-
在管控面板中,將游標懸停在面板上的註釋指示器上。
-
在註釋工具提示中選取「刪除」(垃圾桶) 圖示。
透過儀表板設定擷取註釋
在儀表板設定中的「註釋」下,您可以新增查詢以使用任何資料來源 (包括內建資料註釋資料來源) 擷取註釋。註釋查詢會傳回可在儀表板上以圖形視覺化為事件標記的事件標記的事件。
加入新註解查詢的步驟
-
選取儀表板標題中的「設定」(齒輪) 圖示以開啟設定功能表。
-
選擇註記。
-
按一下新增註解查詢。
-
輸入註釋查詢的名稱。
這個名稱是給切換(複選框),這將允許您啟用顯示此查詢的註釋事件。
-
選取註釋的資料來源。
您也可以選擇 [開啟進階資料來源選擇器] 以查看更多選項,包括新增資料來源 (僅適用於管理員)。
-
如果您不想立即使用註解查詢,請清除「已啟用」核取方塊。
-
如果您不想在儀表板中顯示註釋查詢切換,請選取「隱藏」核取方塊。
-
選取事件標記的顏色。
-
在「顯示於」下拉式清單中,選擇下列其中一個選項:
-
所有面板 — 註釋會顯示在支援註釋的所有面板上。
-
所選面板 — 註釋會顯示在您選取的所有面板上。
-
除外的所有面板 — 註釋會顯示在除您選取的面板以外的所有面板上。
-
-
設定查詢。
每個資料來源的註解查詢選項都不同。如需有關特定資料來源中註釋的資訊,請參閱連線至資料來源。
內建查詢
加入註釋後,它們仍然可見。這是因為所有儀表板上都存在內建註解查詢。此註釋查詢將獲取源自當前儀表板的所有註釋事件,這些事件存儲在 Grafana 中,並將其顯示在創建它們的面板上。這包括警示狀態歷程記錄註釋。
根據預設,內建註解查詢會使用Grafana
特殊的資料來源,並且只有使用此資料來源才支援手動註解。您可以在內建註解查詢中使用其他資料來源,但您只能使用該資料來源的查詢編輯器建立自動註解。
若要直接將註釋新增至儀表板,必須啟用此查詢。
確認已啟用內建查詢
-
選取儀表板標題中的儀表板設定 (齒輪) 圖示,以開啟儀表板設定功能表。
-
選擇註記。
-
找到註釋和警報(內置)查詢。
如果查詢名稱前顯示 [已停用],則您需要選取查詢名稱以開啟該查詢並更新設定。
停止擷取和繪製註解的步驟
-
選取儀表板標題中的儀表板設定 (齒輪) 圖示,以開啟儀表板設定功能表。
-
選擇註記。
-
選取「註解與警示 (內建)」查詢。
-
選取「已啟用」切換開關以將其關閉。
當您使用「另存新檔」功能複製儀表板時,它會取得新的儀表板 ID,因此在來源儀表板上建立的註釋將不再顯示在副本上。如果您加入新的註釋查詢並依標籤篩選,您仍然可以顯示它們。但是,只有在來源儀表板上的註釋具有要篩選的標籤時,這才有效。
依標籤篩選查詢
您可以透過將「篩選條件」設定為,建立新查詢以使用Grafana
資料來源從內建註解查詢擷取註釋Tags
。
例如,建立註解查詢名稱outages
並指定標籤outage
。此查詢將顯示帶有outage
標籤的所有註釋(從任何儀表板或通過 API)。如果在註釋查詢中定義了多個標籤,則 Grafana 將僅顯示符合所有標籤的註釋。若要修改行為,請啟用「符合任何」,Grafana 就會顯示包含您提供之任何一個標籤的註解。
您也可以在標籤查詢中使用範本變數。這表示如果您有顯示不同服務統計資料的儀表板,以及指定要顯示哪些服務的範本變數,您可以在註解查詢中使用相同的範本變數,只顯示這些服務的註解。