openstack/aodh
Code Issues Proposed changes

doc: /statistics fields are not queryable (you cannot filter on them)

Browse Source 
Add precision on the way of filtering queries and corrected some typos.

Change-Id: I8bd79539c895eee30fbd24ab869b596d9a1c82c1
This commit is contained in:
Frederic FAURE 2013-07-17 16:54:51 +00:00
parent af8643c678
commit 8539cfbd90
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/webapi/v2.rst
View File

@ -36,7 +36,11 @@ Filtering Queries
================= =================
Many of the endpoints above accept a query filter argument, which Many of the endpoints above accept a query filter argument, which
should be a list of Query data structures: should be a list of Query data structures. Whatever the endpoint you
want to apply a filter on, you always filter on the fields of the *Sample*
type (for example, if you apply a filter on a query for statistics,
you won't target *duration_start* field of *Statistics*, but *timestamp*
field of *Sample*):
.. autotype:: ceilometer.api.controllers.v2.Query .. autotype:: ceilometer.api.controllers.v2.Query
:members: :members:
@ -155,7 +159,7 @@ Get the list of samples about instances running for June 2013 for a particular p
"op": "eq", "op": "eq",
"value": "8d6057bc-5b90-4296-afe0-84acaa2ef909"}] "value": "8d6057bc-5b90-4296-afe0-84acaa2ef909"}]
Get the list of samples about instances with m1.tiny flavor running for June 2013 for a particular project:: Get the list of samples about instances with *m1.tiny* flavor running for June 2013 for a particular project::
GET /v2/meters/instance:m1.tiny GET /v2/meters/instance:m1.tiny
q: [{"field": "timestamp", q: [{"field": "timestamp",
@ -170,7 +174,7 @@ Get the list of samples about instances with m1.tiny flavor running for June 201
Now you may want to have statistics on the meters you are targeting. Now you may want to have statistics on the meters you are targeting.
Consider the following example where you are getting the list of samples Consider the following example where you are getting the list of samples
about CPU utilisation of a given instance (identified by its "resource_id") about CPU utilisation of a given instance (identified by its *resource_id*)
running for June 2013:: running for June 2013::
GET /v2/meters/cpu_util GET /v2/meters/cpu_util
@ -184,8 +188,8 @@ running for June 2013::
"op": "eq", "op": "eq",
"value": "64da755c-9120-4236-bee1-54acafe24980"}] "value": "64da755c-9120-4236-bee1-54acafe24980"}]
You can have statistics on the list of samples requested (avg, sum, max, You can have statistics on the list of samples requested (*avg*, *sum*, *max*,
min, count) computed on the full duration):: *min*, *count*) computed on the full duration::
GET /v2/meters/cpu_util/statistics GET /v2/meters/cpu_util/statistics
q: [{"field": "timestamp", q: [{"field": "timestamp",