diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/configuration.rst | 132 | ||||
| -rw-r--r-- | doc/source/install/dbreco.rst | 2 | ||||
| -rw-r--r-- | doc/source/measurements.rst | 16 |
3 files changed, 138 insertions, 12 deletions
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index ea81502e..d23fb688 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -89,6 +89,25 @@ keyfile Required the same as certfile if the certfile includes the private key. =============================== ==================================== ============================================================== +VMware Configuration Options +============================ + +The following lists the various options that the VMware driver supports and must be placed +under a section called '[vmware]'. + +========================== ==================================== ================================================================= +Parameter Default Note +========================== ==================================== ================================================================= +host_ip "" (Str) IP address of the VMware Vsphere host. +host_password "" (Str) Password of VMware Vsphere. +host_username "" (Str) Username of VMware Vsphere. +api_retry_count 10 (Int) Number of times a VMware Vsphere API must be retried. +task_poll_interval 0.5 (Float) Sleep time in seconds for polling an ongoing async task. +wsdl_location None (Str) Optional vim Service WSDL location + e.g http://<server>/vimService.wsdl. Optional over-ride to + default location for bug work-arounds. +========================== ==================================== ================================================================= + SQL Alchemy =========== @@ -356,7 +375,22 @@ common interval is passed to individual pollsters matching those pipelines. The *transformers* section of a pipeline sink provides the possibility to add a list of transformer definitions. The names of the transformers should be the same -as the names of the related extensions in setup.cfg. +as the names of the related extensions in setup.cfg. For a more detailed +description, please see the :ref:`transformers` section. + +The *publishers* section contains the list of publishers, where the samples +data should be sent after the possible transformations. The names of the +publishers should be the same as the related names of the plugins in +setup.cfg. + +The default configuration can be found in `pipeline.yaml`_. + +.. _pipeline.yaml: https://git.openstack.org/cgit/openstack/ceilometer/tree/etc/ceilometer/pipeline.yaml + +.. _transformers: + +Transformers +************ The definition of transformers can contain the following fields:: @@ -366,9 +400,15 @@ The definition of transformers can contain the following fields:: The *parameters* section can contain transformer specific fields, like source and target fields with different subfields in case of the rate_of_change, -which depends on the implementation of the transformer. In case of the -transformer, which creates the *cpu_util* meter, the definition looks like the -following:: +which depends on the implementation of the transformer. + +.. _rate_of_change_transformer: + +Rate of change transformer +++++++++++++++++++++++++++ + +In the case of the transformer that creates the *cpu_util* meter, the definition +looks like the following:: transformers: - name: "rate_of_change" @@ -402,11 +442,83 @@ The definition for the disk I/O rate, which is also generated by the unit: "\\1/s" type: "gauge" -The *publishers* section contains the list of publishers, where the samples -data should be sent after the possible transformations. The names of the -publishers should be the same as the related names of the plugins in -setup.cfg. +Unit conversion transformer ++++++++++++++++++++++++++++ -The default configuration can be found in `pipeline.yaml`_. +Transformer to apply a unit conversion. It takes the volume of the meter +and multiplies it with the given 'scale' expression. Also supports *map_from* +and *map_to* like the :ref:`rate_of_change_transformer`. + +Sample configuration:: + + transformers: + - name: "unit_conversion" + parameters: + target: + name: "disk.kilobytes" + unit: "KB" + scale: "1.0 / 1024.0" + +With the *map_from* and *map_to*:: + + transformers: + - name: "unit_conversion" + parameters: + source: + map_from: + name: "disk\\.(read|write)\\.bytes" + target: + map_to: + name: "disk.\\1.kilobytes" + scale: "1.0 / 1024.0" + unit: "KB" + +Aggregator transformer +++++++++++++++++++++++ + +A transformer that sums up the incoming samples until enough samples have +come in or a timeout has been reached. + +Timeout can be specified with the *retention_time* parameter. If we want to +flush the aggregation after a set number of samples have been aggregated, +we can specify the *size* parameter. + +The volume of the created sample is the sum of the volumes of samples that +came into the transformer. Samples can be aggregated by the attributes +*project_id*, *user_id* and *resource_metadata*. To aggregate by the chosen +attributes, specify them in the configuration and set which value of the +attribute to take for the new sample (*first* to take the first sample's +attribute, *last* to take the last sample's attribute, and *drop* to discard +the attribute). + +To aggregate 60s worth of samples by resource_metadata and keep the +resource_metadata of the latest received sample:: + + transformers: + - name: "aggregator" + parameters: + retention_time: 60 + resource_metadata: last + +To aggregate each 15 samples by user_id and resource_metadata and keep the +user_id of the first received sample and drop the resource_metadata:: + + transformers: + - name: "aggregator" + parameters: + size: 15 + user_id: first + resource_metadata: drop + +Accumulator transformer ++++++++++++++++++++++++ + +This transformer simply caches the samples until enough samples have arrived +and then flushes them all down the pipeline at once. +:: + + transformers: + - name: "accumulator" + parameters: + size: 15 -.. _pipeline.yaml: https://git.openstack.org/cgit/openstack/ceilometer/tree/etc/ceilometer/pipeline.yaml diff --git a/doc/source/install/dbreco.rst b/doc/source/install/dbreco.rst index 6c3f28e7..d0ba56ed 100644 --- a/doc/source/install/dbreco.rst +++ b/doc/source/install/dbreco.rst @@ -47,6 +47,6 @@ Driver API querying API statistics Alarms MongoDB Yes Yes Yes MySQL Yes Yes Yes PostgreSQL Yes Yes Yes -HBase Yes Yes, except groupby No +HBase Yes Yes, except groupby Yes DB2 Yes Yes No ================== ============================= =================== ====== diff --git a/doc/source/measurements.rst b/doc/source/measurements.rst index 9f6a0421..23ca4b20 100644 --- a/doc/source/measurements.rst +++ b/doc/source/measurements.rst @@ -290,7 +290,7 @@ resource instances available, use the ``meter-list`` command: :: - $ ceilometer meter-list -s openstack + $ ceilometer meter-list +------------+-------+--------------------------------------+---------+----------------------------------+ | Name | Type | Resource ID | User ID | Project ID | +------------+-------+--------------------------------------+---------+----------------------------------+ @@ -337,3 +337,17 @@ refer to :ref:`installing_manually` for details. For example, this could be used to distinguish external and internal users. You'd have to implement a custom Swift middleware that sets a proper header and just add it to metadata_headers. + + +OSprofiler data +=============== + +All messages with event type "profiler.*" will be collected as profiling data. +Using notification plugin profiler/notifications.py. + +.. note:: + + Be sparing with heavy usage of OSprofiler, especially in case of complex + operations like booting and deleting instance that may create over 100kb of + sample data per each request. + |