[ceilometer] document mandatory limit value

if a limit value is not passed in, the result set will be restricted
to a predefined limit.

Change-Id: Ic39745867eef5ad36f7c0cfbd78c6e6cbbc66a61
Closes-Bug: #1477388
This commit is contained in:
gordon chung 2015-09-23 14:27:22 -04:00
parent c074d04bec
commit f23dad69a4
2 changed files with 15 additions and 0 deletions

View File

@ -79,6 +79,13 @@ Data storage
$ ceilometer sample-list --meter cpu -q 'resource_id=INSTANCE_ID_1;timestamp > 2015-05-01T00:00:00;timestamp < 2015-06-01T00:00:00'
.. note::
As of the Liberty release, the number of items returned will be
restricted to the value defined by ``default_api_return_limit`` in the
:file:`ceilometer.conf` configuration file. Alternatively, the value can
be set per query by passing ``limit`` option in request.
#. You can install the API behind ``mod_wsgi``, as it provides more
settings to tweak, like ``threads`` and ``processes`` in case of
``WSGIDaemon``.

View File

@ -349,6 +349,14 @@ and ``disk.read.bytes`` meters, the following command should be invoked::
| bb52e52b-1e42-4751-b3ac-45c52d83ba07 | cpu | cumulative | 1.4795e+11 | ns | 2014-08-30T13:20:34 |
+--------------------------------------+-----------------+------------+------------+------+---------------------+
.. note::
As of the Liberty release, the number of items returned will be
restricted to the value defined by ``default_api_return_limit`` in the
:file:`ceilometer.conf` configuration file. Alternatively, the value can
be set per query by passing ``limit`` option in request.
Telemetry python bindings
-------------------------
The command line client library provides python bindings in order to use