Gnocchi: 3、Gnocchi命令行使用

Gnocchi命令行使用

原文地址：http://gnocchi.xyz/gnocchiclient/shell.html

Gnocchiclient:作用是直接在命令行下与gnocchi交互。

安装gnocchiclient: 

pip install gnocchiclient

 

1 Gnocchi shell使用

Gnocchi shell可以用于在命令行下与Gnocchi交互。它完全支持Gnocchi API

。

2 验证方式

你需要提供验证方法和针对gnocchi的服务凭证。

3 没有验证

如果你在无需验证的情况下使用Gnocchi，需要在你的环境导入下面的变量。

 

 

 

exportOS_AUTH_TYPE=gnocchi-noauth exportGNOCCHI_USER_ID= exportGNOCCHI_PROJECT_ID= exportGNOCCHI_ENDPOINT=http://urlofgnocchi

注意： OS_AUTH_TYPE被所有支持Keystone的客户端所使用。提供

--os-auth-plugin

如果其他客户端在会话session中使用，请提供gnocchi-noauth

4 基本验证

如果你通过基本的验证来使用Gnocchi,在环境中倒入下面的变量

exportOS_AUTH_TYPE=gnocchi-basic exportGNOCCHI_USER= exportGNOCCHI_ENDPOINT=http://urlofgnocchi

注意：OS_AUTH_TYPE被所有支持Keystone的客户端所使用。提供

--os-auth-plugin

给客户端如果其他客户端在会话中使用。

 

5 Openstack Keystone验证

如果你通过Keystone的验证来使用Gnocchi，导入下面环境变量的合适值

exportOS_AUTH_TYPE=password exportOS_USERNAME=user exportOS_PASSWORD=pass exportOS_TENANT_NAME=myproject exportOS_AUTH_URL=http://auth.example.com:5000/v2.0

 

命令行工具将会根据你提供的凭证来再次验证每个请求。你可以

--endpoint

和

--os-auth-token

通过手工提供一个auth token来覆盖这个行为。你可以选择设置下面的环境变量。

exportGNOCCHI_ENDPOINT=http://gnocchi.example.org:8041 exportOS_AUTH_PLUGIN=token exportOS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155

 

更多信息，查看：https://docs.openstack.org/developer/keystoneauth/

 

6 命令描述

为了查看一个指定的gnocchi命令，输入

gnocchi help COMMAND

 

Gnocchi usage

usage: gnocchi [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]                [--gnocchi-api-version GNOCCHI_API_VERSION] [--insecure]                [--os-cacert ] [--os-cert ]                [--os-key ] [--timeout ] [--os-auth-type ]                [--user ] [--endpoint ]

 

Gnocchi选项参数

--version

显示proram程序的版本数字并退出

-v, --verbose

增加冗余输出。可以被替代。

-q, --quiet

阻止除了警告和错误的输出

--log-file LOG_FILE

指明一个文件用于日志的输出。默认是禁止输出的

-h, --help

显示帮助消息并退出。

--debug

显示错误的堆栈信息

--gnocchi-api-version GNOCCHI_API_VERSION

默认来自env[GNOCCHI_API_VERSION]或者1

--os-auth-type , --os-auth-plugin 

 

6.1创建归档策略

gnocchi archive-policy create

usage: gnocchi archive-policy create [-h]                                      [-f {html,json,shell,table,value,yaml}]                                      [-c COLUMN] [--max-width ]                                      [--print-empty] [--prefix PREFIX]                                      [--noindent] -d                                      [-b BACK_WINDOW] [-m AGGREGATION_METHODS]                                      name

 

2 创建一个归档策略

位置参数

Name

归档策略的名字

可选的参数

-h, --help

显示帮助消息并退出

-d , --definition 

通过”,”分割的两个属性，这两个属性是一个归档策略根据名字和值定义并以”:”分割的

-b BACK_WINDOW, --back-window BACK_WINDOW

归档策略的back window ?

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

归档策略的聚集方法

 

6.2删除归档策略

gnocchi archive-policydelete

usage: gnocchi archive-policy delete [-h] name

删除一个归档策略

位置参数

name

归档策略的名字

可选的参数

-h, --help

显示帮助消息并退出

6.3列出归档策略

 

gnocchi archive-policy list

usage: gnocchi archive-policy list [-h] [-f {csv,html,json,table,value,yaml}]

                                   [-c COLUMN] [--max-width ]

                                   [--print-empty] [--noindent]

                                   [--quote {all,minimal,none,nonnumeric}]

显示归档策略列表

可选参数

-h, --help

显示帮助消息并退出

6.4显示一个归档策略

gnocchi archive-policy show

usage: gnocchi archive-policy show [-h]

                                   [-f {html,json,shell,table,value,yaml}]

                                   [-c COLUMN] [--max-width ]

                                   [--print-empty] [--prefix PREFIX]

                                   [--noindent]

                                   name

位置参数：

name

归档策略的名字

可选参数

-h, --help

显示帮助消息并退出

6.5更新一个归档策略

gnocchi archive-policyupdate

usage: gnocchi archive-policy update [-h]                                      [-f {html,json,shell,table,value,yaml}]                                      [-c COLUMN] [--max-width ]                                      [--print-empty] [--prefix PREFIX]                                      [--noindent] -d                                      name

 

位置参数

name

归档策略的名字

可选参数

-h, --help

显示帮助消息并退出

-d , --definition 

用名字和值定义(以”:”分割)的归档策略的两个属性

6.6创建一个归档策略规则

gnocchi archive-policy-rulecreate

usage: gnocchi archive-policy-rule create [-h]                                           [-f {html,json,shell,table,value,yaml}]                                           [-c COLUMN] [--max-width ]                                           [--print-empty] [--prefix PREFIX]                                           [--noindent] -a ARCHIVE_POLICY_NAME                                           -m METRIC_PATTERN                                           name

位置参数

name

规则的名字

可选参数

-h, --help

显示帮助消息并退出

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

归档策略的名字

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

需要匹配的计量项名字的通配符

6．7删除一个归档策略的规则

gnocchi archive-policy-ruledelete

usage: gnocchi archive-policy-rule delete [-h] name

 

位置参数

name

归档策略规则的名字

可选参数

-h, --help

显示帮助消息并退出

6.8列出归档策规则

 

gnocchi archive-policy-rulelist

usage: gnocchi archive-policy-rule list [-h]                                         [-f {csv,html,json,table,value,yaml}]                                         [-c COLUMN] [--max-width ]                                         [--print-empty] [--noindent]                                         [--quote {all,minimal,none,nonnumeric}]

 

可选参数

h, --help

显示帮助消息并退出

6.9显示一个归档策略的规则

gnocchi archive-policy-ruleshow

usage: gnocchi archive-policy-rule show [-h]                                         [-f {html,json,shell,table,value,yaml}]                                         [-c COLUMN] [--max-width ]                                         [--print-empty] [--prefix PREFIX]                                         [--noindent]                                         name

 

位置参数

name

归档策略规则的名字

可选参数

-h, --help

显示帮助消息并退出

6.10做添加测量项的基准测试

 

gnocchi benchmark measuresadd

usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID]                                       [-f {html,json,shell,table,value,yaml}]                                       [-c COLUMN] [--max-width ]                                       [--print-empty] [--prefix PREFIX]                                       [--noindent] [--workers WORKERS] --count                                       COUNT [--batch BATCH]                                       [--timestamp-start TIMESTAMP_START]                                       [--timestamp-end TIMESTAMP_END] [--wait]                                       metric

 

做添加测量项的基准测试

位置参数

metric

计量项的名字或者id

可选参数

-h, --help

显示帮助消息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的id

--workers WORKERS, -w WORKERS

使用的workers工作者的个数

--count COUNT, -n COUNT

所有发送的测量项的个数

--batch BATCH, -b BATCH

每一批发送的measures测量值的个数

--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START

首次使用的时间戳

--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END

最后使用的时间戳

--wait

等待所有的测量值measures被处理

6.11做计量项基准测试的显示

 

gnocchi benchmark measuresshow

usage: gnocchi benchmark measures show [-h]                                        [-f {html,json,shell,table,value,yaml}]                                        [-c COLUMN] [--max-width ]                                        [--print-empty] [--prefix PREFIX]                                        [--noindent]                                        [--resource-id RESOURCE_ID]                                        [--aggregation AGGREGATION]                                        [--start START] [--stop STOP]                                        [--granularity GRANULARITY] [--refresh]                                        [--resample RESAMPLE]                                        [--workers WORKERS] --count COUNT                                        metric

 

metric

计量项metric的id或者名字

可选参数

-h, --help

显示帮助消息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的id

--aggregation AGGREGATION

用于检索的聚集方法

--start START

时间段的起始点

--stop STOP

时间段的终止点

--granularity GRANULARITY

用于检索的粒度

--refresh

强制使用所有知道的聚集方法

--resample RESAMPLE

再次采样的时间序列的丢（秒数）

--workers WORKERS, -w WORKERS

使用的工作者workers数量

--count COUNT, -n COUNT

发送的所有计量项的个数

6.12做计量项创建的基本测试

gnocchi benchmark metriccreate

usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID]                                        [-f {html,json,shell,table,value,yaml}]                                        [-c COLUMN] [--max-width ]                                        [--print-empty] [--prefix PREFIX]                                        [--noindent]                                        [--archive-policy-name ARCHIVE_POLICY_NAME]                                        [--workers WORKERS] --count COUNT                                        [--keep]

 

可选参数：

-h, --help

显示帮助消息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源id

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

归档策略的名字

--workers WORKERS, -w WORKERS

使用的工作者数量

--count COUNT, -n COUNT

创建的计量项的个数

--keep, -k

维持创建的计量项？

6.13做计量项显示的基准测试

gnocchi benchmark metricshow

usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID]                                      [-f {html,json,shell,table,value,yaml}]                                      [-c COLUMN] [--max-width ]                                      [--print-empty] [--prefix PREFIX]                                      [--noindent] [--workers WORKERS] --count                                      COUNT                                      metric [metric ...]

位置参数

metric

计量项的id或者名字

可选参数

-h, --help

显示帮助消息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源id

--workers WORKERS, -w WORKERS

使用的工作者数量

--count COUNT, -n COUNT

获取的计量项的个数

6.14列出容量

gnocchi capabilities list

usage: gnocchi capabilities list [-h] [-f {html,json,shell,table,value,yaml}]                                  [-c COLUMN] [--max-width ]                                  [--print-empty] [--prefix PREFIX]                                  [--noindent]

可选参数

-h, --help

显示帮助消息并退出

6.15添加对metric的计量

gnocchi measures add

usage: gnocchi measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metric

位置参数

metric

metric的id或者名字

可选参数

-h, --help

显示帮助消息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的id

-m MEASURE, --measure MEASURE

时间戳和测量的一个测量的值（用@分割）

6.16获取聚集的计量项的测量值

 

gnocchi measuresaggregation

usage: gnocchi measures aggregation [-h] [-f {csv,html,json,table,value,yaml}]                                     [-c COLUMN] [--max-width ]                                     [--print-empty] [--noindent]                                     [--quote {all,minimal,none,nonnumeric}] -m                                     METRIC [METRIC ...]                                     [--aggregation AGGREGATION]                                     [--reaggregation REAGGREGATION]                                     [--start START] [--stop STOP]                                     [--granularity GRANULARITY]                                     [--needed-overlap NEEDED_OVERLAP]                                     [--query QUERY]                                     [--resource-type RESOURCE_TYPE]                                     [--groupby GROUPBY] [--refresh]                                     [--resample RESAMPLE] [--fill FILL]

 

可选参数

-h, --help

显示帮助消息并退出

-m METRIC [METRIC ...], --metric METRIC [METRIC ...]

计量的ids或者名字

--aggregation AGGREGATION

用于检索的粒度聚集

--start START

时间段的起始点

--stop STOP

时间段的结束点

--granularity GRANULARITY

用于检索的粒度

--needed-overlap NEEDED_OVERLAP

每次metrics(计量项)所需要的数据点的百分比

--query QUERY

用于过滤资源。The syntax is a combination of attribute, operator and value. Forexample: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with acertain id. More complex queries can be built, e.g.: not (flavor_id!=”1” andmemory>=24). Use “” to force data to be interpreted as string. Supportedoperators are: not, and, ∧ or, ∨, >=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in,like, ≠, ≥, ≤, like, in.

 

--resource-type RESOURCE_TYPE

查询的资源类型

-groupby GROUPBY

用于分组资源的属性

--refresh

强制对使用所有知道的聚集方法

--resample RESAMPLE

再次采样的时间蓄力的粒度（秒数）

6.17

gnocchi measuresbatch-metrics

usage: gnocchi measures batch-metrics [-h] file

位置参数

file

用于输入的包含测量值measurement的文件

 (seeGnocchi REST API docs for the format

可选参数

-h, --help

 

gnocchi measuresbatch-resources-metrics

usage: gnocchi measures batch-resources-metrics [-h] [--create-metrics] file

位置参数

file

用于输入的包含测量值measurement的文件

 (seeGnocchi REST API docs for the format

可选参数

-h, --help

--create-metrics

创建未知的计量项

gnocchi measures show

usage: gnocchi measures show [-h] [-f {csv,html,json,table,value,yaml}]                              [-c COLUMN] [--max-width ]                              [--print-empty] [--noindent]                              [--quote {all,minimal,none,nonnumeric}]                              [--resource-id RESOURCE_ID]                              [--aggregation AGGREGATION] [--start START]                              [--stop STOP] [--granularity GRANULARITY]                              [--refresh] [--resample RESAMPLE]                              metric

获取计量项的测量值

位置参数

metric

计量项的id或者名字

可选参数

-h, --help

显示出帮助消息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的id

--aggregation AGGREGATION

用于检索的聚集

--start START

时间点的开始值

--stop STOP

时间点的结束值

--granularity GRANULARITY

用于检索的粒度

--refresh

强制使用所有已知的聚集方法

--resample RESAMPLE

再次采样时间序列的粒度（秒数）

gnocchi metric create

usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID]                              [-f {html,json,shell,table,value,yaml}]                              [-c COLUMN] [--max-width ]                              [--print-empty] [--prefix PREFIX] [--noindent]                              [--archive-policy-name ARCHIVE_POLICY_NAME]                              [--unit UNIT]                              [METRIC_NAME]

创建一个计量项

位置参数：

METRIC_NAME

计量项的名称

可选参数

-h, --help

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源id

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

归档策略的名字

--unit UNIT, -u UNIT

计量项的单位

gnocchi metric delete

usage: gnocchi metric delete [-h] [--resource-id RESOURCE_ID]                              metric [metric ...]

删除一个计量项

位置参数

Metric

计量项的id或者名字

可选参数

-h, --help

显示帮助消息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源id

gnocchi metric list

usage: gnocchi metric list [-h] [-f {csv,html,json,table,value,yaml}]                            [-c COLUMN] [--max-width ] [--print-empty]                            [--noindent]                            [--quote {all,minimal,none,nonnumeric}]                            [--limit ] [--marker ]                            [--sort ]

列出计量项

可选参数

-h, --help

显示帮助消息并退出

--limit 

返回的计量项的个数(默认是服务端默认的)

--marker 

之前列表的最后一个条目item。返回这个值的下一个结果。

--sort 

用于排序的计量属性（例如：user_id:desc-nullslast）

gnocchi metric show

usage: gnocchi metric show [-h] [-f {html,json,shell,table,value,yaml}]                            [-c COLUMN] [--max-width ] [--print-empty]                            [--prefix PREFIX] [--noindent]                            [--resource-id RESOURCE_ID]                            metric

显示一个监控项

位置参数

Metric

Metri的id或者名字

可选参数

-h, --help

显示帮助消息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的id

gnocchi resource batchdelete

usage: gnocchi resource batch delete [-h]                                      [-f {html,json,shell,table,value,yaml}]                                      [-c COLUMN] [--max-width ]                                      [--print-empty] [--prefix PREFIX]                                      [--noindent] [--type RESOURCE_TYPE]                                      query

根据属性的值批量删除资源

位置参数

query

用于过滤资源的查询。语法是一些列属性的组合，操作符合值。例如：id =90d58eea-70d7-4294-a49a-170dcdf44c3c

将会过滤掉指定id的资源。更多复杂的查询可以被创建，例如：

 not(flavor_id!=”1” and memory>=24)

使用“”来强制数据被解释为字符串。支持的操作符包括：

not,and, ∧ or, ∨, >=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in,like, ≠, ≥, ≤, like, in.

 

可选参数

-h, --help

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源的类型

gnocchi resource create

usage: gnocchi resource create [-h] [-f {html,json,shell,table,value,yaml}]                                [-c COLUMN] [--max-width ]                                [--print-empty] [--prefix PREFIX] [--noindent]                                [--type RESOURCE_TYPE] [-a ATTRIBUTE]                                [-m ADD_METRIC] [-n CREATE_METRIC]                                resource_id

创建一个资源

位置参数：

resource_id

资源id

可选参数

-h, --help

-type RESOURCE_TYPE, -t RESOURCE_TYPE

资源的类型

-a ATTRIBUTE, --attribute ATTRIBUTE

属性用”:”分割的名字和值

-m ADD_METRIC, --add-metric ADD_METRIC

name:待添加的计量项的id

-n CREATE_METRIC, --create-metric CREATE_METRIC

name:待创建的计量项的归档策略名称

gnocchi resource delete

usage: gnocchi resource delete [-h] resource_id

删除一个资源

位置参数

resource_id

资源的id

可选参数

-h, --help

显示帮助消息并退出

gnocchi resource history

usage: gnocchi resource history [-h] [-f {csv,html,json,table,value,yaml}]                                 [-c COLUMN] [--max-width ]                                 [--print-empty] [--noindent]                                 [--quote {all,minimal,none,nonnumeric}]                                 [--details] [--limit ]                                 [--marker ] [--sort ]                                 [--type RESOURCE_TYPE]                                 resource_id

显示资源的历史

位置参数

resource_id

资源的id

可选参数

-h, --help

--details

显示generic资源的所有属性

--limit 

待返回的资源个数（默认是服务器的默认设置的）

--marker 

之前列表最后一项。返回这个值的下一项

--sort 

资源属性的排序（例如：user_id:desc-nullslast）

gnocchi resource list

usage: gnocchi resource list [-h] [-f {csv,html,json,table,value,yaml}]                              [-c COLUMN] [--max-width ]                              [--print-empty] [--noindent]                              [--quote {all,minimal,none,nonnumeric}]                              [--details] [--history] [--limit ]                              [--marker ] [--sort ]                              [--type RESOURCE_TYPE]

列出资源

可选参数

-h, --help

--details资源的所有属性

--history

显示资源的历史

--limit 

返回的资源个数（默认是服务器设置）

--marker 

之前列表最后一项。返回当前值的下一项

--sort 

资源属性的排序（例如:user_id:desc-nullslast）

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源的类型

gnocchi resource show

usage: gnocchi resource show [-h] [-f {html,json,shell,table,value,yaml}]                              [-c COLUMN] [--max-width ]                              [--print-empty] [--prefix PREFIX] [--noindent]                              [--type RESOURCE_TYPE]                              resource_id

显示一个资源

位置参数

resource_id

资源id

可选参数

-h, --help

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源的类型

gnocchi resource update

usage: gnocchi resource update [-h] [-f {html,json,shell,table,value,yaml}]                                [-c COLUMN] [--max-width ]                                [--print-empty] [--prefix PREFIX] [--noindent]                                [--type RESOURCE_TYPE] [-a ATTRIBUTE]                                [-m ADD_METRIC] [-n CREATE_METRIC]                                [-d DELETE_METRIC]                                resource_id

 

更新一个资源

位置参数：

resource_id

资源id

可选参数

-h, --help

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源的类型

-a ATTRIBUTE, --attribute ATTRIBUTE

用”:”分割的属性的名称和值

-m ADD_METRIC, --add-metric ADD_METRIC

name:待添加的计量项的id

-n CREATE_METRIC, --create-metric CREATE_METRIC

name:待创建的计量项的归档策略

-d DELETE_METRIC, --delete-metric DELETE_METRIC

待删除的计量项的名字

gnocchi resource-typecreate

usage: gnocchi resource-type create [-h]                                     [-f {html,json,shell,table,value,yaml}]                                     [-c COLUMN] [--max-width ]                                     [--print-empty] [--prefix PREFIX]                                     [--noindent] [-a ATTRIBUTE]                                     name

创建一个资源类型

位置参数：

name

资源类型的名字

可选参数：

-h, --help

-a ATTRIBUTE, --attribute ATTRIBUTE

属性定义，属性名：属性类型：属性是否需要：属性类型选项名称=属性类型选项值

例如：

display_name:string:true:max_length=255

gnocchi resource-typedelete

usage: gnocchi resource-type delete [-h] name

删除一个资源类型

位置参数

name

资源类型的名称

可选参数

-h, --help

nocchi resource-type list

usage: gnocchi resource-type list [-h] [-f {csv,html,json,table,value,yaml}]                                   [-c COLUMN] [--max-width ]                                   [--print-empty] [--noindent]                                   [--quote {all,minimal,none,nonnumeric}]

列出资源类型

可选参数

-h, --help

gnocchi resource-type show

usage: gnocchi resource-type show [-h] [-f {html,json,shell,table,value,yaml}]                                   [-c COLUMN] [--max-width ]                                   [--print-empty] [--prefix PREFIX]                                   [--noindent]                                   name

显示一个资源类型

位置参数

name

资源类型的名称

可选参数

-h, --help

显示帮助信息并退出

gnocchi resource-typeupdate

usage: gnocchi resource-type update [-h]                                     [-f {html,json,shell,table,value,yaml}]                                     [-c COLUMN] [--max-width ]                                     [--print-empty] [--prefix PREFIX]                                     [--noindent] [-a ATTRIBUTE]                                     [-r REMOVE_ATTRIBUTE]                                     name

位置参数：

name

资源类型的名称

可选参数：

-h, --help

-a ATTRIBUTE, --attribute ATTRIBUTE

属性定义，属性名：属性类型：属性是否需要：属性类型选项名称=属性类型选项值

例如：

display_name:string:true:max_length=255

 

-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE

属性名称

gnocchi status

usage: gnocchi status [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN]                       [--max-width ] [--print-empty]                       [--prefix PREFIX] [--noindent]

显示正在处理的测量值的状态

可选参数

-h, --help

 

Gnocchiclient的python api参见：

http://gnocchi.xyz/gnocchiclient/api.html