tenantmetriclabel create

Note
This command is introduced in VAST Cluster 5.4.3.

This command creates a metrics label.

Usage

tenantmetriclabel create --key KEY
                        [--default-value VALUE] 
                        [--description DESCRIPTION]

Required Parameters

--key KEY

Sets a unique key for the label.

Specify KEY as a string value.

For example, --key customer.

Options

--default-value VALUE

Sets a default value for the label.

The default value appears in prometheus metrics output for metrics associated with any tenant that does not have the label set with a specific value.

Specify VALUE as a string value.

Default: blank.

For example, --default-value customerX

--description DESCRIPTION

Adds a description for the label.

Specify DESCRIPTION as a string value.

For example, --description "label customers"

Example

This example creates a label for labeling customers. Since it sets the default value to "favoritecustomer" this customer value will appear in metrics for all tenants that you do not explicitly set the label on.

vcli: admin> tenantmetriclabel create --key customer --default-value favoritecustomer --description 'label customers'
Created metric label: customer
+---------------+---------------------+
| Id            | 1                   |
| Key           | customer            |
| Default-value | favoritecustomer    |
| Description   | label customers     |
| Created-at    | 2026-04-13 14:09:48 |
+---------------+---------------------+