使用Terraform玩转SLS告警

资源类型

resource_name

record_id

tag

value结构举例

备注

用户

sls.common.user

值同user_id

值同user_name

{
    "user_id": "xiaoming",
    "user_name": "小明",
    "email": [
        "xiaoming@example.com"
    ],
    "country_code": "86",
    "phone": "13334567890",
    "enabled": true,
    "sms_enabled": true,
    "voice_enabled": true
}

用户组

sls.common_user_group

值同

user_group_id

值同

user_group_name

{ 
    "user_group_id": "group-xiaoming",
    "user_group_name": "分组-小明",
    "enabled": true,
    "members": [
        "xiaoming"
    ]
}

• record_id：user_id
• tag: user_name

值班组

sls.alert.oncall_group

值同oncall_id

值同

oncall_name

{
    "oncall_id": "default_oncall",
    "oncall_name": "default oncall",
    "enabled": true,
    "overrides": [],
    "rotations": [
        {
            "targets": [
                {
                    "type": "user",
                    "target_id": "jizhi"
                },
                {
                    "type": "user_group",
                    "target_id": "alert-dev"
                }
            ],
            "end_time": 0,
            "shift_day": "",
            "shift_time": "12:00",
            "shift_type": "day",
            "start_time": 1633017600,
            "shift_minute": 0,
            "end_time_type": "none",
            "shift_interval": 1,
            "shift_week_custom": null,
            "restriction_date_type": "workday",
            "restriction_time_type": "allday",
            "restriction_week_range": null,
            "restriction_time_custom_range": null
        }
    ],
    "calendar_id": "default_calendar"
}

webhook集成

sls.alert.action_webhook

值同id

值同name

{
    "id": "custom-test",
    "name": "自定义webhook测试",
    "type": "custom",
    "url": "http://localhost:9099/data/webhook",
    "method": "POST",
    "headers": [
        {
            "key": "Content-Type",
            "value": "application/json"
        },
        {
            "key": "Foo",
            "value": "bar"
        }
    ]
}

• type类型有：

• • dingtalk
  • wechat
  • lark
  • slack
  • custom

• 除了 custom 类型外，其余几类 method 字段固定为 POST，headers 固定为空数组。

告警策略

sls.alert.alert_policy

值同policy_id

值同policy_name

{
    "policy_id": "sls.builtin",
    "policy_name": "内置告警策略",
    "parent_id": "sls.root",
    "is_default": false,
    "group_script": "fire(action_policy=\"sls.builtin\", group={\"project\": \"__a__\", \"uid\": alert.aliuid}, group_wait=\"5s\", group_interval=\"2m\", repeat_interval=\"2m\")\nstop()\nfire(action_policy=\"sls.builtin\", group={\"alert_id\": alert.alert_id}, group_wait=\"5s\", group_interval=\"10s\", repeat_interval=\"2m\")\nif alert.labels.name ~= \"^\\\\w+s$\":\n\tfire(action_policy=\"sls.builtin\", group={\"product\": \"xxs\"}, group_wait=\"5s\", group_interval=\"10s\", repeat_interval=\"2m\")\n\tstop()\nstop()\nfire(action_policy=\"sls.builtin\", group={\"label_name\": alert.labels.name}, group_wait=\"10s\", group_interval=\"10s\", repeat_interval=\"2m\")",
    "inhibit_script": "if alert.severity >= 8:\n    silence alert.severity < 6",
    "silence_script": ""
}

• is_default 固定为 false
• group_script 为路由合并策略
• inhibit_script 为抑制策略
• silence_script 为静默策略
• 通过Terraform配置，group_script、inhibit_script 以及 silence_script 只包含DSL脚本信息，没有UI配置信息，因此控制台上无法看到相应的图形展示

行动策略

sls.alert.action_policy

值同action_policy_id

值同action_policy_name

{
    "action_policy_id": "sls.builtin",
    "action_policy_name": "默认行动策略",
    "labels": {},
    "is_default": false,
    "primary_policy_script": "fire(type=\"webhook_integration\", integration_type=\"dingtalk\", webhook_id=\"dingtalk-test\", template_id=\"default-template\", period=\"any\")",
    "secondary_policy_script": "fire(type=\"voice\", users=[\"jizhi\"], groups=[\"group-jizhi\"], template_id=\"default-template\")",
    "escalation_start_enabled": false,
    "escalation_start_timeout": "10s",
    "escalation_inprogress_enabled": false,
    "escalation_inprogress_timeout": "10s",
    "escalation_enabled": false,
    "escalation_timeout": "4h0m0s"
}

• is_default 固定为 false
• labels 为保留字段，固定为{}
• primary_policy_script 为第一行动策略
• secondary_policy_script 为第二行动策略
• escalation_* 为控制第二行动策略是否开启的配置，可参考控制台上配置项
• 通过Terraform配置的话，primary_policy_script 以及 secondary_policy_script 只包含DSL脚本信息，没有UI配置信息，因此控制台上无法看到相应的图形展示

内容模板

sls.alert.content_template

值同template_id

值同template_name

{
    "template_id": "default-template",
    "template_name": "默认模板",
    "is_default": false,
    "templates": {
        "fc": {
            "limit": 0,
            "locale": "zh-CN",
            "content": "",
            "send_type": "merged"
        },
        "sms": {
            "locale": "zh-CN",
            "content": ""
        },
        "lark": {
            "title": "Alerthub告警测试 ${alert_name}",
            "locale": "zh-CN",
            "content": ""
        },
        "email": {
            "locale": "zh-CN",
            "content": "",
            "subject": "SLS告警测试-jizhi-test"
        },
        "slack": {
            "title": "Alerthub告警测试 ${alert_name}",
            "locale": "zh-CN",
            "content": ""
        },
        "voice": {
            "locale": "zh-CN",
            "content": ""
        },
        "wechat": {
            "title": "Alerthub告警测试 ${alert_name}",
            "locale": "zh-CN",
            "content": ""
        },
        "webhook": {
            "limit": 0,
            "locale": "zh-CN",
            "content": "",
            "send_type": "merged"
        },
        "dingtalk": {
            "title": "Alerthub告警测试 ${alert_name}",
            "locale": "zh-CN",
            "content": ""
        },
        "event_bridge": {
            "locale": "zh-CN",
            "content": "",
            "subject": "wkb-test"
        },
        "message_center": {
            "locale": "zh-CN",
            "content": ""
        }
    }
}

• is_default 固定为 false
• templates 下包含每个渠道的模板配置，如果某个渠道的 content 为空，则使用系统默认的模板配置，参考 默认内容模板
• locale 取值为 zh-CN 或 en-US
• webhook 和 fc 渠道的 send_type 取值为 single 或者 merged，表示逐条通知或者合并通知

默认日历

sls.common.calender

值同calender_id

值同calender_name

{
    "calendar_id": "default_calendar",
    "calendar_name": "默认日历",
    "timezone": "Asia/Shanghai",
    "workdays": [
        1,
        2,
        3,
        4,
        5
    ],
    "worktime": [
        {
            "end_time": "21:00",
            "start_time": "09:00"
        }
    ],
    "reset_days": [],
    "holiday_sync": "china"
}

• 默认日历的 id 固定为 default_calendar
• 日历配置比较复杂，建议通过控制台来操作

渠道额度

sls.alert.channel_quota

值同id

值空

{
    "id": "default",
    "quota_script": "if user in [\"jizhi\"]:\n    set_limit(sms=5, voice=5, email=5)\nset_limit(sms=100, voice=100, email=100)"
}

• id 固定为 default
• quota_script 为 DSL 配置，通过 Terraform 配置会丢失UI配置信息，因此控制台上无法看到相应的图形展示
• 建议通过控制台来配置