openstack/python-ceilometerclient
Code Issues Proposed changes
Files
adf460a4f94c87a754ab0df557f8784f8f584ff9
python-ceilometerclient/doc/source/api.rst
tuathail adf460a4f9 Updates examples to reference new sample format 
The list function for the new Sample Manager no longer takes a
meter_name parameter. It must be submitted as part of the query.
The changes reflect the new format.

Change-Id: I2c9346ce605b3f576a761f6162a5dcf49e4686ee
Closes-Bug:1443383
2015-04-13 14:33:41 +01:00

1.2 KiB
Raw Blame History

The ceilometerclient Python API

ceilometerclient

ceilometerclient

Usage

First create a client instance with your credentials:

>>> import ceilometerclient.client
>>> cclient = ceilometerclient.client.get_client(VERSION, os_username=USERNAME, os_password=PASSWORD, os_tenant_name=PROJECT_NAME, os_auth_url=AUTH_URL)

Here VERSION can be: 1 and 2.

Then call methods on its managers:

>>> cclient.meters.list()
[<Meter ...>, ...]

>>> cclient.new_samples.list()
[<Sample ...>, ...]

V2 client tips

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

>>> query = [dict(field='resource_id', op='eq', value='5a301761-f78b-46e2-8900-8b4f6fe6675a'), dict(field='meter',op='eq',value='cpu_util')]
>>> cclient.new_samples.list(q=query, limit=10)
[<Sample ...>, ...]

Reference

For more information, see the reference:

ref/index ref/v1/index ref/v2/index