本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
本文件主題專為支援 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
。此查詢會顯示標籤的所有註釋 (來自任何儀表板或透過 API)outage
。如果在註釋查詢中定義了多個標籤,則 Grafana 只會顯示符合所有標籤的註釋。若要修改行為,請啟用任何相符,Grafana 會顯示包含您提供之任何標籤的註釋。
您也可以在標籤查詢中使用範本變數。這表示如果您有一個儀表板顯示不同服務的統計資料,以及指定要顯示哪些服務的範本變數,則可以在註釋查詢中使用相同的範本變數,只顯示這些服務的註釋。