Log Service警示監控規則的資料結構 - Simple Log Service

本文介紹警示監控規則的資料結構。

Alert

欄位	資料類型	是否必填	說明
name	String	是	警示監控規則ID。在URL中展示。
displayName	String	是	警示監控規則名稱。在警示列表中展示。
status	String	否	警示監控規則的狀態。取值如下： Enabled（預設值）：啟用。 Disabled：禁用。
type	String	是	固定為Alert。
description	String	否	相容欄位，設定為空白字串即可。
schedule	Schedule	是	檢查頻率相關的配置。更多資訊，請參見Schedule。
configuration	Configuration	是	警示監控規則的詳細配置。更多資訊，請參見Configuration。

Schedule

欄位	資料類型	是否必填	說明
type	String	是	檢查頻率類型，Log Service根據您配置的頻率對查詢和分析結果進行檢查。取值如下： FixedRate：按照固定間隔檢查查詢和分析結果。 Cron：通過Cron運算式指定時間間隔，按照指定的時間間隔檢查查詢和分析結果。 Weekly：在周幾的某個固定時間點檢查一次查詢和分析結果。 Daily：在每天的某個固定時間點檢查一次查詢和分析結果。 Hourly：每小時檢查一次查詢和分析結果。
interval	String	否	時間間隔，例如5m、1h。當type被設定為FixedRate時，必須設定interval。
cronExpression	String	否	Cron運算式，最小精度為分鐘，24小時制。例如`0 0/1 * * *`，表示從00:00開始，每隔1小時檢查一次。當type被設定為Cron時，必須設定cronExpression。
dayOfWeek	Integer	否	可選值為0~6，分別表示周日到周六。當type被設定為Weekly時，必須設定dayOfWeek。
hour	Integer	否	可取值為0~23，分別表示每個小時。當type被設定為Weekly或Daily時，必須設定hour。
runImmediately	Boolean	否	建立警示監控規則後，是否立即執行。

Configuration

欄位	資料類型	是否必填	說明
version	String	是	固定為2.0。
type	String	是	固定為default。
dashboard	String	否	警示歷史儀錶盤。建議設定為internal-alert-analysis。
queryList	AlertQuery	是	查詢統計列表。
groupConfiguration	GroupConfiguration	是	分組評估配置。更多資訊，請參見GroupConfiguration。
joinConfigurations	[]JoinConfiguration	否	集合操作配置。更多資訊，請參見JoinConfiguration。如果queryList中只有一項查詢統計，則不需要設定joinConfigurations。如果queryList中有2~3個查詢統計，則必須設定joinConfigurations，用於關聯多個查詢分析結果。更多資訊，請參見設定查詢統計語句。
severityConfigurations	[]SeverityConfiguration	是	觸發條件，至少設定一條觸發條件。更多資訊，請參見SeverityConfigurations。
labels	[]Tag	否	標籤。更多資訊，請參見Tag。
annotations	[]Tag	否	標註。更多資訊，請參見Tag。
autoAnnotation	Boolean	是	是否開啟自動添加標註。 true（預設）：開啟自動添加標註功能，系統自動在警示中添加__count__等資訊。更多資訊，請參見自動標註。 false：關閉自動添加標註功能。
sendResolved	Boolean	否	是否發送恢複通知。 true：警示恢複時，觸發一條恢複警示。更多資訊，請參見設定恢複通知。 false（預設）：關閉警示恢複通知功能。
threshold	Integer	是	設定連續觸發閾值。當累計的觸發次數達到該值時，產生一條警示。不滿足觸發條件時不計入統計。
noDataFire	Boolean	否	無資料是否觸發警示。 true：如果查詢和分析的結果（有多個時，進行集合操作後的結果）為無資料的次數超過連續觸發閾值，則產生一條警示。更多資訊，請參見無資料警示。 false（預設）：關閉無資料警示功能。
noDataSeverity	Integer	否	無資料觸發警示時的警示嚴重度。更多資訊，請參見警示嚴重度。
policyConfiguration	PolicyConfiguration	是	警示策略配置。更多資訊，請參見PolicyConfiguration。
tags	[]String	否	自訂設定警示監控規則的類別。說明 Java SDK 0.6.74及以上版本支援。

AlertQuery

欄位	資料類型	是否必填	說明
storeType	String	是	查詢資料來源類型。取值如下： log：日誌庫。 metric：時序庫。 meta：資源資料。
region	String	是	目標Project所在地區。當storeType被設定為log或metric時，設定region為目標Project所在地區。當storeType被設定為meta時，設定project為空白字串。
project	String	是	查詢統計所關聯的Project。當storeType被設定為log或metric時，設定project為目標Project。當storeType被設定為meta時，設定project為空白字串。
store	String	是	查詢統計所關聯的Logstore、Metricstore或資源資料。當storeType被設定為log時，設定store為目標Logstore。當storeType被設定為metric時，設定store為目標Metricstore。當storeType被設定為meta時，設定store為目標資源資料名稱。
roleArn	String	否	訪問資料所需的RAM角色的ARN。更多資訊，請參見跨Project監控資料授權。
query	String	是	查詢分析語句。當storeType被設定為log或metric時，設定query為查詢分析語句。當storeType被設定為meta時，設定query為空白字串。
timeSpanType	String	否	時間類型。更多資訊，請參見查詢統計時間範圍。當storeType被設定為log或metric時，必須設定timeSpanType。
start	String	否	開始時間。當storeType被設定為log或metric時，必須設定start。
end	String	否	結束時間。當storeType被設定為log或metric時，必須設定end。
powerSqlMode	String	否	是否使用獨享SQL。取值如下： auto：自動切換。 enable：啟動。 disable：禁用。

GroupConfiguration

欄位

資料類型

是否必填

說明

type

String

是

分組評估類型。取值如下：

no_group：不分組。
custom：自訂。
labels_auto：標籤自動。
僅適用於時序資料。

fields

[]String

否

用於分組評估的欄位。

當type被設定為custom時，必須設定fields。

JoinConfiguration

欄位

資料類型

是否必填

說明

type

String

是

集合操作類型。取值如下：

cross_join：笛卡爾積。
inner_join：內聯。
left_join：左聯。
right_join：右聯。
full_join：全聯。
left_exclude：左斥。
right_exclude：右斥。
concat：拼接，順序遍曆每個資料集。
no_join：不合并，只取第一個資料集。

condition

String

否

當type被設定為inner_join、left_join、right_join、full_join、left_exclude或right_exclude時，必須設定condition，例如設定為$0.host == $1.ip。

SeverityConfiguration

欄位	資料類型	是否必填	說明
severity	Integer	是	警示嚴重度。更多資訊，請參見警示嚴重度。
evalCondition	ConditionConfiguration	否	觸發條件。更多資訊，請參見設定評估運算式。
evalCondition.condition	String	是	資料匹配運算式。不需要判定資料內容時，設定為空白字串即可。其餘情況，需設定為運算式，例如`errCnt > 10`。
evalCondition.countCondition	String	是	資料條數判斷運算式，表示有多少條資料滿足條件。表示存在資料即滿足時，設定為空白字串即可。其餘情況，需設定為運算式，例如`__count__ > 3`。

Tag

欄位	資料類型	是否必填	說明
key	String	是	欄位名稱。
value	String	是	欄位值。

PolicyConfiguration

欄位	資料類型	是否必填	說明
alertPolicyId	String	是	警示策略ID。如果是極簡模式或普通模式，設定為sls.builtin.dynamic（系統內建的動態警示策略）。如果是進階模式，設定為指定的警示策略ID。
actionPolicyId	String	是	使用的行動策略ID。如果是進階模式且所選的警示策略未配置動態行動策略，則設定actionPolicyId為空白字串。
repeatInterval	String	是	重複等待時間。例如5m、1h等。
useDefault	Boolean	是	相容欄位，固定為false。

參考資料

警示嚴重度

警示嚴重度	取值
Critical（嚴重）	10
High（高）	8
Medium（中）	6
Low（低）	4
Report（報告）	2

查詢統計的時間範圍

timeSpanType	start	end	說明
Custom	-15m	absolute	整點15分鐘。
Custom	-100s	-20s	相對時間，100秒前到20秒前的時間段。
Custom	-60s	now	相對60秒。
Custom	-120m	Null 字元串	相對120分鐘。
Relative	-100s	-20s	相對時間，100秒前到20秒前的時間段。
Relative	-60s	now	相對60秒。
Relative	-120m	Null 字元串	相對120分鐘。
Truncated	-15m	任意	整點15分鐘。
Today	任意	任意	今天0點到現在。
Yesterday	任意	任意	昨天0點到今天0點。