應用程式檔案
可以透過實作本主題中概述的 JSON 範例內提供的結構來建立應用程式 JSON 檔案。
如果要使用 Insight Pack Tooling,則可以在 Insight Pack 專案內於子資料夾 src-files/unity_apps/apps 中建立應用程式 JSON 檔案。
為應用程式檔案定義的參數如下:
- name
- 指定應用程式檔案的名稱。這是 .app 檔案的名稱,顯示在「搜尋」工作區的「自訂搜尋儀表板」窗格中。
- type
- (選用)如果適用,請指定所使用範本的名稱。您在此欄位中指定的名稱為不含副檔名的範本檔案名稱。
- description
- 指定應用程式的用途。
- customLogic
- 指定 Script 的詳細資料(包括任何參數),並概述要顯示的輸出詳細資料。這些參數是針對 customLogic 定義的:
- script
- 指定您要執行的 Script 的名稱。Script 可以是 Python 或 Shell Script,或者是包裝成可執行 Jar 檔的 Java™ 應用程式。如果要使用範本,則所執行的 Script 必須與範本位於相同的目錄。如果不使用範本,請將 Script 儲存在與應用程式檔案相同的目錄中。
- description
- 提供 Script 的說明。
- timeout
- (選用)指定多長時間之後(以秒為單位)停止 自訂搜尋儀表板 發出的搜尋查詢。這個基於應用程式的參數沒有預設值。
- parameters
- 請完成遞送給 Script 的參數的 JSON 陣列。該陣列可以為空。您所遞送的參數基於您所執行的 Script 的需求。在範例中的第一組參數內,會遞送搜尋查詢的參數。
- output
- 本節概述了您要針對 自訂搜尋儀表板 顯示的輸出本質。
- type
- 指定 Data 作為此參數的值。
- visualization
- 新增 dashboard 或 searchFilters 作為此參數的子參數。這能夠決定當您執行 自訂搜尋儀表板 時所顯示的內容。
- dashboard 需要您指定所建立之儀表板的佈置。在 Dashboard 參數下,新增 columns 子參數並指定數值以指示您需要的欄數。
- 新增 chart 作為 dashboard 參數的附加子參數,並新增 JSON 物件陣列來指示您儀表板中要包含的圖表。僅包含有效的圖表類型,也包含每一個圖表的必要參數。如需相關資訊,請參閱本文件的圖表區段。
- searchFilters 參數是針對搜尋過濾器應用程式的,需要 relationalQuery 作為輸入參數。關聯式查詢是由 JSON 索引鍵組成的 JSON 物件:如需相關資訊,請參閱搜尋過濾器應用程式。
儀表板視覺化範例
本範例參照 ExecuteSearchWithParameters.py Script,並根據 chartdata01 資料集中的資料指定泡泡圖。chartdata01 資料集 ID 是在 ExecuteSearchWithParameters.py Script 中定義的,並在圖表規格中參照。
"name": "Search Results from python script- Parameters",
"type": "SearchApps",
"description": "Captures long running queries in maximo logs",
"customLogic": {
"script": "ExecuteSearchWithParameters.py",
"description": "View chart on search results",
"timeout":
"parameters": [
{
"name": "search",
"type": "SearchQuery",
"value": {
"start": 0,
"results": 10,
"filter": {"range": {"timestamp": {"from":
"12/03/2012 22:21:58.000 India Standard Time",
"to": "12/03/2013 22:21:58.000 India Standard Time",
"dateFormat": "dd/MM/yyyy HH:mm:ss.SSS Z" }}},
"logsources": [{"type": "tag","name": "*"}],
"query": "*"
}
},
{
"name": "url",
"type": "String",
"value": "http: //9.118.41.71: 9988/Unity/"
}
],
"output": {
"type": "Data",
"visualization": {
"dashboard": {
"columns": 1,
"charts": [
{
"type": "Bubble Chart",
"title": "Severity against Time",
"data": {"$ref": "chartdata01"},
"parameters": {"xaxis": "timestamp","yaxis": "severity"}
}
]
}
} } } }