预览告警处理规则效果
curl --request POST \
--url 'https://api.flashcat.cloud/alert/pipeline/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131,
"rules": [
{
"kind": "severity_reset",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": [
"test"
]
}
],
"settings": {
"severity": "Info"
}
},
{
"kind": "alert_drop",
"if": [
{
"key": "title",
"oper": "IN",
"vals": [
"/.*noise.*/"
]
}
],
"settings": {}
}
],
"event": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"event_status": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
}
}
'import requests
url = "https://api.flashcat.cloud/alert/pipeline/preview?app_key="
payload = {
"integration_id": 6113996590131,
"rules": [
{
"kind": "severity_reset",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": ["test"]
}
],
"settings": { "severity": "Info" }
},
{
"kind": "alert_drop",
"if": [
{
"key": "title",
"oper": "IN",
"vals": ["/.*noise.*/"]
}
],
"settings": {}
}
],
"event": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"event_status": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
integration_id: 6113996590131,
rules: [
{
kind: 'severity_reset',
if: [{key: 'labels.env', oper: 'IN', vals: ['test']}],
settings: {severity: 'Info'}
},
{
kind: 'alert_drop',
if: [{key: 'title', oper: 'IN', vals: ['/.*noise.*/']}],
settings: {}
}
],
event: {
title: 'Disk usage 95% on db-3',
description: 'Root filesystem is 95% full on db-3.',
event_status: 'Warning',
labels: {service: 'mysql', env: 'prod', host: 'db-3'}
}
})
};
fetch('https://api.flashcat.cloud/alert/pipeline/preview?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/alert/pipeline/preview?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integration_id' => 6113996590131,
'rules' => [
[
'kind' => 'severity_reset',
'if' => [
[
'key' => 'labels.env',
'oper' => 'IN',
'vals' => [
'test'
]
]
],
'settings' => [
'severity' => 'Info'
]
],
[
'kind' => 'alert_drop',
'if' => [
[
'key' => 'title',
'oper' => 'IN',
'vals' => [
'/.*noise.*/'
]
]
],
'settings' => [
]
]
],
'event' => [
'title' => 'Disk usage 95% on db-3',
'description' => 'Root filesystem is 95% full on db-3.',
'event_status' => 'Warning',
'labels' => [
'service' => 'mysql',
'env' => 'prod',
'host' => 'db-3'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/alert/pipeline/preview?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/alert/pipeline/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/alert/pipeline/preview?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"is_recovery": false,
"before": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"severity": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
},
"after": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"severity": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
},
"dropped": false,
"inhibited": false,
"steps": [
{
"index": 0,
"kind": "severity_reset",
"result": "not_matched",
"detail": "condition_not_met"
},
{
"index": 1,
"kind": "alert_drop",
"result": "not_matched",
"detail": "condition_not_met"
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}告警管理
预览告警处理规则效果
用未保存的告警处理规则按接入的方式处理一个事件，返回处理前后的差异。
POST
/
alert
/
pipeline
/
preview
预览告警处理规则效果
curl --request POST \
--url 'https://api.flashcat.cloud/alert/pipeline/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131,
"rules": [
{
"kind": "severity_reset",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": [
"test"
]
}
],
"settings": {
"severity": "Info"
}
},
{
"kind": "alert_drop",
"if": [
{
"key": "title",
"oper": "IN",
"vals": [
"/.*noise.*/"
]
}
],
"settings": {}
}
],
"event": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"event_status": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
}
}
'import requests
url = "https://api.flashcat.cloud/alert/pipeline/preview?app_key="
payload = {
"integration_id": 6113996590131,
"rules": [
{
"kind": "severity_reset",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": ["test"]
}
],
"settings": { "severity": "Info" }
},
{
"kind": "alert_drop",
"if": [
{
"key": "title",
"oper": "IN",
"vals": ["/.*noise.*/"]
}
],
"settings": {}
}
],
"event": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"event_status": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
integration_id: 6113996590131,
rules: [
{
kind: 'severity_reset',
if: [{key: 'labels.env', oper: 'IN', vals: ['test']}],
settings: {severity: 'Info'}
},
{
kind: 'alert_drop',
if: [{key: 'title', oper: 'IN', vals: ['/.*noise.*/']}],
settings: {}
}
],
event: {
title: 'Disk usage 95% on db-3',
description: 'Root filesystem is 95% full on db-3.',
event_status: 'Warning',
labels: {service: 'mysql', env: 'prod', host: 'db-3'}
}
})
};
fetch('https://api.flashcat.cloud/alert/pipeline/preview?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/alert/pipeline/preview?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integration_id' => 6113996590131,
'rules' => [
[
'kind' => 'severity_reset',
'if' => [
[
'key' => 'labels.env',
'oper' => 'IN',
'vals' => [
'test'
]
]
],
'settings' => [
'severity' => 'Info'
]
],
[
'kind' => 'alert_drop',
'if' => [
[
'key' => 'title',
'oper' => 'IN',
'vals' => [
'/.*noise.*/'
]
]
],
'settings' => [
]
]
],
'event' => [
'title' => 'Disk usage 95% on db-3',
'description' => 'Root filesystem is 95% full on db-3.',
'event_status' => 'Warning',
'labels' => [
'service' => 'mysql',
'env' => 'prod',
'host' => 'db-3'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/alert/pipeline/preview?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/alert/pipeline/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/alert/pipeline/preview?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"is_recovery": false,
"before": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"severity": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
},
"after": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"severity": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
},
"dropped": false,
"inhibited": false,
"steps": [
{
"index": 0,
"kind": "severity_reset",
"result": "not_matched",
"detail": "condition_not_met"
},
{
"index": 1,
"kind": "alert_drop",
"result": "not_matched",
"detail": "condition_not_met"
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}限制说明
| 项目 | 说明 |
|---|---|
| 速率限制 | 每个账户 1,000 次/分钟；50 次/秒 |
| 权限要求 | 协作空间管理（on-call）或 集成中心查看（on-call）或 集成中心管理（on-call） |
使用说明
- 不会保存任何内容，也不创建告警或事件。
- 该集成已存的标签增强规则会先执行，然后按顺序执行你传入的
rules，作用在增强后的事件上。 - 恢复（
Ok）事件会直接关闭告警、不执行处理规则：is_recovery为true，每一步都是not_executed，detail为recovery_event。 dropped、inhibited说明是哪类规则中断了事件：alert_drop直接丢弃，alert_inhibit在存在匹配的活跃源告警时丢弃。该规则之后的步骤为not_executed。- 没有规则命中时，
after是通知模板渲染后的事件，即在协作空间中会看到的内容。
授权
在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集，请妥善保管。
请求体
application/json
此页面对您有帮助吗？