Atlas 警报设置创建
为您的项目创建警报配置。
要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas alerts settings create [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--apiKey | 字符串 | false | Datadog API 密钥、Opsgenie API 密钥或 VictorOps API 密钥。 如果 notificationType 分别为 DATADOG、OPS_GENIE 或 VICTOR_OPS,则为必填项。 |
--enabled | false | 指示是否启用警报配置的标志。 | |
--event | 字符串 | false | 触发警报的事件类型。 要了解 CLI 接受哪些值,请参阅 Atlas Admin API 规范中的 eventTypeName 枚举: https://dochub.mongodb.org/core/atlas-event-names。 |
-f, --file | 字符串 | false | 定义警报配置设置的 JSON 配置文件的路径。要了解有关 Atlas CLI 警报配置文件的更多信息,请参阅 https://dochub.mongodb.org/core/alert-config-atlas-cli。 |
-h,--help | false | 创建帮助 | |
--matcherFieldName | 字符串 | false | 目标对象中要匹配的字段的名称。要了解有效值,请运行 atlas alerts settings fields type。 |
--matcherOperator | 字符串 | false | 根据 matcherValue 检查当前指标时要应用的比较操作符。 有效值为 CONTAINS、ENDS_WITH、EQUALS、NOT_CONTAINS、NOT_EQUALS、REGEX、STARTS_WITH。 |
--matcherValue | 字符串 | false | 要使用指定操作符进行测试的值。 如果将 matcherFieldName 设置为 TYPE_NAME,则可以匹配以下值:CONFIG、Mongo、PRIMARY、SECONDARY、独立运行的实例。 |
--metricMode | 字符串 | false | 指示 Atlas 是否将当前指标值计算为平均值的选项。 有效值为 AVERAGE。 |
--metricName | 字符串 | false | 此命令检查已配置警报所对照的指标名称。 要了解有效值,请参阅 https://dochub.mongodb.org/core/alert-host-metrics-atlas 。仅当事件设置为 OUTSIDE_METRIC_THRESHOLD 时,此选项才适用。 |
--metricOperator | 字符串 | false | 检查当前指标值时要应用的比较操作符。有效值为 LESS_THAN 和 GREATER_THAN。 |
--metricThreshold | 浮动 | false | 阈值,超出该阈值将触发警报。 |
--metricUnits | 字符串 | false | 阈值的单位。 有效值为 BITS、BYTES、DAYS、GIGABITS、GIGABYTES、HOURS、KILOBITS、KILOBYTES、MEGABITS、MEGABYTES、MILLISECONDS、MINUTES、PBYTES、RAW、SECONDS、TB。 |
--notificationChannelName | 字符串 | false | Slack 渠道名称。对于 SLACK 通知类型是必需的。 |
--notificationDelayMin | int | false | 检测到警报条件后发送第一个通知之前的等待分钟数。 |
--notificationEmailAddress | 字符串 | false | 发送警报通知的电子邮件地址。 |
--notificationEmailEnabled | false | 启用电子邮件通知的标志。 可配置为 GROUP 和 USER 通知类型。 | |
--notificationIntervalMin | int | false | 未解决的未确认警报的连续通知之间等待的分钟数。 |
--notificationMobileNumber | 字符串 | false | 向其发送警报通知的手机号码。 |
--notificationRegion | 字符串 | false | 指示要使用的 API URL 的区域。 |
--notificationRole | 字符串 | false | 包含接收配置警报的一个或多个组织或项目角色的列表。 |
--notificationServiceKey | 字符串 | false | PagerDuty 服务密钥。 |
--notificationSmsEnabled | false | 启用文本消息通知的标志。 | |
--notificationTeamId | 字符串 | false | 团队的唯一标识符。 |
--notificationToken | 字符串 | false | Slack API 令牌或 Bot 令牌。 |
--notificationType | 字符串 | false | 警报通知类型。 有效值为 DATADOG、EMAIL、GROUP (Project)、MICROSOFT_TEAMS、ORG、OPS_GENIE、PAGER_DUTY、SLACK、SMS、TEAM、USER、VICTOR_OPS 或 WEBHOOK。 |
--notificationUsername | 字符串 | false | 向其发送通知的 Atlas user 的名称。 |
--notificationVictorOpsRoutingKey | 字符串 | false | 与您的 Splunk On-Call 帐户关联的路由密钥。 |
--notificationWebhookSecret | 字符串 | false | 基于 Webhook 的警报的身份验证密钥。 |
--notificationWebhookUrl | 字符串 | false | 基于 Webhook 的警报或 Microsoft Teams 警报的目标 URL。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Alert configuration <Id> created.
举例
# Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305: atlas alerts settings create --event JOINED_GROUP --enabled \ --notificationType USER --notificationEmailEnabled \ --notificationIntervalMin 60 --notificationUsername john@example.com \ --output json --projectId 5df90590f10fab5e33de2305
# Create alert using json file containing alert configuration atlas alerts settings create 5d1113b25a115342acc2d1aa --file alerts.json
# Create an alert that shows possible connection storms based on the number of connections atlas alerts settings create --event OUTSIDE_METRIC_THRESHOLD --metricName CONNECTIONS --metricOperator LESS_THAN --metricThreshold 1 --metricUnits RAW --projectId 5df90590f10fab5e33de2305 --notificationType GROUP --notificationEmailEnabled --notificationIntervalMin 5 --enabled