collectd-openstack-plugins/doc/source/devstackGSG.rst

Installing collectd-ceilometer-plugin with DevStack

This guide outlines how to install the collectd-ceilometer-plugin using DevStack.

Pre-requisites

• Access to the internet

Installation of DevStack

Follow the instructions provided in the following documentation to set up your own DevStack.

http://docs.openstack.org/developer/devstack/guides/single-machine.html

Once DevStack is ready to be deployed, follow the configuration steps in the next section to allow the installation of the plugin during deployment.

Configuration of DevStack

These configuration instructions only allow for the minimal installation of collectd, ceilometer and the plugin. The sample local.conf provided must be edited to enable additional services.

To configure DevStack for to install the plugin, download the sample local.conf from the collectd-ceilometer-plugin repo into your DevStack directory.

$ cd devstack
$ wget https://github.com/openstack/collectd-ceilometer-plugin/blob/master/doc/source/examples/local.conf.minimal

Edit the "HOST_IP" varible to appropriately match your environment.

Include your chosen "CEILOMETER_BACKEND", as there is no default backend for ceilometer. The options for this backend include mysql,es,postgresql or mongodb.

If you wish to enable any extra features please follow the instructions in the "Additional Features" section below before moving on to the next step.

Create your DevStack environment:

$ ./stack.sh

Verfication of collectd-ceilometer-plugin

Confirm that the collectd service is up and running:

$ sudo systemctl status collectd.service

By default, collectd enables the "cpu.cpu" meter. Check that the statistics for this meter are being sent to ceilometer, thus confirming that collectd is working with ceilometer.

$ ceilometer sample-list --meter cpu.cpu

Additional Features

Custom Units

This feature enables users to define new units for existing meter values. To enable this feature execute the following instructions:

• To include your new units, add the following line with your chosen units to your local.conf file.

  COLLECTD_CUSTOM_UNITS="<meter> <unit>"

• If you would like to add more than one new unit include them in the same line and seperate each meter and its unit with a comma, as shown below.

  COLLECTD_CUSTOM_UNITS="<meter> <unit>,<meter> <unit>"

Gnocchi

To deploy with gnocchi using DevStack, add the following to you local.conf:

enable_plugin collectd-ceilometer-plugin http://github.com/openstack/collectd-ceilometer-plugin

COLLECTD_INSTALL=True

# GNOCCHI
enable_plugin gnocchi https://github.com/openstack/gnocchi master
enable_service gnocchi-api,gnocchi-metricd,gnocchi-statsd
GNOCCHI_USE_KEYSTONE=True
COLLECTD_GNOCCHI_ENABLED=True

Aodh

Aodh is an alarming service that allows an alarm to be created and/or updated if there is something unusual happening with the system. When this service is enabled via the collectd-ceilometer-plugin, it allows alarms to be created/updated for all notifications sent from collectd. All notifications sent from collectd are configured as event alarms in Aodh. To enable aodh with collectd, add the following to your local.conf:

# AODH
enable_plugin aodh https://git.openstack.org/openstack/aodh

COLLECTD_AODH_ENABLED=True

In addition to this, alarms can be created manually via the Aodh command line based on the metrics generated by the gnocchi plugin and meters from the ceilometer plugin. For more information on this please read <alarms_guide.rst>

Finally an alarm can also be created in a heat template. The instructions for this are provided in <heat_scaling_guide.rst>

This enables you to scale a resource that you define based on the triggering of an alarm.