The monasca client is the command-line interface (CLI) for the Monitoring (monasca) API and its extensions.
This chapter documents monasca version 1.5.0
.
For help on a specific monasca command, enter:
$ monasca help COMMAND
usage: monasca [-j] [--version] [-d] [-v] [-k] [--cert-file CERT_FILE]
[--key-file KEY_FILE] [--os-cacert OS_CACERT]
[--keystone_timeout KEYSTONE_TIMEOUT]
[--os-username OS_USERNAME] [--os-password OS_PASSWORD]
[--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-project-id OS_PROJECT_ID]
[--os-project-name OS_PROJECT_NAME]
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
[--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth]
[--monasca-api-url MONASCA_API_URL]
[--monasca-api-version MONASCA_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE]
<subcommand> ...
<subcommand>
alarm-count Count alarms.
alarm-definition-create Create an alarm definition.
alarm-definition-delete Delete the alarm definition.
alarm-definition-list List alarm definitions for this tenant.
alarm-definition-patch Patch the alarm definition.
alarm-definition-show Describe the alarm definition.
alarm-definition-update Update the alarm definition.
alarm-delete Delete the alarm.
alarm-history Alarm state transition history.
alarm-history-list List alarms state history.
alarm-list List alarms for this tenant.
alarm-patch Patch the alarm state.
alarm-show Describe the alarm.
alarm-update Update the alarm state.
dimension-name-list List names of metric dimensions.
dimension-value-list List names of metric dimensions.
measurement-list List measurements for the specified metric.
metric-create Create metric.
metric-create-raw Create metric from raw json body.
metric-list List metrics for this tenant.
metric-name-list List names of metrics.
metric-statistics List measurement statistics for the specified
metric.
notification-create Create notification.
notification-delete Delete notification.
notification-list List notifications for this tenant.
notification-patch Patch notification.
notification-show Describe the notification.
notification-type-list List notification types supported by monasca.
notification-update Update notification.
bash-completion Prints all of the commands and options to stdout.
help Display help about this program or one of its
subcommands.
-j, --json
--version
-d, --debug
env[MONASCA_DEBUG]
.-v, --verbose
-k, --insecure
--cert-file CERT_FILE
--key-file KEY_FILE
--os-cacert OS_CACERT
env[OS_CACERT]
. Without either of these, the
client looks for the default system CA
certificates.--keystone_timeout KEYSTONE_TIMEOUT
--os-username OS_USERNAME
env[OS_USERNAME]
.--os-password OS_PASSWORD
env[OS_PASSWORD]
.--os-user-domain-id OS_USER_DOMAIN_ID
env[OS_USER_DOMAIN_ID]
.--os-user-domain-name OS_USER_DOMAIN_NAME
env[OS_USER_DOMAIN_NAME]
.--os-project-id OS_PROJECT_ID
env[OS_PROJECT_ID]
.--os-project-name OS_PROJECT_NAME
env[OS_PROJECT_NAME]
.--os-project-domain-id OS_PROJECT_DOMAIN_ID
env[OS_PROJECT_DOMAIN_ID]
.--os-project-domain-name OS_PROJECT_DOMAIN_NAME
env[OS_PROJECT_DOMAIN_NAME]
.--os-auth-url OS_AUTH_URL
env[OS_AUTH_URL]
.--os-region-name OS_REGION_NAME
env[OS_REGION_NAME]
.--os-auth-token OS_AUTH_TOKEN
env[OS_AUTH_TOKEN]
.--os-no-client-auth
env[OS_NO_CLIENT_AUTH]
.--monasca-api-url MONASCA_API_URL
env[MONASCA_API_URL]
.--monasca-api-version MONASCA_API_VERSION
env[MONASCA_API_VERSION]
or 2_0--os-service-type OS_SERVICE_TYPE
env[OS_SERVICE_TYPE]
.--os-endpoint-type OS_ENDPOINT_TYPE
env[OS_ENDPOINT_TYPE]
.usage: monasca alarm-count [--alarm-definition-id <ALARM_DEFINITION_ID>]
[--metric-name <METRIC_NAME>]
[--metric-dimensions <KEY1=VALUE1,KEY2,KEY3=VALUE2...>]
[--state <ALARM_STATE>] [--severity <SEVERITY>]
[--state-updated-start-time <UTC_STATE_UPDATED_START>]
[--lifecycle-state <LIFECYCLE_STATE>]
[--link <LINK>] [--group-by <GROUP_BY>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
Count alarms.
Optional arguments:
--alarm-definition-id <ALARM_DEFINITION_ID>
--metric-name <METRIC_NAME>
--metric-dimensions <KEY1=VALUE1,KEY2,KEY3=VALUE2...>
--state <ALARM_STATE>
--severity <SEVERITY>
--state-updated-start-time <UTC_STATE_UPDATED_START>
--lifecycle-state <LIFECYCLE_STATE>
--link <LINK>
--group-by <GROUP_BY>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
usage: monasca alarm-definition-create [--description <DESCRIPTION>]
[--severity <SEVERITY>]
[--match-by <MATCH_BY_DIMENSION_KEY1,MATCH_BY_DIMENSION_KEY2,...>]
[--alarm-actions <NOTIFICATION-ID>]
[--ok-actions <NOTIFICATION-ID>]
[--undetermined-actions <NOTIFICATION-ID>]
<ALARM_DEFINITION_NAME> <EXPRESSION>
Create an alarm definition.
Positional arguments:
<ALARM_DEFINITION_NAME>
<EXPRESSION>
Optional arguments:
--description <DESCRIPTION>
--severity <SEVERITY>
--match-by <MATCH_BY_DIMENSION_KEY1,MATCH_BY_DIMENSION_KEY2,...>
--alarm-actions <NOTIFICATION-ID>
--ok-actions <NOTIFICATION-ID>
--undetermined-actions <NOTIFICATION-ID>
usage: monasca alarm-definition-delete <ALARM_DEFINITION_ID>
Delete the alarm definition.
Positional arguments:
<ALARM_DEFINITION_ID>
usage: monasca alarm-definition-list [--name <ALARM_DEFINITION_NAME>]
[--dimensions <KEY1=VALUE1,KEY2=VALUE2...>]
[--severity <SEVERITY>]
[--sort-by <SORT BY FIELDS>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
List alarm definitions for this tenant.
Optional arguments:
--name <ALARM_DEFINITION_NAME>
--dimensions <KEY1=VALUE1,KEY2=VALUE2...>
--severity <SEVERITY>
--sort-by <SORT BY FIELDS>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
usage: monasca alarm-definition-patch [--name <ALARM_DEFINITION_NAME>]
[--description <DESCRIPTION>]
[--expression <EXPRESSION>]
[--alarm-actions <NOTIFICATION-ID>]
[--ok-actions <NOTIFICATION-ID>]
[--undetermined-actions <NOTIFICATION-ID>]
[--actions-enabled <ACTIONS-ENABLED>]
[--severity <SEVERITY>]
<ALARM_DEFINITION_ID>
Patch the alarm definition.
Positional arguments:
<ALARM_DEFINITION_ID>
Optional arguments:
--name <ALARM_DEFINITION_NAME>
--description <DESCRIPTION>
--expression <EXPRESSION>
--alarm-actions <NOTIFICATION-ID>
--ok-actions <NOTIFICATION-ID>
--undetermined-actions <NOTIFICATION-ID>
--actions-enabled <ACTIONS-ENABLED>
--severity <SEVERITY>
usage: monasca alarm-definition-show <ALARM_DEFINITION_ID>
Describe the alarm definition.
Positional arguments:
<ALARM_DEFINITION_ID>
usage: monasca alarm-definition-update <ALARM_DEFINITION_ID>
<ALARM_DEFINITION_NAME> <DESCRIPTION>
<EXPRESSION>
<ALARM-NOTIFICATION-ID1,ALARM-NOTIFICATION-ID2,...>
<OK-NOTIFICATION-ID1,OK-NOTIFICATION-ID2,...>
<UNDETERMINED-NOTIFICATION-ID1,UNDETERMINED-NOTIFICATION-ID2,...>
<ACTIONS-ENABLED>
<MATCH_BY_DIMENSION_KEY1,MATCH_BY_DIMENSION_KEY2,...>
<SEVERITY>
Update the alarm definition.
Positional arguments:
<ALARM_DEFINITION_ID>
<ALARM_DEFINITION_NAME>
<DESCRIPTION>
<EXPRESSION>
<ALARM-NOTIFICATION-ID1,ALARM-NOTIFICATION-ID2,...>
<OK-NOTIFICATION-ID1,OK-NOTIFICATION-ID2,...>
<UNDETERMINED-NOTIFICATION-ID1,UNDETERMINED-NOTIFICATION-ID2,...>
<ACTIONS-ENABLED>
<MATCH_BY_DIMENSION_KEY1,MATCH_BY_DIMENSION_KEY2,...>
<SEVERITY>
usage: monasca alarm-delete <ALARM_ID>
Delete the alarm.
Positional arguments:
<ALARM_ID>
usage: monasca alarm-history [--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
<ALARM_ID>
Alarm state transition history.
Positional arguments:
<ALARM_ID>
Optional arguments:
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
usage: monasca alarm-history-list [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>]
[--starttime <UTC_START_TIME>]
[--endtime <UTC_END_TIME>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
List alarms state history.
Optional arguments:
--dimensions <KEY1=VALUE1,KEY2=VALUE2...>
--starttime <UTC_START_TIME>
--endtime <UTC_END_TIME>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
usage: monasca alarm-list [--alarm-definition-id <ALARM_DEFINITION_ID>]
[--metric-name <METRIC_NAME>]
[--metric-dimensions <KEY1=VALUE1,KEY2,KEY3=VALUE2...>]
[--state <ALARM_STATE>] [--severity <SEVERITY>]
[--state-updated-start-time <UTC_STATE_UPDATED_START>]
[--lifecycle-state <LIFECYCLE_STATE>]
[--link <LINK>] [--sort-by <SORT BY FIELDS>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
List alarms for this tenant.
Optional arguments:
--alarm-definition-id <ALARM_DEFINITION_ID>
--metric-name <METRIC_NAME>
--metric-dimensions <KEY1=VALUE1,KEY2,KEY3=VALUE2...>
--state <ALARM_STATE>
--severity <SEVERITY>
--state-updated-start-time <UTC_STATE_UPDATED_START>
--lifecycle-state <LIFECYCLE_STATE>
--link <LINK>
--sort-by <SORT BY FIELDS>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
usage: monasca alarm-patch [--state <ALARM_STATE>]
[--lifecycle-state <LIFECYCLE_STATE>]
[--link <LINK>]
<ALARM_ID>
Patch the alarm state.
Positional arguments:
<ALARM_ID>
Optional arguments:
--state <ALARM_STATE>
--lifecycle-state <LIFECYCLE_STATE>
--link <LINK>
usage: monasca alarm-show <ALARM_ID>
Describe the alarm.
Positional arguments:
<ALARM_ID>
usage: monasca alarm-update <ALARM_ID> <ALARM_STATE> <LIFECYCLE_STATE> <LINK>
Update the alarm state.
Positional arguments:
<ALARM_ID>
<ALARM_STATE>
<LIFECYCLE_STATE>
<LINK>
usage: monasca dimension-name-list [--metric-name <METRIC_NAME>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
[--tenant-id <TENANT_ID>]
List names of metric dimensions.
Optional arguments:
--metric-name <METRIC_NAME>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
--tenant-id <TENANT_ID>
usage: monasca dimension-value-list [--metric-name <METRIC_NAME>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
[--tenant-id <TENANT_ID>]
<DIMENSION_NAME>
List names of metric dimensions.
Positional arguments:
<DIMENSION_NAME>
Optional arguments:
--metric-name <METRIC_NAME>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
--tenant-id <TENANT_ID>
usage: monasca measurement-list [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>]
[--endtime <UTC_END_TIME>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>] [--merge_metrics]
[--group_by <KEY1,KEY2,...>]
[--tenant-id <TENANT_ID>]
<METRIC_NAME> <UTC_START_TIME>
List measurements for the specified metric.
Positional arguments:
<METRIC_NAME>
<UTC_START_TIME>
Optional arguments:
--dimensions <KEY1=VALUE1,KEY2=VALUE2...>
--endtime <UTC_END_TIME>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
--merge_metrics
--group_by <KEY1,KEY2,...>
--tenant-id <TENANT_ID>
usage: monasca metric-create [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>]
[--value-meta <KEY1=VALUE1,KEY2=VALUE2...>]
[--time <UNIX_TIMESTAMP>]
[--project-id <CROSS_PROJECT_ID>]
<METRIC_NAME> <METRIC_VALUE>
Create metric.
Positional arguments:
<METRIC_NAME>
<METRIC_VALUE>
Optional arguments:
--dimensions <KEY1=VALUE1,KEY2=VALUE2...>
--value-meta <KEY1=VALUE1,KEY2=VALUE2...>
--time <UNIX_TIMESTAMP>
--project-id <CROSS_PROJECT_ID>
usage: monasca metric-create-raw <JSON_BODY>
Create metric from raw json body.
Positional arguments:
<JSON_BODY>
usage: monasca metric-list [--name <METRIC_NAME>]
[--dimensions <KEY1=VALUE1,KEY2=VALUE2...>]
[--starttime <UTC_START_TIME>]
[--endtime <UTC_END_TIME>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>] [--tenant-id <TENANT_ID>]
List metrics for this tenant.
Optional arguments:
--name <METRIC_NAME>
--dimensions <KEY1=VALUE1,KEY2=VALUE2...>
--starttime <UTC_START_TIME>
--endtime <UTC_END_TIME>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
--tenant-id <TENANT_ID>
usage: monasca metric-name-list [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
[--tenant-id <TENANT_ID>]
List names of metrics.
Optional arguments:
--dimensions <KEY1=VALUE1,KEY2=VALUE2...>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
--tenant-id <TENANT_ID>
usage: monasca metric-statistics [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>]
[--endtime <UTC_END_TIME>]
[--period <PERIOD>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>] [--merge_metrics]
[--group_by <KEY1,KEY2,...>]
[--tenant-id <TENANT_ID>]
<METRIC_NAME> <STATISTICS> <UTC_START_TIME>
List measurement statistics for the specified metric.
Positional arguments:
<METRIC_NAME>
<STATISTICS>
<UTC_START_TIME>
Optional arguments:
--dimensions <KEY1=VALUE1,KEY2=VALUE2...>
--endtime <UTC_END_TIME>
--period <PERIOD>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
--merge_metrics
--group_by <KEY1,KEY2,...>
--tenant-id <TENANT_ID>
usage: monasca notification-create [--period <PERIOD>]
<NOTIFICATION_NAME> <TYPE> <ADDRESS>
Create notification.
Positional arguments:
<NOTIFICATION_NAME>
<TYPE>
<ADDRESS>
Optional arguments:
--period <PERIOD>
usage: monasca notification-delete <NOTIFICATION_ID>
Delete notification.
Positional arguments:
<NOTIFICATION_ID>
usage: monasca notification-list [--sort-by <SORT BY FIELDS>]
[--offset <OFFSET LOCATION>]
[--limit <RETURN LIMIT>]
List notifications for this tenant.
Optional arguments:
--sort-by <SORT BY FIELDS>
--offset <OFFSET LOCATION>
--limit <RETURN LIMIT>
usage: monasca notification-patch [--name <NOTIFICATION_NAME>] [--type <TYPE>]
[--address <ADDRESS>] [--period <PERIOD>]
<NOTIFICATION_ID>
Patch notification.
Positional arguments:
<NOTIFICATION_ID>
Optional arguments:
--name <NOTIFICATION_NAME>
--type <TYPE>
--address <ADDRESS>
--period <PERIOD>
usage: monasca notification-show <NOTIFICATION_ID>
Describe the notification.
Positional arguments:
<NOTIFICATION_ID>
usage: monasca notification-type-list
List notification types supported by monasca.
usage: monasca notification-update <NOTIFICATION_ID> <NOTIFICATION_NAME>
<TYPE> <ADDRESS> <PERIOD>
Update notification.
Positional arguments:
<NOTIFICATION_ID>
<NOTIFICATION_NAME>
<TYPE>
<ADDRESS>
<PERIOD>
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.