diff --git a/doc/admin-guide-cloud/ch_telemetry.xml b/doc/admin-guide-cloud/ch_telemetry.xml index 2501ec76b7..44c7376282 100644 --- a/doc/admin-guide-cloud/ch_telemetry.xml +++ b/doc/admin-guide-cloud/ch_telemetry.xml @@ -44,5 +44,6 @@ + diff --git a/doc/admin-guide-cloud/telemetry/section_telemetry-measurements.xml b/doc/admin-guide-cloud/telemetry/section_telemetry-measurements.xml new file mode 100644 index 0000000000..97fd591dd0 --- /dev/null +++ b/doc/admin-guide-cloud/telemetry/section_telemetry-measurements.xml @@ -0,0 +1,103 @@ + +
+ Measurements + The Telemetry module collects metrics within an OpenStack + deployment. This section provides a brief summary about metrics + format and origin and also contains the list of available + meters. + Telemetry collects metrics by polling the infrastructure + elements and also by consuming the notifications emitted + by other OpenStack services. For more information about the + polling mechanism and notifications see + . There are + several meters which are collected by polling and by consuming. + The origin for each meter is listed in the tables below. + + You may need to configure Telemetry or other OpenStack + services in order to be able to collect all the samples you need. + For further information about configuration requirements see the + + Telemetry chapter in the OpenStack Installation + Guide. Also check the + Telemetry manual installation description. + + Telemetry uses the following metric types: + + + + + + + + + + + + + + + + + + + + + + + + +
Telemetry metric types
TypeDescription
CumulativeIncreasing over time (instance hours)
DeltaChanging over time (bandwidth)
GaugeDiscrete items (floating IPs, image uploads) and + fluctuating values (disk I/O)
+ Telemetry provides the possibility to store metadata for + samples. This metadata can be extended for OpenStack Compute and + OpenStack Object Storage. + In order to add additional metadata information to OpenStack + Compute you have two options to choose from. The first one is to + specify them when you boot up a new instance. The additional + information will be stored with the sample in the form of + resource_metadata.user_metadata.*. The new + field should be defined by using the prefix metering.. + The modified boot command look like the following: + $ nova boot --meta metering.custom_metadata=a_value my_vm + The other option is to set the + to the list of metadata keys that you would like to be included + in resource_metadata of the instance related + samples that are collected for OpenStack Compute. This option is + included in the DEFAULT section of the + ceilometer.conf configuration file. + You might also specify headers whose values will be stored along with + the sample data of OpenStack Object Storage. The additional + information is also stored under resource_metadata. + The format of the new field is + resource_metadata.http_header_$name, where + $name is the name of the header with - + replaced by _. + For specifying the new header, you need to set option under the [filter:ceilometer] + section in proxy-server.conf under the + swift folder. You can use this additional data + for instance to distinguish external and internal users. + The list of measurements is grouped by services which + are polled by Telemetry or emits notifications that this module + consumes. + + The Telemetry module supports storing notifications as + events. This functionality was added later, therefore the list + of meters still contains existence type and other event related + items. The proper way of using Telemetry is to configure it to + use the event store and turn off the collection of the event + related metrics. For further information about events see Events + section in the Telemetry documentation. For further + information about how to turn on and off meters see + . Please + also note that currently no migration is available to move the already + existing event type samples to the event store. + +