32 KiB
A time series storage and resources index service (gnocchi) command-line client
The gnocchi client is the command-line interface (CLI) for the A time series storage and resources index service (gnocchi) API and its extensions.
This chapter documents gnocchi version 3.1.1.
For help on a specific gnocchi command, enter:
$ gnocchi help COMMANDgnocchi usage
usage: gnocchi [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--gnocchi-api-version GNOCCHI_API_VERSION] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
[--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>]
[--user <gnocchi user>] [--endpoint <gnocchi endpoint>]gnocchi optional arguments
--version-
show program's version number and exit
-v, --verbose-
Increase verbosity of output. Can be repeated.
-q, --quiet-
Suppress output except warnings and errors.
--log-file LOG_FILE-
Specify a file to log output. Disabled by default.
-h, --help-
Show help message and exit.
--debug-
Show tracebacks on errors.
--gnocchi-api-version GNOCCHI_API_VERSION-
Defaults to
env[GNOCCHI_API_VERSION]or 1. --os-auth-type <name>, --os-auth-plugin <name>-
Authentication type to use
gnocchi archive-policy create
usage: gnocchi archive-policy create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] -d <DEFINITION>
[-b BACK_WINDOW] [-m AGGREGATION_METHODS]
nameCreate an archive policy
Positional arguments:
name-
name of the archive policy
Optional arguments:
-h, --help-
show this help message and exit
-d <DEFINITION>, --definition <DEFINITION>-
two attributes (separated by ',') of an archive policy definition with its name and value separated with a ':'
-b BACK_WINDOW, --back-window BACK_WINDOW-
back window of the archive policy
-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS-
aggregation method of the archive policy
gnocchi archive-policy delete
usage: gnocchi archive-policy delete [-h] nameDelete an archive policy
Positional arguments:
name-
Name of the archive policy
Optional arguments:
-h, --help-
show this help message and exit
gnocchi archive-policy list
usage: gnocchi archive-policy list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List archive policies
Optional arguments:
-h, --help-
show this help message and exit
gnocchi archive-policy show
usage: gnocchi archive-policy show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX]
nameShow an archive policy
Positional arguments:
name-
Name of the archive policy
Optional arguments:
-h, --help-
show this help message and exit
gnocchi archive-policy update
usage: gnocchi archive-policy update [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] -d <DEFINITION>
nameUpdate an archive policy
Positional arguments:
name-
name of the archive policy
Optional arguments:
-h, --help-
show this help message and exit
-d <DEFINITION>, --definition <DEFINITION>-
two attributes (separated by ',') of an archive policy definition with its name and value separated with a ':'
gnocchi archive-policy-rule create
usage: gnocchi archive-policy-rule create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] -a
ARCHIVE_POLICY_NAME -m
METRIC_PATTERN
nameCreate an archive policy rule
Positional arguments:
name-
Rule name
Optional arguments:
-h, --help-
show this help message and exit
-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME-
Archive policy name
-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN-
Wildcard of metric name to match
gnocchi archive-policy-rule delete
usage: gnocchi archive-policy-rule delete [-h] nameDelete an archive policy rule
Positional arguments:
name-
Name of the archive policy rule
Optional arguments:
-h, --help-
show this help message and exit
gnocchi archive-policy-rule list
usage: gnocchi archive-policy-rule list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List archive policy rules
Optional arguments:
-h, --help-
show this help message and exit
gnocchi archive-policy-rule show
usage: gnocchi archive-policy-rule show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX]
nameShow an archive policy rule
Positional arguments:
name-
Name of the archive policy rule
Optional arguments:
-h, --help-
show this help message and exit
gnocchi benchmark measures add
usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] [--workers WORKERS]
--count COUNT [--batch BATCH]
[--timestamp-start TIMESTAMP_START]
[--timestamp-end TIMESTAMP_END] [--wait]
metricDo benchmark testing of adding measurements
Positional arguments:
metric-
ID or name of the metric
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
--workers WORKERS, -w WORKERS-
Number of workers to use
--count COUNT, -n COUNT-
Number of total measures to send
--batch BATCH, -b BATCH-
Number of measures to send in each batch
--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START-
First timestamp to use
--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END-
Last timestamp to use
--wait-
Wait for all measures to be processed
gnocchi benchmark measures show
usage: gnocchi benchmark measures show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX]
[--resource-id RESOURCE_ID]
[--aggregation AGGREGATION]
[--start START] [--stop STOP]
[--granularity GRANULARITY] [--refresh]
[--resample RESAMPLE]
[--workers WORKERS] --count COUNT
metricDo benchmark testing of measurements show
Positional arguments:
metric-
ID or name of the metric
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
--aggregation AGGREGATION-
aggregation to retrieve
--start START-
beginning of the period
--stop STOP-
end of the period
--granularity GRANULARITY-
granularity to retrieve
--refresh-
force aggregation of all known measures
--resample RESAMPLE-
granularity to resample time-series to (in seconds)
--workers WORKERS, -w WORKERS-
Number of workers to use
--count COUNT, -n COUNT-
Number of total measures to send
gnocchi benchmark metric create
usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME]
[--workers WORKERS] --count COUNT
[--keep]Do benchmark testing of metric creation
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME-
name of the archive policy
--workers WORKERS, -w WORKERS-
Number of workers to use
--count COUNT, -n COUNT-
Number of metrics to create
--keep, -k-
Keep created metrics
gnocchi benchmark metric show
usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] [--workers WORKERS]
--count COUNT
metric [metric ...]Do benchmark testing of metric show
Positional arguments:
metric-
ID or name of the metrics
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
--workers WORKERS, -w WORKERS-
Number of workers to use
--count COUNT, -n COUNT-
Number of metrics to get
gnocchi capabilities list
usage: gnocchi capabilities list [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX]List capabilities
Optional arguments:
-h, --help-
show this help message and exit
gnocchi measures add
usage: gnocchi measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metricAdd measurements to a metric
Positional arguments:
metric-
ID or name of the metric
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
-m MEASURE, --measure MEASURE-
timestamp and value of a measure separated with a '@'
gnocchi measures aggregation
usage: gnocchi measures aggregation [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--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]Get measurements of aggregated metrics
Optional arguments:
-h, --help-
show this help message and exit
-m METRIC [METRIC ...], --metric METRIC [METRIC ...]-
metrics IDs or metric name
--aggregation AGGREGATION-
granularity aggregation function to retrieve
--reaggregation REAGGREGATION-
groupby aggregation function to retrieve
--start START-
beginning of the period
--stop STOP-
end of the period
--granularity GRANULARITY-
granularity to retrieve
--needed-overlap NEEDED_OVERLAP-
percent of datapoints in each metrics required
--query QUERY-
A query to filter resource. The syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!="1" and memory>=24). Use "" to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.
--resource-type RESOURCE_TYPE-
Resource type to query
--groupby GROUPBY-
Attribute to use to group resources
--refresh-
force aggregation of all known measures
--resample RESAMPLE-
granularity to resample time-series to (in seconds)
--fill FILL-
Value to use when backfilling timestamps with missing values in a subset of series. Value should be a float or 'null'.
gnocchi measures batch-metrics
usage: gnocchi measures batch-metrics [-h] filePositional arguments:
file-
File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format
Optional arguments:
-h, --help-
show this help message and exit
gnocchi measures batch-resources-metrics
usage: gnocchi measures batch-resources-metrics [-h] [--create-metrics] filePositional arguments:
file-
File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format
Optional arguments:
-h, --help-
show this help message and exit
--create-metrics-
Create unknown metrics
gnocchi measures show
usage: gnocchi measures show [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--resource-id RESOURCE_ID]
[--aggregation AGGREGATION] [--start START]
[--stop STOP] [--granularity GRANULARITY]
[--refresh] [--resample RESAMPLE]
metricGet measurements of a metric
Positional arguments:
metric-
ID or name of the metric
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
--aggregation AGGREGATION-
aggregation to retrieve
--start START-
beginning of the period
--stop STOP-
end of the period
--granularity GRANULARITY-
granularity to retrieve
--refresh-
force aggregation of all known measures
--resample RESAMPLE-
granularity to resample time-series to (in seconds)
gnocchi metric create
usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent] [--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME]
[--unit UNIT]
[METRIC_NAME]Create a metric
Positional arguments:
METRIC_NAME-
Name of the metric
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME-
name of the archive policy
--unit UNIT, -u UNIT-
unit of the metric
gnocchi metric delete
usage: gnocchi metric delete [-h] [--resource-id RESOURCE_ID]
metric [metric ...]Delete a metric
Positional arguments:
metric-
IDs or names of the metric
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
gnocchi metric list
usage: gnocchi metric list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit <LIMIT>] [--marker <MARKER>]
[--sort <SORT>]List metrics
Optional arguments:
-h, --help-
show this help message and exit
--limit <LIMIT>-
Number of metrics to return (Default is server default)
--marker <MARKER>-
Last item of the previous listing. Return the next results after this value
--sort <SORT>-
Sort of metric attribute (example: user_id:desc-nullslast
gnocchi metric show
usage: gnocchi metric show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty]
[--noindent] [--prefix PREFIX]
[--resource-id RESOURCE_ID]
metricShow a metric
Positional arguments:
metric-
ID or name of the metric
Optional arguments:
-h, --help-
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID-
ID of the resource
gnocchi resource batch delete
usage: gnocchi resource batch delete [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] [--type RESOURCE_TYPE]
queryDelete a batch of resources based on attribute values
Positional arguments:
query-
A query to filter resource. The syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!="1" and memory>=24). Use "" to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.
Optional arguments:
-h, --help-
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE-
Type of resource
gnocchi resource create
usage: gnocchi resource create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE] [-a ATTRIBUTE]
[-m ADD_METRIC] [-n CREATE_METRIC]
resource_idCreate a resource
Positional arguments:
resource_id-
ID of the resource
Optional arguments:
-h, --help-
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE-
Type of resource
-a ATTRIBUTE, --attribute ATTRIBUTE-
name and value of an attribute separated with a ':'
-m ADD_METRIC, --add-metric ADD_METRIC-
name:id of a metric to add
-n CREATE_METRIC, --create-metric CREATE_METRIC-
name:archive_policy_name of a metric to create
gnocchi resource delete
usage: gnocchi resource delete [-h] resource_idDelete a resource
Positional arguments:
resource_id-
ID of the resource
Optional arguments:
-h, --help-
show this help message and exit
gnocchi resource history
usage: gnocchi resource history [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--details] [--limit <LIMIT>]
[--marker <MARKER>] [--sort <SORT>]
[--type RESOURCE_TYPE]
resource_idShow the history of a resource
Positional arguments:
resource_id-
ID of a resource
Optional arguments:
-h, --help-
show this help message and exit
--details-
Show all attributes of generic resources
--limit <LIMIT>-
Number of resources to return (Default is server default)
--marker <MARKER>-
Last item of the previous listing. Return the next results after this value
--sort <SORT>-
Sort of resource attribute (example: user_id:desc-nullslast
--type RESOURCE_TYPE, -t RESOURCE_TYPE-
Type of resource
gnocchi resource list
usage: gnocchi resource list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--details] [--history] [--limit <LIMIT>]
[--marker <MARKER>] [--sort <SORT>]
[--type RESOURCE_TYPE]List resources
Optional arguments:
-h, --help-
show this help message and exit
--details-
Show all attributes of generic resources
--history-
Show history of the resources
--limit <LIMIT>-
Number of resources to return (Default is server default)
--marker <MARKER>-
Last item of the previous listing. Return the next results after this value
--sort <SORT>-
Sort of resource attribute (example: user_id:desc-nullslast
--type RESOURCE_TYPE, -t RESOURCE_TYPE-
Type of resource
gnocchi resource show
usage: gnocchi resource show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE]
resource_idShow a resource
Positional arguments:
resource_id-
ID of a resource
Optional arguments:
-h, --help-
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE-
Type of resource
gnocchi resource update
usage: gnocchi resource update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE] [-a ATTRIBUTE]
[-m ADD_METRIC] [-n CREATE_METRIC]
[-d DELETE_METRIC]
resource_idUpdate a resource
Positional arguments:
resource_id-
ID of the resource
Optional arguments:
-h, --help-
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE-
Type of resource
-a ATTRIBUTE, --attribute ATTRIBUTE-
name and value of an attribute separated with a ':'
-m ADD_METRIC, --add-metric ADD_METRIC-
name:id of a metric to add
-n CREATE_METRIC, --create-metric CREATE_METRIC-
name:archive_policy_name of a metric to create
-d DELETE_METRIC, --delete-metric DELETE_METRIC-
Name of a metric to delete
gnocchi resource-type create
usage: gnocchi resource-type create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] [-a ATTRIBUTE]
nameCreate a resource type
Positional arguments:
name-
name of the resource type
Optional arguments:
-h, --help-
show this help message and exit
-a ATTRIBUTE, --attribute ATTRIBUTE-
attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:… For example: display_name:string:true:max_length=255
gnocchi resource-type delete
usage: gnocchi resource-type delete [-h] nameDelete a resource type
Positional arguments:
name-
name of the resource type
Optional arguments:
-h, --help-
show this help message and exit
gnocchi resource-type list
usage: gnocchi resource-type list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List resource types
Optional arguments:
-h, --help-
show this help message and exit
gnocchi resource-type show
usage: gnocchi resource-type show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX]
nameShow a resource type
Positional arguments:
name-
name of the resource type
Optional arguments:
-h, --help-
show this help message and exit
gnocchi resource-type update
usage: gnocchi resource-type update [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] [-a ATTRIBUTE]
[-r REMOVE_ATTRIBUTE]
namePositional arguments:
name-
name of the resource type
Optional arguments:
-h, --help-
show this help message and exit
-a ATTRIBUTE, --attribute ATTRIBUTE-
attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:… For example: display_name:string:true:max_length=255
-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE-
attribute name
gnocchi status
usage: gnocchi status [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--print-empty] [--noindent]
[--prefix PREFIX]Show the status of measurements processing
Optional arguments:
-h, --help-
show this help message and exit