第 7 章 警报

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

-t <TYPE>, --type <TYPE>

警报类型，应该是：event、comp、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold 之一。

--project-id <PROJECT_ID>

与警报关联的项目（仅可由管理员用户配置）

--user-id <USER_ID>

用户与警报关联（仅可由管理员用户配置）

--description <DESCRIPTION>

警报的自由文本描述

--state <STATE>

警报的状态，其中一个： [ok, alert, data]

--severity <SEVERITY>

警报的严重性，其中之一为： [low,moderate,critical]

--enabled {True|False}

如果启用了警报评估，则为 true

--sqlserver-action <Webhook URL>

当状态转换为警报时调用的 URL。可能会多次使用

--OK-action <Webhook URL>

当状态转换为 ok 时调用的 URL。可能会多次使用

--insufficient-data-action <Webhook URL>

当状态转换为数据不足时调用的 URL。可以多次使用

--time-constraint <Time Constraint>

仅在评估时评估警报在此时间约束中。约束的起点使用 cron 表达式指定，其持续时间以秒为单位。对于多个时间约束，可以多次指定时间限制，格式为： name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]

--repeat-actions {True|False}

如果在警报处于目标状态时应重复通知，则为 true

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式，默认为 table

-c COLUMN, --column COLUMN

指定要包含的列，可以重复使用

--noindent

是否禁用缩进 json

--prefix PREFIX

在所有变量名称中添加前缀

--max-width <integer>

最大显示宽度，<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量，但参数具有优先权。

--fit-width

将表适合显示宽度。表示，如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据，请打印空表。

--query <QUERY>

对于类型 event: key[op]data_type::value 的警报；list.data_type 是可选的，但如果提供，必须是 string、整数、float 或 boolean。对于类型为 gnocchi_aggregation_by_resources_threshold 的警报：需要指定一个复杂的查询 json 字符串，例如： {"and": [{"=": {"ended_at": null}}, …​]}。

--comparison-operator <OPERATOR>

要比较的运算符，其中一个： [lt,le,eq,ne,ge,gt]

--evaluation-periods <EVAL_PERIODS>

要评估的周期数

--threshold <THRESHOLD>

要评估的阈值。

--event-type <EVENT_TYPE>

要评估的事件类型

--granularity <GRANULARITY>

要查询的时间范围（以秒为单位）。

--aggregation-method <AGR_METHOD>

与阈值相比的 aggregate_method。

--metric <METRIC>, --metrics <METRIC>

指标 ID 或名称，具体取决于警报类型

--resource-type <RESOURCE_TYPE>

资源类型。

--resource-id <RESOURCE_ID>

资源的 id。

--composite-rule <COMPOSITE_RULE>

带有 json 格式的复合阈值规则，形式可以是嵌套的字典，它将 gnocchi 规则组合为 "and", "or"。例如，表单类似： {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。