Download This Guide
Ceilometer Support in a Contrail Cloud
Ceilometer is an OpenStack feature that provides an infrastructure for collecting SDN metrics from OpenStack projects. The metrics can be used by various rating engines to transform events into billable items. The Ceilometer collection process is sometimes referred to as “metering”. The Ceilometer service provides data that can be used by platforms that provide metering, tracking, billing, and similar services. This topic describes how to configure the Ceilometer service for Contrail.
Overview
Contrail Release 2.20 and later supports the OpenStack Ceilometer service, on the OpenStack Juno release on Ubuntu 14.04.1 LTS.
The prerequisites for installing Ceilometer are:
- Contrail Cloud installation
- Provisioned using Fabric with
enable_ceilometer = Truein thetestbed.pyfile. - Alternately, provisioned using Server Manager with
enable_ceilometer = Truein thecluster.jsonorclusterconfiguration.
 | Note: Ceilometer services are only installed on the first OpenStack controller node and do not support high availability in Contrail Release 2.20. |
Ceilometer Details
Ceilometer is used to reliably collect measurements of the utilization of the physical and virtual resources comprising deployed clouds, persist these data for subsequent retrieval and analysis, and trigger actions when defined criteria are met.
The Ceilometer architecture consists of:
Polling agent | — | Agent designed to poll OpenStack services and build meters. The polling agents are also run on the compute nodes in addition to the OpenStack controller. |
Notification agent | — | Agent designed to listen to notifications on message queue and convert them to events and samples. |
Collector | — | Gathers and records event and metering data created by the notification and polling agents. |
API server | — | Provides a REST API to query and view data recorded by the collector service. |
Alarms | — | Daemons to evaluate and notify based on defined alarming rules. |
Database | — | Stores the metering data, notifications, and alarms. The supported databases are MongoDB, SQL-based databases compatible with SQLAlchemy, and HBase. The recommended database is MongoDB, which has been thoroughly tested with Contrail and deployed on a production scale. |
Verification of Ceilometer Operation
The Ceilometer services are named slightly differently on the Ubuntu and RHEL Server 7.0.
On Ubuntu, the service names are:
Polling agent | — | ceilometer-agent-central and ceilometer-agent-compute |
Notification agent | — | ceilometer-agent-notification |
Collector | — | ceilometer-collector |
API Server | — | ceilometer-api |
Alarms | — | ceilometer-alarm-evaluator and ceilometer-alarm-notifier |
On RHEL Server 7.0, the service names are:
Polling agent | — | openstack-ceilometer-central and openstack-ceilometer-compute |
Notification agent | — | openstack-ceilometer-notification |
Collector | — | openstack-ceilometer-collector |
API server | — | openstack-ceilometer-api |
Alarms | — | openstack-ceilometer-alarm-evaluator and openstack-ceilometer-alarm-notifier |
To verify the Ceilometer installation, users can verify that the Ceilometer services are up and running by using the openstack-status command.
For example, using the openstack-status command on an all-in-one node running Ubuntu 14.04.1 LTS with release
2.2 of Contrail installed shows the following Ceilometer services
as active:
== Ceilometer services == ceilometer-api: active ceilometer-agent-central: active ceilometer-agent-compute: active ceilometer-collector: active ceilometer-alarm-notifier: active ceilometer-alarm-evaluator: active ceilometer-agent-notification:active
You can issue the ceilometer meter-list command on the OpenStack controller node to verify that meters are being collected, stored, and reported via the REST API. The following is an example of the output:
user@host:~# (source /etc/contrail/openstackrc; ceilometer meter-list) +------------------------------+------------+---------+--------------------------------------+----------------------------------+----------------------------------+ | Name | Type | Unit | Resource ID | User ID | Project ID | +------------------------------+------------+---------+--------------------------------------+----------------------------------+----------------------------------+ | ip.floating.receive.bytes | cumulative | B | a726f93a-65fa-4cad-828b-54dbfcf4a119 | None | None | | ip.floating.receive.packets | cumulative | packet | a726f93a-65fa-4cad-828b-54dbfcf4a119 | None | None | | ip.floating.transmit.bytes | cumulative | B | a726f93a-65fa-4cad-828b-54dbfcf4a119 | None | None | | ip.floating.transmit.packets | cumulative | packet | a726f93a-65fa-4cad-828b-54dbfcf4a119 | None | None | | network | gauge | network | 7fa6796b-756e-4320-9e73-87d4c52ecc83 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | network | gauge | network | 9408e287-d3e7-41e2-89f0-5c691c9ca450 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | network | gauge | network | b3b72b98-f61e-4e1f-9a9b-84f4f3ddec0b | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | network | gauge | network | cb829abd-e6a3-42e9-a82f-0742db55d329 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | network.create | delta | network | 7fa6796b-756e-4320-9e73-87d4c52ecc83 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | network.create | delta | network | 9408e287-d3e7-41e2-89f0-5c691c9ca450 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | network.create | delta | network | b3b72b98-f61e-4e1f-9a9b-84f4f3ddec0b | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | network.create | delta | network | cb829abd-e6a3-42e9-a82f-0742db55d329 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | port | gauge | port | 0d401d96-c2bf-4672-abf2-880eecf25ceb | 01edcedd989f43b3a2d6121d424b254d | 82ab961f88994e168217ddd746fdd826 | | port | gauge | port | 211b94a4-581d-45d0-8710-c6c69df15709 | 01edcedd989f43b3a2d6121d424b254d | 82ab961f88994e168217ddd746fdd826 | | port | gauge | port | 2287ce25-4eef-4212-b77f-3cf590943d36 | 01edcedd989f43b3a2d6121d424b254d | 82ab961f88994e168217ddd746fdd826 | | port.create | delta | port | f62f3732-222e-4c40-8783-5bcbc1fd6a1c | 01edcedd989f43b3a2d6121d424b254d | 82ab961f88994e168217ddd746fdd826 | | port.create | delta | port | f8c89218-3cad-48e2-8bd8-46c1bc33e752 | 01edcedd989f43b3a2d6121d424b254d | 82ab961f88994e168217ddd746fdd826 | | port.update | delta | port | 43ed422d-b073-489f-877f-515a3cc0b8c4 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | subnet | gauge | subnet | 09105ed1-1654-4b5f-8c12-f0f2666fa304 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | subnet | gauge | subnet | 4bf00aac-407c-4266-a048-6ff52721ad82 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | subnet.create | delta | subnet | 09105ed1-1654-4b5f-8c12-f0f2666fa304 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | | subnet.create | delta | subnet | 4bf00aac-407c-4266-a048-6ff52721ad82 | 15c0240142084d16b3127d6f844adbd9 | ded208991de34fe4bb7dd725097f1c7e | +------------------------------+------------+---------+--------------------------------------+----------------------------------+----------------------------------+
| Note:
The ceilometer meter-list command lists the
meters only if images have been created, or instances have been launched,
or if subnet, port, floating IP addresses have been created, otherwise
the meter list is empty. You also need to source the |
Contrail Ceilometer Plugin
The Contrail Ceilometer plugin adds the capability to meter the traffic statistics of floating IP addresses in Ceilometer. The following meters for each floating IP resource are added by the plugin in Ceilometer.
ip.floating.receive.bytes ip.floating.receive.packets ip.floating.transmit.bytes ip.floating.transmit.packets
The Contrail Ceilometer plugin configuration is done in the /etc/ceilometer/pipeline.yaml file when Contrail
is installed by the Fabric provisioning scripts.
The following example shows the configuration that is added to the file:
sources:
- name: contrail_source
interval: 600
meters:
- "ip.floating.receive.packets"
- "ip.floating.transmit.packets"
- "ip.floating.receive.bytes"
- "ip.floating.transmit.bytes"
resources:
- contrail://<IP-address-of-Contrail-Analytics-Node>:8081
sinks:
- contrail_sink
sinks:
- name: contrail_sink
publishers:
- rpc://
transformers:
The following example shows the Ceilometer meter list output for the floating IP meters:
+-------------------------------+------------+-----------+-----------------------------------------------------------------------+----------------------------------+----------------------------------+ | Name | Type | Unit | Resource ID | User ID | Project ID | +-------------------------------+------------+-----------+-----------------------------------------------------------------------+----------------------------------+----------------------------------+ | ip.floating.receive.bytes | cumulative | B | 451c93eb-e728-4ba1-8665-6e7c7a8b49e2 | None | None | | ip.floating.receive.bytes | cumulative | B | 9cf76844-8f09-4518-a09e-e2b8832bf894 | None | None | | ip.floating.receive.packets | cumulative | packet | 451c93eb-e728-4ba1-8665-6e7c7a8b49e2 | None | None | | ip.floating.receive.packets | cumulative | packet | 9cf76844-8f09-4518-a09e-e2b8832bf894 | None | None | | ip.floating.transmit.bytes | cumulative | B | 451c93eb-e728-4ba1-8665-6e7c7a8b49e2 | None | None | | ip.floating.transmit.bytes | cumulative | B | 9cf76844-8f09-4518-a09e-e2b8832bf894 | None | None | | ip.floating.transmit.packets | cumulative | packet | 451c93eb-e728-4ba1-8665-6e7c7a8b49e2 | None | None | | ip.floating.transmit.packets | cumulative | packet | 9cf76844-8f09-4518-a09e-e2b8832bf894 | None | None |
In the meter -list output, the Resource ID refers to the floating IP.
The following example shows the output from the ceilometer resource-show -r 451c93eb-e728-4ba1-8665-6e7c7a8b49e2 command:
+-------------+-------------------------------------------------------------------------+
| Property | Value |
+-------------+-------------------------------------------------------------------------+
| metadata | {u'router_id': u'None', u'status': u'ACTIVE', u'tenant_id': |
| | u'ceed483222f9453ab1d7bcdd353971bc', u'floating_network_id': |
| | u'6d0cca50-4be4-4b49-856a-6848133eb970', u'fixed_ip_address': |
| | u'2.2.2.4', u'floating_ip_address': u'3.3.3.4', u'port_id': u'c6ce2abf- |
| | ad98-4e56-ae65-ab7c62a67355', u'id': |
| | u'451c93eb-e728-4ba1-8665-6e7c7a8b49e2', u'device_id': |
| | u'00953f62-df11-4b05-97ca-30c3f6735ffd'} |
| project_id | None |
| resource_id | 451c93eb-e728-4ba1-8665-6e7c7a8b49e2 |
| source | openstack |
| user_id | None |
+-------------+-------------------------------------------------------------------------+The following example shows the output from the ceilometer statistics command and the ceilometer sample-list command for the ip.floating.receive.packets meter:
+--------+----------------------------+----------------------------+-------+-----+-------+--------+----------------+------------+----------------------------+----------------------------+ | Period | Period Start | Period End | Count | Min | Max | Sum | Avg | Duration | Duration Start | Duration End | +--------+----------------------------+----------------------------+-------+-----+-------+--------+----------------+------------+----------------------------+----------------------------+ | 0 | 2015-02-13T19:50:40.795000 | 2015-02-13T19:50:40.795000 | 2892 | 0.0 | 325.0 | 1066.0 | 0.368603042877 | 439069.674 | 2015-02-13T19:50:40.795000 | 2015-02-18T21:48:30.469000 | +--------+----------------------------+----------------------------+-------+-----+-------+--------+----------------+------------+----------------------------+----------------------------+ +--------------------------------------+-----------------------------+------------+--------+--------+----------------------------+ | Resource ID | Name | Type | Volume | Unit | Timestamp | +--------------------------------------+-----------------------------+------------+--------+--------+----------------------------+ | 9cf76844-8f09-4518-a09e-e2b8832bf894 | ip.floating.receive.packets | cumulative | 208.0 | packet | 2015-02-18T21:48:30.469000 | | 451c93eb-e728-4ba1-8665-6e7c7a8b49e2 | ip.floating.receive.packets | cumulative | 325.0 | packet | 2015-02-18T21:48:28.354000 | | 9cf76844-8f09-4518-a09e-e2b8832bf894 | ip.floating.receive.packets | cumulative | 0.0 | packet | 2015-02-18T21:38:30.350000 |
Ceilometer Installation and Provisioning
There are two scenarios possible for Contrail Ceilometer plugin installation.
- If you install your own OpenStack distribution, you can install the Contrail Ceilometer plugin on the OpenStack controller node.
- When using Contrail Cloud services, the Ceilometer controller
services are installed and provisioned automatically as part of the
OpenStack controller node and the compute agent service is installed
as part of the compute node.
The following fabric tasks are added to facilitate the installation and provisioning:
fab install_ceilometer— Installs the Ceilometer packages on the OpenStack controller node.
fab install_ceilometer_compute— Installs the Ceilometer packages on the compute node.
fab setup_ceilometer— Provisions the Ceilometer controller services on the OpenStack controller node.
fab setup_ceilometer_compute— Provisions the Contrail Ceilometer plugin package on the OpenStack controller node.
fab install_contrail_ceilometer_plugin— Installs the Contrail Ceilometer plugin package on the OpenStack controller node.
fab setup_contrail_ceilometer_plugin— Provisions the Contrail Ceilometer plugin package on the OpenStack controller node.
Note: The fabric tasks are automatically called as part of the fab install_openstack and fab setup_openstack commands for the OpenStack controller node, and as part of the fab install_vrouter, fab setup_vrouter commands for the compute node
