`orca metric`¶

Manage Gnocchi metrics, measures and resources.

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca metric¶

Query metrics, measures & resources (Gnocchi).

Usage:

orca metric [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

archive-policy: Manage Gnocchi archive policies (compound noun).
archive-policy-create: [deprecated, use 'metric archive-policy create' instead]
archive-policy-delete: [deprecated, use 'metric archive-policy delete' instead]
archive-policy-list: [deprecated, use 'metric archive-policy list' instead]
archive-policy-show: [deprecated, use 'metric archive-policy show' instead]
create: Create a Gnocchi metric.
delete: Delete a Gnocchi metric.
list: List metrics.
measures: Read or push measures (samples) on a Gnocchi metric.
measures-add: [deprecated, use 'metric measures add' instead]
resource: Inspect Gnocchi resources.
resource-list: [deprecated, use 'metric resource list' instead]
resource-show: [deprecated, use 'metric resource show' instead]
resource-type: Inspect Gnocchi resource types (compound noun).
resource-type-create: [deprecated, use 'metric resource-type create' instead]
resource-type-delete: [deprecated, use 'metric resource-type delete' instead]
resource-type-list: [deprecated, use 'metric resource-type list' instead]
resource-type-show: [deprecated, use 'metric resource-type show' instead]
show: Show metric details.
status: Show Gnocchi processing status.

orca metric archive-policy¶

Manage Gnocchi archive policies (compound noun).

Usage:

orca metric archive-policy [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create an archive policy.
delete: Delete an archive policy.
list: List archive policies.
show: Show an archive policy.

orca metric archive-policy create¶

Create an archive policy.

Example: orca metric archive-policy-create my-policy \ --definition 1m:1440 --definition 1h:720

Usage:

orca metric archive-policy create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--definition`	text	Granularity:points pair (repeatable). E.g. 1m:1440.	`Sentinel.UNSET`
`--aggregation-method`	text	Aggregation method (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy delete¶

Delete an archive policy.

Usage:

orca metric archive-policy delete [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy list¶

List archive policies.

Usage:

orca metric archive-policy list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy show¶

Show an archive policy.

Usage:

orca metric archive-policy show [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy-create¶

Create an archive policy.

Example: orca metric archive-policy-create my-policy \ --definition 1m:1440 --definition 1h:720

Usage:

orca metric archive-policy-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--definition`	text	Granularity:points pair (repeatable). E.g. 1m:1440.	`Sentinel.UNSET`
`--aggregation-method`	text	Aggregation method (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy-delete¶

Delete an archive policy.

Usage:

orca metric archive-policy-delete [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy-list¶

List archive policies.

Usage:

orca metric archive-policy-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy-show¶

Show an archive policy.

Usage:

orca metric archive-policy-show [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric create¶

Create a Gnocchi metric.

Usage:

orca metric create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Metric name.	`Sentinel.UNSET`
`--archive-policy-name`	text	Archive policy to use (default: low).	None
`--resource-id`	text	Resource ID to attach the metric to.	None
`--help`	boolean	Show this message and exit.	`False`

orca metric delete¶

Delete a Gnocchi metric.

Usage:

orca metric delete [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca metric list¶

List metrics.

Usage:

orca metric list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric measures¶

Read or push measures (samples) on a Gnocchi metric.

Usage:

orca metric measures [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

add: Push measures to a metric.
show: Get measures (datapoints) for a metric.

orca metric measures add¶

Push measures to a metric.

Example: orca metric measures-add \ --measure 2026-01-01T00:00:00:42.5

Usage:

orca metric measures add [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--measure`	text	Measure as timestamp:value (repeatable). Timestamp: ISO-8601.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric measures show¶

Get measures (datapoints) for a metric.

Examples: orca metric measures --start -1h orca metric measures --start 2026-04-01 --stop 2026-04-08 --granularity 3600

Usage:

orca metric measures show [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--start`	text	Start timestamp (ISO 8601 or relative e.g. -1h).	None
`--stop`	text	Stop timestamp.	None
`--granularity`	text	Granularity in seconds.	None
`--aggregation`	text	Aggregation method.	`mean`
`--limit`	integer	Max measures to return.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric measures-add¶

Push measures to a metric.

Example: orca metric measures-add \ --measure 2026-01-01T00:00:00:42.5

Usage:

orca metric measures-add [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--measure`	text	Measure as timestamp:value (repeatable). Timestamp: ISO-8601.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource¶

Inspect Gnocchi resources.

Usage:

orca metric resource [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List resources.
show: Show resource details and its metrics.

orca metric resource list¶

List resources.

Usage:

orca metric resource list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	text	Resource type to list.	`generic`
`--limit`	integer	Max results. Gnocchi can return very large datasets without a limit.	`100`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource show¶

Show resource details and its metrics.

Usage:

orca metric resource show [OPTIONS] RESOURCE_ID

Options:

Name	Type	Description	Default
`--type`	text	Resource type.	`generic`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-list¶

List resources.

Usage:

orca metric resource-list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	text	Resource type to list.	`generic`
`--limit`	integer	Max results. Gnocchi can return very large datasets without a limit.	`100`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-show¶

Show resource details and its metrics.

Usage:

orca metric resource-show [OPTIONS] RESOURCE_ID

Options:

Name	Type	Description	Default
`--type`	text	Resource type.	`generic`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type¶

Inspect Gnocchi resource types (compound noun).

Usage:

orca metric resource-type [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a Gnocchi resource type.
delete: Delete a Gnocchi resource type.
list: List resource types.
show: Show a Gnocchi resource type.

orca metric resource-type create¶

Create a Gnocchi resource type.

Usage:

orca metric resource-type create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--attribute`	text	Resource attribute key:type (repeatable). E.g. host:string.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type delete¶

Delete a Gnocchi resource type.

Usage:

orca metric resource-type delete [OPTIONS] RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type list¶

List resource types.

Usage:

orca metric resource-type list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type show¶

Show a Gnocchi resource type.

Usage:

orca metric resource-type show [OPTIONS] RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type-create¶

Create a Gnocchi resource type.

Usage:

orca metric resource-type-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--attribute`	text	Resource attribute key:type (repeatable). E.g. host:string.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type-delete¶

Delete a Gnocchi resource type.

Usage:

orca metric resource-type-delete [OPTIONS] RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type-list¶

List resource types.

Usage:

orca metric resource-type-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type-show¶

Show a Gnocchi resource type.

Usage:

orca metric resource-type-show [OPTIONS] RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric show¶

Show metric details.

Usage:

orca metric show [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric status¶

Show Gnocchi processing status.

Usage:

orca metric status [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`