645 lines
41 KiB
ReStructuredText
645 lines
41 KiB
ReStructuredText
.. _telemetry-measurements:
|
|
|
|
============
|
|
Measurements
|
|
============
|
|
|
|
The Telemetry service collects meters within an OpenStack deployment.
|
|
This section provides a brief summary about meters format and origin and
|
|
also contains the list of available meters.
|
|
|
|
Telemetry collects meters 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
|
|
:ref:`telemetry-data-collection`. There are several meters which are collected
|
|
by polling and by consuming. The origin for each meter is listed in the tables
|
|
below.
|
|
|
|
.. note::
|
|
|
|
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
|
|
<https://docs.openstack.org/ceilometer/latest/install/index.html>`__
|
|
in the Installation Tutorials and Guides.
|
|
|
|
Telemetry uses the following meter types:
|
|
|
|
+--------------+--------------------------------------------------------------+
|
|
| Type | Description |
|
|
+==============+==============================================================+
|
|
| Cumulative | Increasing over time (instance hours) |
|
|
+--------------+--------------------------------------------------------------+
|
|
| Delta | Changing over time (bandwidth) |
|
|
+--------------+--------------------------------------------------------------+
|
|
| Gauge | Discrete 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:
|
|
|
|
.. code-block:: console
|
|
|
|
$ openstack server create --property metering.custom_metadata=a_value my_vm
|
|
|
|
The other option is to set the ``reserved_metadata_keys`` 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 ``metadata_headers`` 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.
|
|
|
|
Measurements are grouped by services which are polled by
|
|
Telemetry or emit notifications that this service consumes.
|
|
|
|
.. _telemetry-compute-meters:
|
|
|
|
OpenStack Compute
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for OpenStack Compute.
|
|
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| Name | Type | Unit | Resource | Origin | Support | Note |
|
|
+===========+=======+======+==========+==========+=========+==================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| memory | Gauge | MB | instance | Notific\ | Libvirt | Volume of RAM |
|
|
| | | | ID | ation | | allocated to the |
|
|
| | | | | | | instance |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| memory.\ | Gauge | MB | instance | Pollster | Libvirt,| Volume of RAM |
|
|
| usage | | | ID | | vSphere,| used by the inst\|
|
|
| | | | | | | ance from the |
|
|
| | | | | | | amount of its |
|
|
| | | | | | | allocated memory |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| memory.r\ | Gauge | MB | instance | Pollster | Libvirt | Volume of RAM u\ |
|
|
| esident | | | ID | | | sed by the inst\ |
|
|
| | | | | | | ance on the phy\ |
|
|
| | | | | | | sical machine |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| cpu | Cumu\ | ns | instance | Pollster | Libvirt | CPU time used |
|
|
| | lative| | ID | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| vcpus | Gauge | vcpu | instance | Notific\ | Libvirt | Number of virtual|
|
|
| | | | ID | ation | | CPUs allocated to|
|
|
| | | | | | | the instance |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.dev\ | Cumu\ | req\ | disk ID | Pollster | Libvirt | Number of read |
|
|
| ice.read\ | lative| uest | | | | requests |
|
|
| .requests | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.dev\ | Cumu\ | req\ | disk ID | Pollster | Libvirt | Number of write |
|
|
| ice.write\| lative| uest | | | | requests |
|
|
| .requests | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.dev\ | Cumu\ | B | disk ID | Pollster | Libvirt | Volume of reads |
|
|
| ice.read\ | lative| | | | | |
|
|
| .bytes | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.dev\ | Cumu\ | B | disk ID | Pollster | Libvirt | Volume of writes |
|
|
| ice.write\| lative| | | | | |
|
|
| .bytes | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.root\| Gauge | GB | instance | Notific\ | Libvirt | Size of root disk|
|
|
| .size | | | ID | ation | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.ephe\| Gauge | GB | instance | Notific\ | Libvirt | Size of ephemeral|
|
|
| meral.size| | | ID | ation | | disk |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.dev\ | Gauge | B | disk ID | Pollster | Libvirt | The amount of d\ |
|
|
| ice.capa\ | | | | | | isk per device |
|
|
| city | | | | | | that the instan\ |
|
|
| | | | | | | ce can see |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.dev\ | Gauge | B | disk ID | Pollster | Libvirt | The amount of d\ |
|
|
| ice.allo\ | | | | | | isk per device |
|
|
| cation | | | | | | occupied by the |
|
|
| | | | | | | instance on th\ |
|
|
| | | | | | | e host machine |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.dev\ | Gauge | B | disk ID | Pollster | Libvirt | The physical si\ |
|
|
| ice.usag\ | | | | | | ze in bytes of |
|
|
| e | | | | | | the image conta\ |
|
|
| | | | | | | iner on the hos\ |
|
|
| | | | | | | t per device |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| network.\ | Cumu\ | B | interface| Pollster | Libvirt | Number of |
|
|
| incoming.\| lative| | ID | | | incoming bytes |
|
|
| bytes | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| network.\ | Cumu\ | B | interface| Pollster | Libvirt | Number of |
|
|
| outgoing\ | lative| | ID | | | outgoing bytes |
|
|
| .bytes | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| network.\ | Cumu\ | pac\ | interface| Pollster | Libvirt | Number of |
|
|
| incoming\ | lative| ket | ID | | | incoming packets |
|
|
| .packets | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| network.\ | Cumu\ | pac\ | interface| Pollster | Libvirt | Number of |
|
|
| outgoing\ | lative| ket | ID | | | outgoing packets |
|
|
| .packets | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| **Meters added in the Newton release** |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| cpu_l3_c\ | Gauge | B | instance | Pollster | Libvirt | L3 cache used b\ |
|
|
| ache | | | ID | | | y the instance |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| memory.b\ | Gauge | B/s | instance | Pollster | Libvirt | Total system ba\ |
|
|
| andwidth\ | | | ID | | | ndwidth from on\ |
|
|
| .total | | | | | | e level of cache |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| memory.b\ | Gauge | B/s | instance | Pollster | Libvirt | Bandwidth of me\ |
|
|
| andwidth\ | | | ID | | | mory traffic fo\ |
|
|
| .local | | | | | | r a memory cont\ |
|
|
| | | | | | | roller |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| perf.cpu\ | Gauge | cyc\ | instance | Pollster | Libvirt | the number of c\ |
|
|
| .cycles | | le | ID | | | pu cycles one i\ |
|
|
| | | | | | | nstruction needs |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| perf.ins\ | Gauge | inst\| instance | Pollster | Libvirt | the count of in\ |
|
|
| tructions | | ruct\| ID | | | structions |
|
|
| | | ion | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| perf.cac\ | Gauge | cou\ | instance | Pollster | Libvirt | the count of ca\ |
|
|
| he.refer\ | | nt | ID | | | che hits |
|
|
| ences | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| perf.cac\ | Gauge | cou\ | instance | Pollster | Libvirt | the count of ca\ |
|
|
| he.misses | | nt | ID | | | che misses |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| **Meters added in the Ocata release** |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| network.\ | Cumul\| pack\| interface| Pollster | Libvirt | Number of |
|
|
| incoming\ | ative | et | ID | | | incoming dropped |
|
|
| .packets\ | | | | | | packets |
|
|
| .drop | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| network.\ | Cumul\| pack\| interface| Pollster | Libvirt | Number of |
|
|
| outgoing\ | ative | et | ID | | | outgoing dropped |
|
|
| .packets\ | | | | | | packets |
|
|
| .drop | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| network.\ | Cumul\| pack\| interface| Pollster | Libvirt | Number of |
|
|
| incoming\ | ative | et | ID | | | incoming error |
|
|
| .packets\ | | | | | | packets |
|
|
| .error | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| network.\ | Cumul\| pack\| interface| Pollster | Libvirt | Number of |
|
|
| outgoing\ | ative | et | ID | | | outgoing error |
|
|
| .packets\ | | | | | | packets |
|
|
| .error | | | | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| **Meters added in the Pike release** |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| memory.\ | Cumul\| | | | | |
|
|
| swap.in | ative | MB | instance | Pollster | Libvirt | Memory swap in |
|
|
| | | | ID | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| memory.\ | Cumul\| | | | | |
|
|
| swap.out | ative | MB | instance | Pollster | Libvirt | Memory swap out |
|
|
| | | | ID | | | |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| **Meters added in the Queens release** |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.devi\| Cumul\| | | | | Total time read |
|
|
| ce.read.l\| ative | ns | Disk ID | Pollster | Libvirt | operations have |
|
|
| atency | | | | | | taken |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| disk.devi\| Cumul\| | | | | Total time write |
|
|
| ce.write.\| ative | ns | Disk ID | Pollster | Libvirt | operations have |
|
|
| latency | | | | | | taken |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| **Meters added in the Epoxy release** |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
| power.sta\| Gauge | state| instance | Pollster | Libvirt | virDomainState |
|
|
| te | | | ID | | | of the VM |
|
|
+-----------+-------+------+----------+----------+---------+------------------+
|
|
|
|
.. note::
|
|
|
|
To enable the libvirt ``memory.usage`` support, you need to install
|
|
libvirt version 1.1.1+, QEMU version 1.5+, and you also need to
|
|
prepare suitable balloon driver in the image. It is applicable
|
|
particularly for Windows guests, most modern Linux distributions
|
|
already have it built in. Telemetry is not able to fetch the
|
|
``memory.usage`` samples without the image balloon driver.
|
|
|
|
.. note::
|
|
|
|
To enable libvirt ``disk.*`` support when running on RBD-backed shared
|
|
storage, you need to install libvirt version 1.2.16+.
|
|
|
|
OpenStack Compute is capable of collecting ``CPU`` related meters from
|
|
the compute host machines. In order to use that you need to set the
|
|
``compute_monitors`` option to ``cpu.virt_driver`` in the
|
|
``nova.conf`` configuration file. For further information see the
|
|
Compute configuration section in the `Compute chapter
|
|
<https://docs.openstack.org/nova/latest/configuration/config.html>`__
|
|
of the OpenStack Configuration Reference.
|
|
|
|
The following host machine related meters are collected for OpenStack
|
|
Compute:
|
|
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+=====================+=======+======+==========+=============+===============+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Gauge | MHz | host ID | Notification| CPU frequency |
|
|
| frequency | | | | | |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Cumu\ | ns | host ID | Notification| CPU kernel |
|
|
| kernel.time | lative| | | | time |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Cumu\ | ns | host ID | Notification| CPU idle time |
|
|
| idle.time | lative| | | | |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Cumu\ | ns | host ID | Notification| CPU user mode |
|
|
| user.time | lative| | | | time |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Cumu\ | ns | host ID | Notification| CPU I/O wait |
|
|
| iowait.time | lative| | | | time |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Gauge | % | host ID | Notification| CPU kernel |
|
|
| kernel.percent | | | | | percentage |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Gauge | % | host ID | Notification| CPU idle |
|
|
| idle.percent | | | | | percentage |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Gauge | % | host ID | Notification| CPU user mode |
|
|
| user.percent | | | | | percentage |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Gauge | % | host ID | Notification| CPU I/O wait |
|
|
| iowait.percent | | | | | percentage |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
| compute.node.cpu.\ | Gauge | % | host ID | Notification| CPU |
|
|
| percent | | | | | utilization |
|
|
+---------------------+-------+------+----------+-------------+---------------+
|
|
|
|
.. _telemetry-bare-metal-service:
|
|
|
|
IPMI meters
|
|
~~~~~~~~~~~
|
|
|
|
Telemetry captures notifications that are emitted by the Bare metal
|
|
service. The source of the notifications are IPMI sensors that collect
|
|
data from the host machine.
|
|
|
|
Alternatively, IPMI meters can be generated by deploying the
|
|
ceilometer-agent-ipmi on each IPMI-capable node. For further information about
|
|
the IPMI agent see :ref:`telemetry-ipmi-agent`.
|
|
|
|
.. warning::
|
|
|
|
To avoid duplication of metering data and unnecessary load on the
|
|
IPMI interface, do not deploy the IPMI agent on nodes that are
|
|
managed by the Bare metal service and keep the
|
|
``conductor.send_sensor_data`` option set to ``False`` in the
|
|
``ironic.conf`` configuration file.
|
|
|
|
|
|
The following IPMI sensor meters are recorded:
|
|
|
|
+------------------+-------+------+----------+-------------+------------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+==================+=======+======+==========+=============+==================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+------------------+-------+------+----------+-------------+------------------+
|
|
| hardware.ipmi.fan| Gauge | RPM | fan | Notificatio\| Fan rounds per |
|
|
| | | | sensor | n, Pollster | minute (RPM) |
|
|
+------------------+-------+------+----------+-------------+------------------+
|
|
| hardware.ipmi\ | Gauge | C | temper\ | Notificatio\| Temperature read\|
|
|
| .temperature | | | ature | n, Pollster | ing from sensor |
|
|
| | | | sensor | | |
|
|
+------------------+-------+------+----------+-------------+------------------+
|
|
| hardware.ipmi\ | Gauge | A | current | Notificatio\| Current reading |
|
|
| .current | | | sensor | n, Pollster | from sensor |
|
|
+------------------+-------+------+----------+-------------+------------------+
|
|
| hardware.ipmi\ | Gauge | V | voltage | Notificatio\| Voltage reading |
|
|
| .voltage | | | sensor | n, Pollster | from sensor |
|
|
+------------------+-------+------+----------+-------------+------------------+
|
|
|
|
.. note::
|
|
|
|
The sensor data is not available in the Bare metal service by
|
|
default. To enable the meters and configure this module to emit
|
|
notifications about the measured values see the `Installation
|
|
Guide <https://docs.openstack.org/ironic/latest/install/index.html>`__
|
|
for the Bare metal service.
|
|
|
|
|
|
Besides generic IPMI sensor data, the following Intel Node Manager
|
|
meters are recorded from capable platform:
|
|
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+=====================+=======+======+==========+==========+==================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | W | host ID | Pollster | Current power |
|
|
| .power | | | | | of the system |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | C | host ID | Pollster | Current tempera\ |
|
|
| .temperature | | | | | ture of the |
|
|
| | | | | | system |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | C | host ID | Pollster | Inlet temperatu\ |
|
|
| .inlet_temperature | | | | | re of the system |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | C | host ID | Pollster | Outlet temperat\ |
|
|
| .outlet_temperature | | | | | ure of the system|
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | CFM | host ID | Pollster | Volumetric airf\ |
|
|
| .airflow | | | | | low of the syst\ |
|
|
| | | | | | em, expressed as |
|
|
| | | | | | 1/10th of CFM |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | CUPS | host ID | Pollster | CUPS(Compute Us\ |
|
|
| .cups | | | | | age Per Second) |
|
|
| | | | | | index data of the|
|
|
| | | | | | system |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | % | host ID | Pollster | CPU CUPS utiliz\ |
|
|
| .cpu_util | | | | | ation of the |
|
|
| | | | | | system |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | % | host ID | Pollster | Memory CUPS |
|
|
| .mem_util | | | | | utilization of |
|
|
| | | | | | the system |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
| hardware.ipmi.node\ | Gauge | % | host ID | Pollster | IO CUPS |
|
|
| .io_util | | | | | utilization of |
|
|
| | | | | | the system |
|
|
+---------------------+-------+------+----------+----------+------------------+
|
|
|
|
OpenStack Image service
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for OpenStack Image service:
|
|
|
|
+--------------------+--------+------+----------+----------+------------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+====================+========+======+==========+==========+==================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+--------------------+--------+------+----------+----------+------------------+
|
|
| image.size | Gauge | B | image ID | Notifica\| Size of the upl\ |
|
|
| | | | | tion, Po\| oaded image |
|
|
| | | | | llster | |
|
|
+--------------------+--------+------+----------+----------+------------------+
|
|
| image.download | Delta | B | image ID | Notifica\| Image is downlo\ |
|
|
| | | | | tion | aded |
|
|
+--------------------+--------+------+----------+----------+------------------+
|
|
| image.serve | Delta | B | image ID | Notifica\| Image is served |
|
|
| | | | | tion | out |
|
|
+--------------------+--------+------+----------+----------+------------------+
|
|
|
|
OpenStack Block Storage
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for OpenStack Block Storage:
|
|
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+====================+=======+========+==========+==========+=================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.size | Gauge | GB | volume ID| Notifica\| Size of the vol\|
|
|
| | | | | tion | ume |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| snapshot.size | Gauge | GB | snapshot | Notifica\| Size of the sna\|
|
|
| | | | ID | tion | pshot |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| **Meters added in the Queens release** |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.ca\| Gauge | GB | hostname | Notifica\| Total volume |
|
|
| pacity.total | | | | tion | capacity on host|
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.ca\| Gauge | GB | hostname | Notifica\| Free volume |
|
|
| pacity.free | | | | tion | capacity on host|
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.ca\| Gauge | GB | hostname | Notifica\| Assigned volume |
|
|
| pacity.allocated | | | | tion | capacity on host|
|
|
| | | | | | by Cinder |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.ca\| Gauge | GB | hostname | Notifica\| Assigned volume |
|
|
| pacity.provisioned | | | | tion | capacity on host|
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.ca\| Gauge | GB | hostname | Notifica\| Virtual free |
|
|
| pacity.virtual_free| | | | tion | volume capacity |
|
|
| | | | | | on host |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.po\| Gauge | GB | hostname\| Notifica\| Total volume |
|
|
| ol.capacity.total | | | #pool | tion | capacity in pool|
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.po\| Gauge | GB | hostname\| Notifica\| Free volume |
|
|
| ol.capacity.free | | | #pool | tion | capacity in pool|
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.po\| Gauge | GB | hostname\| Notifica\| Assigned volume |
|
|
| ol.capacity.alloca\| | | #pool | tion | capacity in pool|
|
|
| ted | | | | | by Cinder |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.po\| Gauge | GB | hostname\| Notifica\| Assigned volume |
|
|
| ol.capacity.provis\| | | #pool | tion | capacity in pool|
|
|
| ioned | | | | | |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| volume.provider.po\| Gauge | GB | hostname\| Notifica\| Virtual free |
|
|
| ol.capacity.virtua\| | | #pool | tion | volume capacity |
|
|
| l_free | | | | | in pool |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
|
|
OpenStack File Share
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for OpenStack File Share:
|
|
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+====================+=======+========+==========+==========+=================+
|
|
| **Meters added in the Pike release** |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
| manila.share.size | Gauge | GB | share ID | Notifica\| Size of the fil\|
|
|
| | | | | tion | e share |
|
|
+--------------------+-------+--------+----------+----------+-----------------+
|
|
|
|
.. _telemetry-object-storage-meter:
|
|
|
|
OpenStack Object Storage
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for OpenStack Object Storage:
|
|
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+====================+=======+=======+============+=========+=================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
| storage.objects | Gauge | object| storage ID | Pollster| Number of objec\|
|
|
| | | | | | ts |
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
| storage.objects.si\| Gauge | B | storage ID | Pollster| Total size of s\|
|
|
| ze | | | | | tored objects |
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
| storage.objects.co\| Gauge | conta\| storage ID | Pollster| Number of conta\|
|
|
| ntainers | | iner | | | iners |
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
| storage.objects.in\| Delta | B | storage ID | Notific\| Number of incom\|
|
|
| coming.bytes | | | | ation | ing bytes |
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
| storage.objects.ou\| Delta | B | storage ID | Notific\| Number of outgo\|
|
|
| tgoing.bytes | | | | ation | ing bytes |
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
| storage.containers\| Gauge | object| storage ID\| Pollster| Number of objec\|
|
|
| .objects | | | /container | | ts in container |
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
| storage.containers\| Gauge | B | storage ID\| Pollster| Total size of s\|
|
|
| .objects.size | | | /container | | tored objects i\|
|
|
| | | | | | n container |
|
|
+--------------------+-------+-------+------------+---------+-----------------+
|
|
|
|
|
|
Ceph Object Storage
|
|
~~~~~~~~~~~~~~~~~~~
|
|
In order to gather meters from Ceph, you have to install and configure
|
|
the Ceph Object Gateway (radosgw) as it is described in the `Installation
|
|
Manual <http://docs.ceph.com/docs/master/radosgw/>`__. You also have to enable
|
|
`usage logging <http://docs.ceph.com/docs/master/man/8/radosgw/#usage-logging>`__ in
|
|
order to get the related meters from Ceph. You will need an
|
|
``admin`` user with ``users``, ``buckets``, ``metadata`` and ``usage``
|
|
``caps`` configured.
|
|
|
|
In order to access Ceph from Telemetry, you need to specify a
|
|
``service group`` for ``radosgw`` in the ``ceilometer.conf``
|
|
configuration file along with ``access_key`` and ``secret_key`` of the
|
|
``admin`` user mentioned above.
|
|
|
|
The following meters are collected for Ceph Object Storage:
|
|
|
|
+------------------+------+--------+------------+----------+------------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+==================+======+========+============+==========+==================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+------------------+------+--------+------------+----------+------------------+
|
|
| radosgw.objects | Gauge| object | storage ID | Pollster | Number of objects|
|
|
+------------------+------+--------+------------+----------+------------------+
|
|
| radosgw.objects.\| Gauge| B | storage ID | Pollster | Total size of s\ |
|
|
| size | | | | | tored objects |
|
|
+------------------+------+--------+------------+----------+------------------+
|
|
| radosgw.objects.\| Gauge| contai\| storage ID | Pollster | Number of conta\ |
|
|
| containers | | ner | | | iners |
|
|
+------------------+------+--------+------------+----------+------------------+
|
|
| radosgw.api.requ\| Gauge| request| storage ID | Pollster | Number of API r\ |
|
|
| est | | | | | equests against |
|
|
| | | | | | Ceph Object Ga\ |
|
|
| | | | | | teway (radosgw) |
|
|
+------------------+------+--------+------------+----------+------------------+
|
|
| radosgw.containe\| Gauge| object | storage ID\| Pollster | Number of objec\ |
|
|
| rs.objects | | | /container | | ts in container |
|
|
+------------------+------+--------+------------+----------+------------------+
|
|
| radosgw.containe\| Gauge| B | storage ID\| Pollster | Total size of s\ |
|
|
| rs.objects.size | | | /container | | tored objects in |
|
|
| | | | | | container |
|
|
+------------------+------+--------+------------+----------+------------------+
|
|
|
|
.. note::
|
|
|
|
The ``usage`` related information may not be updated right after an
|
|
upload or download, because the Ceph Object Gateway needs time to
|
|
update the usage properties. For instance, the default configuration
|
|
needs approximately 30 minutes to generate the usage logs.
|
|
|
|
OpenStack Identity
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for OpenStack Identity:
|
|
|
|
+-------------------+------+--------+-----------+-----------+-----------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+===================+======+========+===========+===========+=================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+-------------------+------+--------+-----------+-----------+-----------------+
|
|
| identity.authent\ | Delta| user | user ID | Notifica\ | User successful\|
|
|
| icate.success | | | | tion | ly authenticated|
|
|
+-------------------+------+--------+-----------+-----------+-----------------+
|
|
| identity.authent\ | Delta| user | user ID | Notifica\ | User pending au\|
|
|
| icate.pending | | | | tion | thentication |
|
|
+-------------------+------+--------+-----------+-----------+-----------------+
|
|
| identity.authent\ | Delta| user | user ID | Notifica\ | User failed to |
|
|
| icate.failure | | | | tion | authenticate |
|
|
+-------------------+------+--------+-----------+-----------+-----------------+
|
|
|
|
OpenStack Networking
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for OpenStack Networking:
|
|
|
|
+-----------------+-------+--------+-----------+-----------+------------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+=================+=======+========+===========+===========+==================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+-----------------+-------+--------+-----------+-----------+------------------+
|
|
| bandwidth | Delta | B | label ID | Notifica\ | Bytes through t\ |
|
|
| | | | | tion | his l3 metering |
|
|
| | | | | | label |
|
|
+-----------------+-------+--------+-----------+-----------+------------------+
|
|
|
|
VPN-as-a-Service (VPNaaS)
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for VPNaaS:
|
|
|
|
+---------------+-------+---------+------------+-----------+------------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+===============+=======+=========+============+===========+==================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+---------------+-------+---------+------------+-----------+------------------+
|
|
| network.serv\ | Gauge | vpnser\ | vpn ID | Pollster | Existence of a |
|
|
| ices.vpn | | vice | | | VPN |
|
|
+---------------+-------+---------+------------+-----------+------------------+
|
|
| network.serv\ | Gauge | ipsec\_\| connection | Pollster | Existence of an |
|
|
| ices.vpn.con\ | | site\_c\| ID | | IPSec connection |
|
|
| nections | | onnect\ | | | |
|
|
| | | ion | | | |
|
|
+---------------+-------+---------+------------+-----------+------------------+
|
|
|
|
Firewall-as-a-Service (FWaaS)
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following meters are collected for FWaaS:
|
|
|
|
+---------------+-------+---------+------------+-----------+------------------+
|
|
| Name | Type | Unit | Resource | Origin | Note |
|
|
+===============+=======+=========+============+===========+==================+
|
|
| **Meters added in the Mitaka release or earlier** |
|
|
+---------------+-------+---------+------------+-----------+------------------+
|
|
| network.serv\ | Gauge | firewall| firewall ID| Pollster | Existence of a |
|
|
| ices.firewall | | | | | firewall |
|
|
+---------------+-------+---------+------------+-----------+------------------+
|
|
| network.serv\ | Gauge | firewa\ | firewall ID| Pollster | Existence of a |
|
|
| ices.firewal\ | | ll_pol\ | | | firewall policy |
|
|
| l.policy | | icy | | | |
|
|
+---------------+-------+---------+------------+-----------+------------------+
|