告警輸出數(shù)據(jù)結(jié)構(gòu)
本文檔介紹告警輸出的數(shù)據(jù)結(jié)構(gòu)。
告警輸出至事件庫的數(shù)據(jù)結(jié)構(gòu)
告警輸出至事件庫(EventStore)的數(shù)據(jù)格式請參見事件數(shù)據(jù)(Event),具體字段說明及示例如下。
字段名稱 | 類型 | 說明 | 示例 |
specversion | string | 固定為1.0。 | 1.0 |
id | string | 事件ID。 | 568f2****2757 |
source | string | 事件來源。固定為 | acs:sls |
type | string | 事件類型。固定為 | sls.alert |
subject | string | 告警的查詢快照。 | https://sls.console.aliyun.com/lognext/project/test-xxx/logsearch/test-alert-access?encode=base64&endTime=1617175989&queryString=KiB8IHNlKiB8IHNlbGVjdCBjb3VudCgxKSBhcyBjbn****meType=99&startTime=1617175089 |
datacontenttype | string | 數(shù)據(jù)格式。固定為 | application/cloudevents+json |
data | json | 事件數(shù)據(jù)。數(shù)據(jù)格式請參見告警數(shù)據(jù)結(jié)構(gòu)。 | / |
time | string | 告警時(shí)間。 | 2023-05-31T01:49:18Z |
title | string | 告警信息標(biāo)題。 | Nginx 400錯(cuò)誤。 |
message | string | 告警信息描述。 | Nginx 過去5分鐘內(nèi),400錯(cuò)誤發(fā)生156次。 |
status | string | 告警事件狀態(tài)。
| error |
示例數(shù)據(jù)如下:
{
"specversion": "1.0",
"id": "568f****2757",
"source": "acs:sls",
"type": "sls.alert",
"subject": "https://sls.console.aliyun.com/lognext/project/test-xxx/logsearch/test-alert-access?encode=base64&endTime=1617175989&queryString=KiB8IHNlbGVjdCBjb3VudCgxKSBhcyBjbnQ%3D&queryTimeType=99&startTime=1617175089",
"datacontenttype": "application/cloudevents+json",
"data": {
// ...
},
"time": "2023-05-31T01:49:18Z",
"title": "Nginx 400錯(cuò)誤",
"message": "Nginx 過去5分鐘內(nèi),400錯(cuò)誤發(fā)生156次。",
"status": "warning"
}
告警輸出到云監(jiān)控事件中心數(shù)據(jù)結(jié)構(gòu)
字段名稱 | 類型 | 說明 | 示例 |
Product | string | 產(chǎn)品名稱。固定為 | SLS |
Name | string | 事件名稱。
| AlertEvent:WARN |
Time | int | 毫秒級時(shí)間戳。 | 1685499264000 |
Level | string | 事件等級。
| WARN |
RegionId | string | 地域。 | cn-hangzhou |
Status | string | 事件狀態(tài),可能的取值為:
| firing |
InstanceName | string | 告警規(guī)則名稱。 | 測試告警規(guī)則 |
ResourceId | string | 資源ID。格式為 | acs:log:cn-hangzhou:117918634953****:project/my-project/job/alert-12345 |
Content | json | 事件內(nèi)容。數(shù)據(jù)格式請參見告警數(shù)據(jù)結(jié)構(gòu)。 |
示例數(shù)據(jù)如下:
{
"Product": "SLS",
"Name": "AlertEvent:WARN",
"Time": 1685499264000,
"Level": "WARN",
"RegionId": "cn-hangzhou",
"Status": "firing",
"InstanceName": "測試告警規(guī)則",
"ResourceId": "acs:log:cn-hangzhou:117918634953****:project/my-project/job/alert-1683858496-247190",
"Content": {
// ...
}
}
告警數(shù)據(jù)結(jié)構(gòu)
字段名稱 | 類型 | 說明 | 示例 |
aliuid | string | Project所屬的阿里云賬號ID。 | 117918634953**** |
region | string | 地域。 | cn-hangzhou |
project | string | 告警規(guī)則所屬Project。 | my-project |
alert_id | string | 告警規(guī)則ID,Project內(nèi)唯一。 | alert-12345 |
alert_name | string | 告警規(guī)則名稱。 | 測試告警規(guī)則 |
alert_instance_id | string | 告警觸發(fā)的實(shí)例的ID。 | ee16a8f435485f3f-5be6b81edc520-3d6**** |
alert_type | string | 告警類型。默認(rèn)為 | sls_alert |
next_eval_interval | int | 下一次評估間隔,單位為秒。 | 300 |
fire_time | int | 首次觸發(fā)時(shí)間,秒級時(shí)間戳。 | 1616059834 |
alert_time | int | 本次評估時(shí)間,秒級時(shí)間戳。 | 1616744734 |
resolve_time | int | 告警恢復(fù)時(shí)間,秒級時(shí)間戳。
| 0 |
status | string | 告警狀態(tài)。可能的取值為:
| firing |
severity | int | 告警嚴(yán)重度。可能的取值為:
| 6 |
labels | map | 告警標(biāo)簽。 |
|
annotations | map | 告警標(biāo)注。 |
|
results | array | 查詢參數(shù)和中間結(jié)果,數(shù)組類型。數(shù)據(jù)格式請參見告警查詢結(jié)果數(shù)據(jù)結(jié)構(gòu)。 | / |
fire_results | array | 觸發(fā)告警的數(shù)據(jù),最多取100條。 fire_results的值超過2 KB時(shí),超出部分會(huì)被截?cái)唷?/p> |
|
fire_results_count | int | 觸發(fā)告警的數(shù)據(jù)的總條數(shù). | 3 |
condition | string | 觸發(fā)告警的評估表達(dá)式。其中,以觸發(fā)告警的值替換您所配置的變量,并使用中括號([ ])包裹。格式為 | Count:[4] > 0; Condition:[400] >= 400 |
raw_condition | string | 原始的評估表達(dá)式,即變量未被替換為真實(shí)值的原始表達(dá)式。格式為 | Count:__count__ > 0; Condition:status >= 400 |
示例數(shù)據(jù)如下:
{
"aliuid": "117918634953****",
"region": "cn-hangzhou",
"project": "my-project",
"alert_id": "alert-****-247190",
"alert_name": "Nginx訪問錯(cuò)誤",
"alert_instance_id": "77df****5a2a",
"alert_type": "sls_alert",
"next_eval_interval": 300,
"fire_time": 1686719199,
"alert_time": 1686722799,
"resolve_time": 0,
"status": "firing",
"severity": 4,
"labels": {
"request_method": "POST"
},
"annotations": {
"__count__": "1",
"cnt": "5",
"desc": "Nginx最近五分鐘內(nèi)POST請求錯(cuò)誤5次",
"title": "Nginx訪問錯(cuò)誤告警觸發(fā)"
},
"results": [
{
"region": "cn-hangzhou",
"project": "my-project",
"store": "nginx-access-log",
"store_type": "log",
"role_arn": "",
"query": "status >= 400 | select request_method, count(*) as cnt group by request_method ",
"start_time": 1686722499,
"end_time": 1686722799,
"fire_result": {
"cnt": "5",
"request_method": "POST"
},
"raw_results": [
{
"cnt": "25",
"request_method": "GET"
},
{
"cnt": "2",
"request_method": "DELETE"
},
{
"cnt": "5",
"request_method": "PUT"
},
{
"cnt": "5",
"request_method": "POST"
}
],
"raw_result_count": 4,
"truncated": false,
"dashboard_id": "",
"chart_title": "",
"is_complete": true,
"power_sql_mode": "auto"
}
],
"fire_results": [
{
"cnt": "5",
"request_method": "POST"
}
],
"fire_results_count": 1,
"condition": "Count:[1] > 0; Condition:[5] > 0",
"raw_condition": "Count:__count__ > 0; Condition:cnt > 0"
}
告警查詢結(jié)果數(shù)據(jù)結(jié)構(gòu)
字段名稱 | 類型 | 說明 | 示例 |
region | string | 查詢統(tǒng)計(jì)目標(biāo)庫所在地域。store_type為資源數(shù)據(jù)時(shí),該變量值為空。 | cn-hangzhou |
project | string | 查詢統(tǒng)計(jì)目標(biāo)庫所在Project。store_type為資源數(shù)據(jù)時(shí),該變量值為空。 | my-project |
store_type | string | 查詢統(tǒng)計(jì)目標(biāo)庫存儲類型。
| log |
store | string | 查詢統(tǒng)計(jì)中的目標(biāo)庫名稱。 | test-logstore |
query | string | 查詢分析語句。 | status >= 400 | select status, count(*) as cnt group by status |
start_time | int | 查詢開始時(shí)間,秒級時(shí)間戳。store_type為資源數(shù)據(jù)時(shí),該變量值為空。 | 1616741485 |
end_time | int | 查詢結(jié)束時(shí)間,秒級時(shí)間戳。store_type為資源數(shù)據(jù)時(shí),該變量值為空。 | 1616745085 |
fire_result | map | 觸發(fā)告警的查詢分析結(jié)果數(shù)據(jù)。如果有多條數(shù)據(jù),這里只隨機(jī)取一條。 |
|
raw_results | array | 實(shí)際查詢內(nèi)容,數(shù)組格式,最多100行。 raw_results的值超過2 KB時(shí),超出部分會(huì)被截?cái)唷?/p> |
|
raw_result_count | int | 實(shí)際查詢數(shù)據(jù)的總條數(shù),可能多于100。 | 2 |
truncated | boolean | raw_results是否被截?cái)唷?/p> | false |
dashboard_id | string | 關(guān)聯(lián)的儀表盤ID。如果未關(guān)聯(lián)則為空字符串。 | nginx-access-log_nginx_dashboard_cn |
chart_title | string | 關(guān)聯(lián)的圖表ID。如果未關(guān)聯(lián)則為空字符串。 | dashboard-access-log1556888331551 |
role_arn | string | 授權(quán)角色ARN。如果不涉及則為空字符串。具體操作,請參見配置訪問控制。 | acs:ram::117918634953****:role/aliyunslsalertmonitorrole |
is_complete | boolean | 查詢是否精確。 | true |
power_sql_mode | string | 是否開啟SQL獨(dú)享版,取值如下:
| auto |