aodh¶
alarm create¶
创建告警
openstack alarm create
--name <NAME>
-t <TYPE>
[--project-id <PROJECT_ID>]
[--user-id <USER_ID>]
[--description <DESCRIPTION>]
[--state <STATE>]
[--severity <SEVERITY>]
[--enabled {True|False}]
[--alarm-action <Webhook URL>]
[--ok-action <Webhook URL>]
[--insufficient-data-action <Webhook URL>]
[--time-constraint <Time Constraint>]
[--repeat-actions {True|False}]
[--query <QUERY>]
[--comparison-operator <OPERATOR>]
[--evaluation-periods <EVAL_PERIODS>]
[--threshold <THRESHOLD>]
[--event-type <EVENT_TYPE>]
[-m <METER NAME>]
[--period <PERIOD>]
[--statistic <STATISTIC>]
[--granularity <GRANULARITY>]
[--aggregation-method <AGGR_METHOD>]
[--metric <METRIC>]
[--resource-type <RESOURCE_TYPE>]
[--resource-id <RESOURCE_ID>]
[--composite-rule <COMPOSITE_RULE>]
[--stack-id <STACK_NAME_OR_ID>]
[--pool-id <LOADBALANCER_POOL_NAME_OR_ID>]
[--autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>]
- --name <NAME>¶
告警名称
- -t <TYPE>, --type <TYPE>¶
告警类型,应该是以下之一:prometheus, event, composite, threshold, gnocchi_resources_threshold, gnocchi_aggregation_by_metrics_threshold, gnocchi_aggregation_by_resources_threshold, loadbalancer_member_health。
- --project-id <PROJECT_ID>¶
与告警关联的项目(仅供管理员用户配置)
- --user-id <USER_ID>¶
与告警关联的用户(仅供管理员用户配置)
- --description <DESCRIPTION>¶
告警的自由文本描述
- --state <STATE>¶
告警状态,可以是以下之一:[‘ok’, ‘alarm’, ‘insufficient data’]
- --severity <SEVERITY>¶
告警严重程度,可以是以下之一:[‘low’, ‘moderate’, ‘critical’]
- --enabled {True|False}¶
如果启用告警评估,则为 True
- --alarm-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>;[timezone=<IANA Timezone>]]
- --repeat-actions {True|False}¶
如果告警保持在目标状态,则是否应重复通知操作
- --query <QUERY>¶
对于阈值或事件类型的告警:key[op]数据类型::value;列表。如果提供了数据类型,则必须是字符串、整数、浮点数或布尔值。对于 gnocchi_aggregation_by_resources_threshold 类型的告警:需要指定一个复杂的查询 json 字符串,例如:{“and”: [{“=”: {“ended_at”: null}}, …]}。对于 prometheus 类型的告警,这应该是有效的 PromQL 查询。
- --comparison-operator <OPERATOR>¶
比较运算符,可以是以下之一:[‘lt’, ‘le’, ‘eq’, ‘ne’, ‘ge’, ‘gt’]
- --evaluation-periods <EVAL_PERIODS>¶
评估周期数
- --threshold <THRESHOLD>¶
要评估的阈值。
- --event-type <EVENT_TYPE>¶
要评估的事件类型
- -m <METER NAME>, --meter-name <METER NAME>¶
要评估的计量器
- --period <PERIOD>¶
每个评估周期的长度(秒)
- --statistic <STATISTIC>¶
要评估的统计信息,可以是以下之一:[‘max’, ‘min’, ‘avg’, ‘sum’, ‘count’]
- --granularity <GRANULARITY>¶
查询的时间范围(秒)
- --aggregation-method <AGGR_METHOD>¶
与阈值进行比较的聚合方法。
- --metric <METRIC>, --metrics <METRIC>¶
度量标准 ID 或名称,具体取决于告警类型
- --resource-type <RESOURCE_TYPE>¶
资源类型。
- --resource-id <RESOURCE_ID>¶
资源的 ID。
- --composite-rule <COMPOSITE_RULE>¶
复合阈值规则,采用 JSON 格式,形式可以是嵌套字典,通过“and”、“or”组合阈值/gnocchi 规则。例如,形式如下:{“or”:[RULE1, RULE2, {“and”: [RULE3, RULE4]}]}, RULEx 可以是基本阈值规则,但必须包含“type”字段,例如:{“threshold”: 0.8,”meter_name”:”cpu_util”,”type”:”threshold”}
- --stack-id <STACK_NAME_OR_ID>¶
包含负载均衡池和成员的 Heat 堆栈的名称或 ID。如果负载均衡池中的某个成员不正常,则会在根堆栈上触发更新。
- --pool-id <LOADBALANCER_POOL_NAME_OR_ID>¶
负载均衡池的名称或 ID,将评估每个成员的运行状况。
- --autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>¶
包含负载均衡成员的 Heat 自动伸缩组的 ID。不正常的成员将被标记为不正常,然后会在根堆栈上触发更新。
此命令由 aodhclient 插件提供。
alarm delete¶
删除告警
openstack alarm delete [--name <NAME>] [<ALARM ID or NAME>]
- --name <NAME>¶
告警名称
- ALARM ID 或 NAME¶
告警的 ID 或名称。
此命令由 aodhclient 插件提供。
alarm list¶
列出告警
openstack alarm list
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
[--limit <LIMIT>]
[--marker <MARKER>]
[--sort <SORT_KEY:SORT_DIR>]
- --sort-column SORT_COLUMN¶
指定要对数据进行排序的列(首先指定的列具有优先级,不存在的列将被忽略),可以重复
- --sort-ascending¶
按升序对列进行排序
- --sort-descending¶
按降序对列进行排序
- --query <QUERY>¶
aodh 支持的丰富查询,例如 project_id!=my-id user_id=foo 或 user_id=bar
- --filter <KEY1=VALUE1;KEY2=VALUE2...>¶
应用于返回的告警的筛选参数。
- --limit <LIMIT>¶
返回的资源数量(默认值为服务器默认值)
- --marker <MARKER>¶
上一次列出的最后一个项目。在此值之后返回下一个结果,支持的标记是 alarm_id。
- --sort <SORT_KEY:SORT_DIR>¶
资源属性的排序,例如 name:asc
此命令由 aodhclient 插件提供。
alarm metrics¶
获取度量标准
openstack alarm metrics
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
- --sort-column SORT_COLUMN¶
指定要对数据进行排序的列(首先指定的列具有优先级,不存在的列将被忽略),可以重复
- --sort-ascending¶
按升序对列进行排序
- --sort-descending¶
按降序对列进行排序
此命令由 aodhclient 插件提供。
alarm quota set¶
显示单个对象数据的命令基本类。
openstack alarm quota set [--alarm ALARM] project
- --alarm <ALARM>¶
告警配额的新值。值 -1 表示无限制。
- project¶
项目 ID。
此命令由 aodhclient 插件提供。
alarm quota show¶
显示项目的配额
openstack alarm quota show [--project PROJECT]
- --project <PROJECT>¶
项目 ID。如果未指定,则获取当前项目的配额。
此命令由 aodhclient 插件提供。
alarm show¶
显示告警
openstack alarm show [--name <NAME>] [<ALARM ID or NAME>]
- --name <NAME>¶
告警名称
- ALARM ID 或 NAME¶
告警的 ID 或名称。
此命令由 aodhclient 插件提供。
alarm state get¶
获取告警状态
openstack alarm state get [--name <NAME>] [<ALARM ID or NAME>]
- --name <NAME>¶
告警名称
- 告警 ID 或 名称¶
告警的 ID 或名称。
此命令由 aodhclient 插件提供。
告警状态设置¶
设置告警状态
openstack alarm state set
[--name <NAME>]
--state <STATE>
[<ALARM ID or NAME>]
- --name <名称>¶
告警名称
- --state <状态>¶
告警状态,可以是以下之一:[‘ok’, ‘alarm’, ‘insufficient data’]
- 告警 ID 或 名称¶
告警的 ID 或名称。
此命令由 aodhclient 插件提供。
告警更新¶
更新告警
openstack alarm update
[--name <NAME>]
[-t <TYPE>]
[--project-id <PROJECT_ID>]
[--user-id <USER_ID>]
[--description <DESCRIPTION>]
[--state <STATE>]
[--severity <SEVERITY>]
[--enabled {True|False}]
[--alarm-action <Webhook URL>]
[--ok-action <Webhook URL>]
[--insufficient-data-action <Webhook URL>]
[--time-constraint <Time Constraint>]
[--repeat-actions {True|False}]
[--query <QUERY>]
[--comparison-operator <OPERATOR>]
[--evaluation-periods <EVAL_PERIODS>]
[--threshold <THRESHOLD>]
[--event-type <EVENT_TYPE>]
[-m <METER NAME>]
[--period <PERIOD>]
[--statistic <STATISTIC>]
[--granularity <GRANULARITY>]
[--aggregation-method <AGGR_METHOD>]
[--metric <METRIC>]
[--resource-type <RESOURCE_TYPE>]
[--resource-id <RESOURCE_ID>]
[--composite-rule <COMPOSITE_RULE>]
[--stack-id <STACK_NAME_OR_ID>]
[--pool-id <LOADBALANCER_POOL_NAME_OR_ID>]
[--autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>]
[<ALARM ID or NAME>]
- --name <名称>¶
告警名称
- -t <类型>, --type <类型>¶
告警类型,应该是以下之一:prometheus, event, composite, threshold, gnocchi_resources_threshold, gnocchi_aggregation_by_metrics_threshold, gnocchi_aggregation_by_resources_threshold, loadbalancer_member_health。
- --project-id <项目ID>¶
与告警关联的项目(仅供管理员用户配置)
- --user-id <用户ID>¶
与告警关联的用户(仅供管理员用户配置)
- --description <描述>¶
告警的自由文本描述
- --state <状态>¶
告警状态,可以是以下之一:[‘ok’, ‘alarm’, ‘insufficient data’]
- --severity <严重程度>¶
告警严重程度,可以是以下之一:[‘low’, ‘moderate’, ‘critical’]
- --enabled {True|False}¶
如果启用告警评估,则为 True
- --alarm-action <Webhook URL>¶
状态变为告警时调用的 URL。可以多次使用
- --ok-action <Webhook URL>¶
状态变为 OK 时调用的 URL。可以多次使用
- --insufficient-data-action <Webhook URL>¶
状态变为数据不足时调用的 URL。可以多次使用
- --time-constraint <时间约束>¶
仅当评估时的当前时间在此时间约束范围内时才评估告警。约束的起始点用 cron 表达式指定,而持续时间以秒为单位。可以多次指定多个时间约束,格式为:name=<CONSTRAINT_NAME>;start=<CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[timezone=<IANA Timezone>]]
- --repeat-actions {True|False}¶
如果告警保持在目标状态,则是否应重复通知操作
- --query <查询>¶
对于阈值或事件类型的告警:key[op]数据类型::value;列表。如果提供了数据类型,则必须是字符串、整数、浮点数或布尔值。对于 gnocchi_aggregation_by_resources_threshold 类型的告警:需要指定一个复杂的查询 json 字符串,例如:{“and”: [{“=”: {“ended_at”: null}}, …]}。对于 prometheus 类型的告警,这应该是有效的 PromQL 查询。
- --comparison-operator <运算符>¶
比较运算符,可以是以下之一:[‘lt’, ‘le’, ‘eq’, ‘ne’, ‘ge’, ‘gt’]
- --evaluation-periods <评估周期>¶
评估周期数
- --threshold <阈值>¶
要评估的阈值。
- --event-type <事件类型>¶
要评估的事件类型
- -m <计量名称>, --meter-name <计量名称>¶
要评估的计量器
- --period <周期>¶
每个评估周期的长度(秒)
- --statistic <统计量>¶
要评估的统计信息,可以是以下之一:[‘max’, ‘min’, ‘avg’, ‘sum’, ‘count’]
- --granularity <粒度>¶
查询的时间范围(秒)
- --aggregation-method <聚合方法>¶
与阈值进行比较的聚合方法。
- --metric <指标>, --metrics <指标>¶
度量标准 ID 或名称,具体取决于告警类型
- --resource-type <资源类型>¶
资源类型。
- --resource-id <资源ID>¶
资源的 ID。
- --composite-rule <复合规则>¶
复合阈值规则,采用 JSON 格式,形式可以是嵌套字典,通过“and”、“or”组合阈值/gnocchi 规则。例如,形式如下:{“or”:[RULE1, RULE2, {“and”: [RULE3, RULE4]}]}, RULEx 可以是基本阈值规则,但必须包含“type”字段,例如:{“threshold”: 0.8,”meter_name”:”cpu_util”,”type”:”threshold”}
- --stack-id <堆栈名称或ID>¶
包含负载均衡池和成员的 Heat 堆栈的名称或 ID。如果负载均衡池中的某个成员不正常,则会在根堆栈上触发更新。
- --pool-id <负载均衡池名称或ID>¶
负载均衡池的名称或 ID,将评估每个成员的运行状况。
- --autoscaling-group-id <自动伸缩组名称或ID>¶
包含负载均衡成员的 Heat 自动伸缩组的 ID。不正常的成员将被标记为不正常,然后会在根堆栈上触发更新。
- 告警 ID 或 名称¶
告警的 ID 或名称。
此命令由 aodhclient 插件提供。
告警历史搜索¶
基于查询显示所有告警的历史记录
openstack alarm-history search
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--query QUERY]
- --sort-column 排序列¶
指定要对数据进行排序的列(首先指定的列具有优先级,不存在的列将被忽略),可以重复
- --sort-ascending¶
按升序对列进行排序
- --sort-descending¶
按降序对列进行排序
- --query <查询>¶
aodh 支持的丰富查询,例如 project_id!=my-id user_id=foo 或 user_id=bar
此命令由 aodhclient 插件提供。
告警历史显示¶
显示告警的历史记录
openstack alarm-history show
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--limit <LIMIT>]
[--marker <MARKER>]
[--sort <SORT_KEY:SORT_DIR>]
<alarm-id>
- --sort-column 排序列¶
指定要对数据进行排序的列(首先指定的列具有优先级,不存在的列将被忽略),可以重复
- --sort-ascending¶
按升序对列进行排序
- --sort-descending¶
按降序对列进行排序
- --limit <限制>¶
返回的资源数量(默认值为服务器默认值)
- --marker <标记>¶
前一个列表的最后一项。返回在此值之后的结果,支持的标记是 event_id。
- --sort <排序键:排序方向>¶
资源属性的排序。例如 timestamp:desc
- 告警ID¶
告警的ID
此命令由 aodhclient 插件提供。
告警功能列表¶
列出告警服务的capabilities
openstack alarming capabilities list
此命令由 aodhclient 插件提供。