MongoDB工具 >MongoDB命令行界面 >参考 >运营经理 > 创建一个警报配置
该命令在指定的Ops Manager项目中创建一个警报配置。您还可以通过Ops Manager API在项目中创建一个警报配置。alerts configs create
选项 | 类型 | 描述 | 需要? |
---|---|---|---|
--apiKey |
串 | Datadog,OpsGenie或VictorOps API密钥。 | 仅当notificationType 是或时。DATADOG, ``OPS_GENIE VICTOR_OPS |
--enabled |
布尔值 | 用于确定是否启用警报配置的标志。如果存在,则启用警报配置。如果省略,则禁用配置。 | 没有 |
--event |
串 | 触发警报的事件类型。 有关警报事件的完整列表,请参阅警报条件。 |
是 |
--matcherFieldName |
串 | 要匹配的目标对象中字段的名称。 使用“ 列出警报配置匹配器”字段可返回接受的值。 |
没有 |
--matcherOperator |
串 | 操作员测试该字段的值。可接受的值为:
|
没有 |
--matcherValue |
串 | 用指定的运算符测试的值。 如果
|
没有 |
--metricMode |
串 | 设置为AVERAGE 计算该指标的平均值。 |
没有 |
--metricName |
串 | 值超出阈值的度量标准名称。仅适用于采用
|
只有--event 是OUTSIDE_METRIC_THRESHOLD 。 |
--metricOperator |
串 | 操作员在对照阈值检查当前度量值时应用。可接受的值为:
|
没有 |
--metricThreshold |
浮动 | 超出阈值的警报将被触发。 | 没有 |
--metricUnits |
串 | 阈值的单位。取决于指标的类型。 例 测量内存消耗的度量标准将具有字节度量,而测量时间的度量标准将具有时间单位。 可接受的值为:
|
没有 |
--notificationToken |
串 | Slack API或Bot令牌或Flowdock个人API令牌。如果令牌稍后变得无效,Ops Manager将电子邮件发送给项目所有者,并最终删除令牌。 | 仅当notificationType 是SLACK 或时FLOWDOCK 。 |
--notificationChannelName |
串 | 松弛的频道名称。 | 只有notificationType 是SLACK 。 |
--notificationdelayMin |
整型 | 在检测到警报条件之后要等待的分钟,然后发出第一条通知。 | 没有 |
--notificationEmailAddress |
串 | Ops Manager向其发送通知的电子邮件地址。 | 只有notificationType 是EMAIL 。 |
--notificationEmailEnabled |
布尔值 | 标记以确定Ops Manager是否发送电子邮件通知。如果存在,Ops Manager将发送电子邮件通知。如果不存在,Ops Manager不会发送电子邮件通知。可配置GROUP 和USER 通知类型。 |
没有 |
--notificationsFlowName |
串 | 流名称,以小写字母表示。流名称显示在URL字符串中的组织名称之后
www.flowdock.com/app/<organization-name>/<flow-name> 。 |
只有。notificationType is ``FLOWDOCK |
--notificationIntervalMin |
整型 | 在连续通知之间等待未解决的未确认警报的分钟。 | 没有 |
--notificationMobileNumber |
串 | 发送短信的手机号码。 | 只有notificationType 是SMS 。 |
--notificationOrgName |
串 | Flowdock组织名称以小写字母表示。这是www.flowdock.com/app/ URL字符串后出现的名称。 |
只有notificationType 是FLOWDOCK 。 |
--notificationRole |
串 | 接收配置的警报的一个或多个项目角色。可接受的值包括:
如果包含此字段,则Ops Manager仅将警报发送给分配了您在阵列中指定的角色的用户。如果忽略此字段,Ops Manager将警报发送给分配了任何角色的用户。 可配置为 |
没有 |
--notificationServiceKey |
串 | PagerDuty服务密钥。 | 只有notificationType 是PAGER_DUTY 。 |
--notificationSmsEnabled |
布尔值 | 指示必须发送SMS通知的标志。 | 除非:
|
--notificationTeamId |
串 | 团队的唯一标识符。 | 没有 |
--notificationType |
串 | 警报通知的类型。可接受的值为:
|
是 |
--notificationUsername |
串 | 向其发送通知的Ops Manager用户的名称。在项目中指定拥有警报配置的用户。 | 只有当notificationType 是USER 。 |
--notificationVictorOpsRoutingKey |
串 | VictorOps路由密钥 | 只有当notificationType 是VICTOR_OPS 。 |
--profile , -P |
串 | 保存项目的公钥和私钥的概要文件的名称。如果省略,则使用default
配置文件。要了解有关创建配置文件的更多信息,请参阅配置MongoDB CLI。 |
没有 |
--projectId |
串 | 包含您要创建的警报配置的项目的唯一标识符。 注意 您可以使用以下命令检索项目列表,包括其ID 。 |
是 |
如果命令成功执行,则它将以下字段的子集以JSON格式输出到终端,以描述警报配置。如果命令返回错误,请参阅故障排除以获取推荐的解决方案。
名称 | 类型 | 描述 |
---|---|---|
被创造 | 串 | 创建此警报配置时,采用UTC的ISO 8601日期和时间格式的时间戳。 |
已启用 | 布尔值 | 指示已启用此警报配置的标志。 |
eventTypeName | 串 | 触发警报的事件类型。 有关警报事件的完整列表,请参阅警报条件。 |
groupId | 串 | 拥有此警报配置的项目的唯一标识符。 |
ID | 串 | 此警报配置的唯一标识符。 |
matchers.fieldName | 串 | 要匹配的目标对象中字段的名称。 使用列表警报配置匹配器字段可返回可能的值。 |
Matchers.operator | 串 | 操作员测试该字段的值。可接受的值为:
|
matchers.value | 串 | 用指定的运算符测试的值。 如果
|
配对者 | 对象数组 | 将对象与此警报配置匹配时要应用的规则。仅检查符合所有这些规则的实体的警报条件。
|
metricThreshold.metricName | 串 | 值超出阈值的度量标准名称。仅适用于采用
|
metricThreshold.mode | 串 | 该指标的平均值。 |
metricThreshold.operator | 串 | 操作员在对照阈值检查当前度量值时应用。可接受的值为:
|
metricThreshold.threshold | 数 | 超出阈值的警报将被触发。 |
metricThreshold.units | 串 | 阈值的单位。取决于指标的类型。 例 测量内存消耗的度量标准将具有字节度量,而测量时间的度量标准将具有时间单位。 可接受的值为:
|
metricThreshold | 宾语 | 将导致触发警报的阈值。如果填充。"eventTypeName" :
"OUTSIDE_METRIC_THRESHOLD" |
notifications.apiToken | 串 | Slack API令牌或Bot令牌。填充SLACK
通知。如果令牌稍后变得无效,Ops Manager将电子邮件发送给项目所有者,并最终删除令牌。 |
notifications.channelName | 串 | 松弛的频道名称。填充SLACK 通知。 |
notifications.datadogApiKey | 串 | DataDog API密钥。在DataDog仪表板中找到。填充DATADOG 通知。 |
notifications.delayMin | 数 | 在检测到警报条件之后,发出第一条通知之前要等待的分钟数。 |
notifications.emailAddress | 串 | 向其发送通知的电子邮件地址。填充
EMAIL 通知。 |
notifications.emailEnabled | 布尔值 | 指示必须发送电子邮件通知的标志。为填充ORG ,GROUP 和USER 通知。 |
notifications.flowdockApiToken | 串 | Flowdock“个人API令牌”。填充
FLOWDOCK 通知。如果令牌稍后变得无效,Ops Manager将电子邮件发送给项目所有者,并最终删除令牌。 |
notifications.flowName | 串 | 流名称,以小写字母表示。填充
FLOWDOCK 通知。流名称显示在URL字符串中的组织名称之后
www.flowdock.com/app/<organization-name>/<flow-name> 。 |
notifications.intervalMin | 数 | 在连续的通知之间等待未解决的未确认警报的等待分钟数。 |
notifications.notificationToken | 串 | HipChat API令牌。填充HIP_CHAT 通知。如果令牌稍后变得无效,Ops Manager将电子邮件发送给项目所有者,并最终删除令牌。 |
notifications.orgName | 串 | Flowdock组织名称以小写字母表示。这是www.flowdock.com/app/ URL字符串后出现的名称。填充FLOWDOCK 通知。 |
notifications.role | 串 | 当前项目中的Ops Manager角色。填充GROUP
通知。 |
notifications.roomName | 串 | HipChat房间名称。填充HIP_CHAT 通知。 |
notifications.serviceKey | 串 | PagerDuty服务密钥。填充PAGER_DUTY
通知。如果密钥以后变得无效,Ops Manager将电子邮件发送给项目所有者,并最终将其删除。 |
notifications.smsEnabled | 布尔值 | 指示必须发送SMS通知的标志。为填充ORG ,GROUP 和USER 通知。 |
notifications.snmpAddress | 串 | SNMP陷阱发送到的主机名和端口。目前,Ops Manager仅能够将SNMP陷阱发送到标准
SNMP端口(162)。填充SNMP 通知。Ops Manager使用SNMP v2c。 |
notifications.typeName | 串 | 警报通知的类型。可接受的值为:
|
notifications.username | 串 | 向其发送通知的Ops Manager用户的名称。此处仅允许项目中拥有警报配置的用户。填充USER 通知。 |
通知 | 对象数组 | 检测到警报条件时发送的通知。 |
阈值运算符 | 串 | 操作员在对照阈值检查当前度量值时应用。
|
阈值 | 数 | 超出阈值的警报将被触发。 |
阈 | 宾语 | 将导致触发警报的阈值。如果填充
|
typeName | 串 | 此字段已弃用,将被忽略。 |
更新 | 串 | 上次更新此警报配置时采用UTC的ISO 8601日期和时间格式的时间戳。 |