本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
連線至 ServiceNow 資料來源
這是用於連線至 ServiceNow 執行個體的 ServiceNow 資料來源。
注意
此資料來源僅適用於 Grafana Enterprise。如需詳細資訊,請參閱管理企業外掛程式的存取。
此外,在支援第 9 版或更新版本的工作區中,此資料來源可能會要求您安裝適當的外掛程式。如需詳細資訊,請參閱使用外掛程式擴展您的工作區。
功能
-
查詢
-
Stat API 查詢
-
資料表 API 查詢
-
事件、變更和任何其他資料表
-
-
-
Alerts (提醒)
-
註釋 (測試版功能)
-
範本變數
組態
選取 Grafana 左側面板上的資料來源。
選取新增資料來源:
輸入 servicenow 以尋找資料來源外掛程式:
輸入 ServiceNow URL:
選擇儲存並測試。您應該會看到綠色訊息,其中包含「ServiceNow Connection OK」。
範例儀表板
預先製作的儀表板包含在外掛程式中,可以透過儀表板索引標籤下的資料來源組態頁面匯入。
用量
有兩種方式可在查詢編輯器中傳回資料。
-
TableAPI
-
AggregateAPI
使用者目前可以選擇查詢預先定義的資料表,如下所示:
-
變更
-
事故
或者,從 開始v1.4.0,使用其他 (自訂資料表) 選項的 API 驅動資料表和欄位清單。此選項可讓您查詢使用者可用於設定 ServiceNow 資料來源之任何資料表中的資料。
自訂資料表選項應支援與預先定義資料表清單相同的所有功能。
TableAPI 查詢
TableAPI 會傳回適合在資料表面板中顯示的資料。它允許按順序選擇欄位,以顯示加上篩選選項。查詢編輯器也提供 欄位,以限制查詢傳回的資料列數。
顯示上一個查詢結果的範例資料表面板。
Show
顯示列為要顯示的欄位提供選擇器。您也可以指定多個欄位。欄位將以指定的確切順序傳回。
顯示值
顯示值旗標將導致查詢傳回人性化的值,或顯示小精靈,而不是數值。
例如,1沒有此旗標的 嚴重性只會顯示 1。如果啟用 旗標,顯示的值將為 1 - High。
根據 ServiceNow API 文件
注意
【...】 指定顯示值可能會導致效能問題,因為它不會直接從資料庫讀取,並且可能包括參考其他欄位和記錄。
篩選條件 (一般)
篩選條件列可讓您根據多個欄位和值條件縮小顯示的資料列範圍。
所有篩選條件都會與 AND 或 OR 操作結合。
下列欄位在不使用自訂資料表時可用 (此清單將在未來展開)。
Active Asset Group Assigned To Escalation Issue Number Description Priority State Type Change Risk Change State Start Date End Date On Hold
選取自訂資料表時,會自動從 Service Now API 填入欄位。
日期篩選條件
| 時間欄位 | 運算子 | Value |
|---|---|---|
| 開啟時間 | 今天或之前 今天不在 之前或之後 | 時間戳記 javascript:gs.daysAgo(30) |
| 活動到期 | ||
| 關閉時間 | ||
| 到期日 | ||
| 預期開始 | ||
| 重新開啟的時間 | ||
| 在 解決 | ||
| 工作結束 | ||
| 工作開始 | ||
| 忽略時間 |
如需其他日期值,請參閱:https://https://developer.servicenow.com/app.do#!/api_doc?v=newyork&id=r_SGSYS-dateGenerate_S_S
運算子 (一般、字串型)
-
開頭為
-
Ends With
-
類似
-
不喜歡
-
等於
-
不等於
-
Is Empty
運算子 (以時間為基礎)
-
今天
-
不是今天
-
之前
-
在 或之前
-
After
-
在 或之後
值
值選擇取決於選取的篩選條件類型。
-
布林值篩選條件具有 True/False 選項
-
文字篩選條件將允許輸入任何值
-
升級、優先順序具有一組固定的數值
排序依據
排序依據資料列可根據多個欄位和值條件縮小顯示的資料列範圍。
所有篩選條件都會與 AND 操作結合。將新增對其他運算子的支援。
限制
您可以指定資料列限制,以防止傳回過多的資料。預設值為 25。
時間欄位
Time Field 會將您查詢的資料轉換為時間序列。以時間序列處理的資料表示不會顯示所選「時間欄位」中不在儀表板/面板時間範圍內的值。
使用的預設時間欄位是「開啟時間」,但可以變更為保留時間值的任何可用欄位。
提供特殊值「忽略時間」,以允許結果「直到現在為止」,也允許篩選條件控制顯示的資料。
AggregateAPI 查詢 (統計資料)
AggregateAPI 一律會傳回具有下列彙總的指標:avg、min、max、 sum。篩選也可用於縮小查詢範圍。
Show
顯示列為要顯示的指標提供選擇器。您也可以指定多個指標。
篩選條件 (一般)
彙總篩選條件可根據欄位和值條件縮小顯示的指標範圍,類似於資料表選項。
所有篩選條件都會與 AND 操作結合。將新增對其他運算子的支援。
Stat 篩選條件選項與 TableAPI 相同。
聚合
指標彙總有四種類型,加上「計數」:
-
平均數
-
下限
-
最大
-
總和
-
計數 - 這會傳回查詢傳回的指標的 "number"
分組依據
此選擇器可讓您將指標分割為較少的彙總。依「優先順序」分組會傳回優先順序為「標籤」的指標,並將唯一值分開。
範本化
您可以在其位置使用變數,而不是硬式編碼查詢中的名稱。變數會在儀表板頂端顯示為下拉式清單選取方塊。您可以使用這些下拉式方塊來變更儀表板上顯示的資料。
請參閱查詢變數區段中有關如何新增查詢變數並參考具有範本值的範例。
查詢變數
如果您新增類型 的範本變數Query,您可以撰寫查詢,以傳回顯示為下拉式清單選取方塊的項目,例如類別名稱、索引鍵名稱或索引鍵值。
例如,您可以在範本變數查詢設定中categories指定這類查詢,以擁有包含 所有值的變數。
選擇查詢設定時,會顯示篩選條件區段,讓您選擇類型和欄位。目前,類型僅限於事件和變更。選取類型時,您會收到適用於該類型的欄位清單。選取類型和欄位後,底部會顯示值的預覽,顯示該類型/欄位可用的選項。這些值會顯示在儀表板的下拉式清單中,您可以搭配範本來篩選儀表板上的資料。
例如,如果您新增名為 的變數類別,然後選取類型 = 事件和欄位 = 類別,您會看到類別的選項清單。如果您接著將篩選條件新增至面板,然後選取類別等於 ${category},則面板資料只會顯示從儀表板下拉式清單中選取的該類別的資料。
匯入依類別分類的事件儀表板以查看範例。
在查詢中使用變數
有兩種語法:
$<varname> 範本變數名為 的範例hostname:
[[varname]] 範本變數名為 的範例hostname:
提醒
支援標準 Grafana 警示。圖形面板中定義的任何查詢都可以用來產生提醒。
以下是查詢和提醒的範例。此查詢將傳回所有開放關鍵高優先順序事件的圖表:
當有超過五個開啟的重大高優先順序事件時,將會啟動此提醒:
測試提醒規則會顯示提醒規則的輸出,而選取狀態歷史記錄會顯示提醒從 ok 轉換為待定,再轉換為提醒。
圖形檢視會顯示垂直線,當警示處於待定狀態時,頂端的心形圖示會變成橘色。
一旦符合提醒條件,規則就會轉換為紅色。
在圖形檢視中,紅色垂直線將出現,頂端的心圖示將變為紅色。
撰寫警示的事件
Beta 功能
-
為您的 ServiceNow 資料來源設定通知管道。
這將設定 Grafana 通知管道
此動作需要 ServiceNow 資料來源使用者具有寫入事件的許可。
註釋
Grafana 註釋是截至此資料來源v1.4.0的 Beta 版功能。註釋可讓您在圖形上疊加事件。
註釋查詢支援與標準查詢編輯器相同的選項,但有一些細微差異:
-
只能選取一個「顯示」欄。這可能會在未來的改善中修正。
-
時間欄位為必要欄位。
常見問答集
如果我們沒有 ITSM 角色外掛程式該怎麼辦?
需要管理員存取權才能執行下列動作
選項 1:授予 Grafana 使用者管理員許可,以允許存取所有資料表。
選項 2:建立角色並將 ACLs 套用至 Grafana 必須存取的所有資料表。
需要管理員存取權才能執行下列動作。
-
登入的管理員需要提升對 security_admin 的存取。
-
在右上角導覽窗格中,選擇設定檔圖示。設定檔圖示具有下拉式插入符號。
-
從下拉式清單中,選擇升級角色。
-
從顯示的模態中,選取 security_admin 核取方塊。
-
選擇確定。
-
-
使用您想要的任何命名慣例建立新的角色。
-
導覽至左側導覽系統安全性 => 使用者和群組 => 角色中的角色區段
-
在頂端選擇新增。
-
輸入角色的名稱和相關描述。
-
選擇提交。
-
-
建立新的使用者或修改具有所需角色的現有使用者。
-
您在步驟 2 中建立的角色
-
personalize_dictionary
-
personalize_choices
-
cmdb_read (這會授予所有 cmdb 資料表的讀取存取權)
-
-
為必要的資料表和欄位建立資料表 ACLs。
-
為 sys_db_object 資料表建立 ACL。
-
在第二個搜尋標頭資料欄名稱中,輸入
sys_db_object,然後按 Enter。 -
篩選的結果應該會顯示資料表。選擇資料表以導覽至記錄。
-
在索引標籤區段中,選擇控制項。
-
在頁面的下半部,確定存取控制是選取的索引標籤。
-
選擇新增以建立新的 ACL。
-
變更要讀取的操作選擇。
-
在畫面下方的需要角色區段中,選擇 (按兩下) 插入新資料列,然後搜尋您建立的角色。
-
選取您建立的角色之後,請選擇綠色核取記號。
-
在畫面下方選擇提交以建立 ACL,然後在模態出現時選擇繼續。
-
-
-
針對特定 sys_db_object 欄位建立 ACLs。必須針對下列每個欄位重複下列步驟:名稱、標籤、顯示名稱和延伸資料表。
-
當仍在 sys_db_object 的資料表記錄檢視上時,請選取最接近畫面頂端之標籤群組中的資料欄標籤。
-
找到欄位名稱並選取它。
-
在下方索引標籤區段中,選擇存取控制索引標籤上的新增。
-
將 操作變更為讀取
-
選擇 (按兩下) 在底部「需要角色」資料表中插入資料列文字。
-
搜尋您建立的角色,然後選擇綠色核取記號。
-
選擇提交。
-
請確定您已針對所有必要欄位重複這些步驟:名稱、標籤、顯示名稱和延伸資料表。
-
-
在變更、事件和任何其他您想要從 Grafana 查詢的非 CMDB 資料表上重複 4.1 中的步驟。請勿重複 4.2 中的步驟;該步驟僅適用於 sys_db_object。