Team and repository tags

monasca-ceilometer

Python plugin and storage driver for Ceilometer to send samples to monasca-api. Also known as Ceilosca.

Installation

Installation instructions for setting up Ceilosca automatically

See devstack/README.md.

Installation Instructions for setting up Ceilosca manually

To set up Ceilosca automatically, read the instructions in devstack/README.md or use the included Vagrantfile

Assumes that an active monasca-api server is running after installing DevStack.

1. Run devstack to get openstack installed, including Monasca and Ceilometer plugins.

2. Install python-monascaclient.

   pip install python-monascaclient

3. Clone monasca-ceilometer from github.com.

4. Copy the following files from ceilosca/ceilometer to devstack’s ceilometer location, typically at /opt/stack/ceilometer.

   monasca_client.py
   tests/* (skipping the init.py files)
   publisher/monasca_data_filter.py
   publisher/monclient.py
   ceilosca_mapping/*
   opts.py
   monasca_ceilometer_opts.py

5. Edit setup.cfg (used at the time of installation)

   Under ‘ceilometer.sample.publisher =’ section add the following line:

   monasca = ceilometer.publisher.monclient:MonascaPublisher

6. Configure /etc/ceilometer/pipeline.yaml to send the metrics to the monasca publisher. Use the included monasca-ceilometer/etc/ceilometer/pipeline.yaml file as an example.

7. Configure /etc/ceilometer/ceilometer.conf for setting up storage driver for ceilometer API. Use the included monasca-ceilometer/etc/ceilometer/ceilometer.conf file as an example.

8. Copy the included monasca_field_definitions.yml and monasca_pipeline.yaml files from monasca-ceilometer/etc/ceilometer to /etc/ceilometer.

   This monasca_field_definitions.yaml file contains configuration how to treat each field in ceilometer sample object on per meter basis. The monasca_data_filter.py uses this file and only stores the fields that are specified in this config file.

9. Make sure the user specified under service_credentials in ceilometer.conf has monasca_user role added.

Other install info

Since we don’t have a full repo of ceilometer, we setup the ceilometer repo in venv and copy monasca integration files in there, and run the unit tests over that code. At present this is tested against ceilometer stable/pike branch, if you need to test against different branch you can change it in test-requirements.txt

Relevant files are:

• monasca_test_setup.py - determines the ceilometer venv path and copies the relevant files over
• tox.ini - calls the commands for setup and runs the tests
• test-requirements.txt - contains the dependencies required for testing

Using Ceilosca

Defining or changing existing meters

From time to time, Ceilometer introduces new meters. The list of currently supported measurements can be found at https://docs.openstack.org/ceilometer/pike/admin/telemetry-measurements.html (which is generated from https://github.com/openstack/ceilometer/doc/source/admin/telemetry-measurements.rst).

Meters are specified both for transfer from Ceilometer to Monasca API and from Monasca to Ceilometer v2 API (for versions supporting it). In a nutshell, pipeline YAML from Ceilometer along with the ceilometer_static_info_mapping.yaml from Ceilosca define what goes to Monasca API, and ceilosca_mapping.yaml defines what gets mapped back from Monasca API to Ceilometer v2 API (deprecated).

Some meters require additional configuration in Ceilometer. For example, the SDN pollster meters need specialized drivers. For more information about how Ceilometer collects meters through polling or collecting, please reference the Telemetry documentation and measurements.

Defining which meters are published from Ceilometer to Monasca API

As with Ceilometer, the list of meters to be published is specified in /etc/ceilometer/pipeline.yaml.

As metering data accumulates over time, it is recommended that Ceilometer be configured to only publish meters where the customer has a need for the data. Additionally, it is recommended to check the measurements captured by Monasca agents to avoid any duplication of data.

To enable or disable meters,

1. Identify the current list of meters being collected, specified in /etc/ceilometer/pipeline.yaml. Hint: You can see which meters are currently being reported through ``monasca metric-list`` (or ``ceilometer meter-list`` in Pike and earlier).
2. Edit the /etc/ceilometer/pipeline.yaml file to add or remove entries from the meters list. For a short example see etc/ceilometer/ceilosca_pipeline.yaml or the longer etc/ceilometer/example_pipeline.yaml.
3. Repeat changes for all control plane nodes.
4. Restart all Ceilometer notification agents, polling agents, and central services to pick up the changes.

To create new meters (or clean out removed meters),

1. Identify which meters are available for this OpenStack Ceilometer release ontelemetry-measurements.html
   • Idenfity which parameters should betransfered to Monasca.
   • Identify the Origin of the meter. Be aware that Pollster meters may require additional configuration.
2. Modify monasca_field_definitions.yml with the new meters.
3. Restart Ceilometer services on all control nodes.

Also note that HPE published documentation describing how to configure the metering service (using Ceilosca in Helion OpenStack 3.0 and later), which may be helpful for historical context. link 1 link 2 link 3

Defining which meters are available through Ceilometer v2 API (deprecated)

The Ceilometer v2 API was deprecated as of Newton and removed in Queens from the ceilometer repo. All of the published Ceilometer measurements will continue to be available through the Monasca API.

Note: It is possible, for Ceilometer versions before the Ceilometer v2 API was removed (Pike, Ocata, etc), to map Monasca gathered metrics back to the Ceilometer API by specifying them in the /etc/ceilosca-mapping.yaml file. For example, “cpu.time_ns” for a vm component can be mapped back to “cpu” in Ceilometer v2 API.

Using Monasca API meters collected by Ceilosca

Here are a few examples of how a meter gathered by Ceilometer and passed through Ceilosca can be found and used in the Monasca API.

In Ceilometer pipeline YAML file

Ceilometer meter	Monasca API metric
vcpus	vcpus
image.size	image.size
disk.root.size	disk.root.size
memory	memory
storage.objects	storage.objects

In /etc/ceilometer/ceilometer-static-info-mapping.yaml

Ceilometer meter	Monasca API metric
disk.ephemeral.size	disk.ephemeral.size
disk.root.size	disk.root.size

Note: Monasca Agent can gather many similar metrics directly, such as cpu time for a VM. For simplicity, it is recommended that the Monasca Agent be favored when choosing which metrics to use.

The source for these configuration files in the monasca-ceilometer repo is:

ceilosca
├── ceilometer
│   ├── ceilosca_mapping
│   │   ├── data
│   │   │   ├── ceilometer_static_info_mapping.yaml
│   │   │   └── ceilosca_mapping.yaml

License

Copyright (c) 2015-2017 Hewlett-Packard Development Company, L.P.

Copyright (c) 2018 SUSE LLC

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.