The ceilometer shell utility

The ceilometer shell utility interacts with OpenStack Ceilometer API from the command line. It supports the entirety of the OpenStack Ceilometer API.

You’ll need to provide ceilometer with your OpenStack credentials. You can do this with the --os-username, --os-password, --os-tenant-id and --os-auth-url options, but it’s easier to just set them as environment variables:

OS_USERNAME

Your OpenStack username.

OS_PASSWORD

Your password.

OS_TENANT_NAME

Project to work on.

OS_AUTH_URL

The OpenStack auth server URL (keystone).

For example, in Bash you would use:

export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://auth.example.com:5000/v2.0

The command line tool will attempt to reauthenticate using your provided credentials for every request. You can override this behavior by manually supplying an auth token using --os-ceilometer-url and --os-auth-token. You can alternatively set these environment variables:

export OS_CEILOMETER_URL=http://ceilometer.example.org:8777
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155

From there, all shell commands take the form:

ceilometer <command> [arguments...]

Run ceilometer help to get a full list of all possible commands, and run ceilometer help <command> to get detailed help for that command.

V2 client tips

Use queries to narrow your search (more info at Ceilometer V2 API reference):

ceilometer sample-list --meter cpu_util --query 'resource_id=5a301761-f78b-46e2-8900-8b4f6fe6675a' --limit 10