警报配置文件
您可以使用配置文件指定通过Atlas CLI创建或更新警报配置的设置。 Atlas CLI接受 .json
配置文件。
警报配置设置
根据警报配置的类型,您可以指定以下设置来创建或更新配置文件中的警报配置:
字段 | 类型 | 说明 |
---|---|---|
| 布尔 | 指示是否有人为指定项目启用此警报配置的标志。 |
| 字符串 | 必需。 Atlas Triggers警报的事件类型。 |
| 对象数组 | 将对象与此警报配置进行匹配时要应用的规则。 仅当 |
| 对象 | 指标的阈值,超过该阈值时会Atlas Triggers警报。仅当 |
| 对象数组 | 包含 Atlas 发送通知的目标的列表。 |
| 对象 | 超过时Atlas Triggers警报的限制。 |
有关可用设置的详细说明和完整列表,请参阅 API 规范中的请求正文模式:
警报配置文件示例
要创建或更新警报配置,请指定要包含在配置文件中的字段。例如,以下示例文件启用警报配置,当名为event-replica-set
的副本集丢失其主节点时,该配置会通知您:
{ "enabled": true, "eventTypeName": "NO_PRIMARY", "matchers": [ { "fieldName": "REPLICA_SET_NAME", "operator": "EQUALS", "value": "event-replica-set" } ], "notifications": [ { "datadogApiKey": "****************************a23c", "datadogRegion": "US", "delayMin": 0, "intervalMin": 5, "notifierId": "6462742adc47d365036da07c", "typeName": "DATADOG" } ], "threshold": { "operator": "<", "threshold": 0, "units": "bits" } }
警报配置命令示例
创建文件后,运行 Atlas CLI 命令以创建或更新警报配置。
创建警报配置
要创建警报配置,请指定--flag
选项和文件路径。 以下示例使用名为alert-config.json
的配置文件创建警报配置:
atlas alerts settings create --file /alert-config.json
更新警报配置
要更新警报配置,请指定要更新的警报配置的 ID、 --flag
选项和文件路径。 以下示例使用名为alert-config.json
的配置文件更新现有警报配置:
atlas alerts settings update <alertConfigId> --file /alert-config.json