1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 ======================================
5 Barometer post installation procedures
6 ======================================
7 This document describes briefly the methods of validating the Barometer installation.
9 Automated post installation activities
10 --------------------------------------
11 The Barometer test-suite in Functest is called ``barometercollectd`` and is part of the ``Features``
12 tier. Running these tests is done automatically by the OPNFV deployment pipeline on the supported
13 scenarios. The testing consists of basic verifications that each plugin is functional per their
14 default configurations. Inside the Functest container, the detailed results can be found in the
15 ``/home/opnfv/functest/results/barometercollectd.log``.
17 Barometer post configuration procedures
18 ---------------------------------------
19 The functionality for each plugin (such as enabling/disabling and configuring its capabilities)
20 is controlled as described in the User Guide through their individual ``.conf`` file located in
21 the ``/etc/collectd/collectd.conf.d/`` folder on the compute node(s). In order for any changes to
22 take effect, the collectd service must be stopped and then started again.
24 Platform components validation - Apex
25 -------------------------------------
26 The following steps describe how to perform a simple "manual" testing of the Barometer components:
30 1. Get a list of the available metrics:
34 $ openstack metric list
36 2. Take note of the ID of the metric of interest, and show the measures of this metric:
40 $ openstack metric measures show <metric_id>
42 3. Watch the measure list for updates to verify that metrics are being added:
46 $ watch –n2 –d openstack metric measures show <metric_id>
48 More on testing and displaying metrics is shown below.
52 1. Connect to any compute node and ensure that the collectd service is running. The log file
53 ``collectd.log`` should contain no errors and should indicate that each plugin was successfully
54 loaded. For example, from the Jump Host:
58 $ opnfv-util overcloud compute0
59 $ ls /etc/collectd/collectd.conf.d/
60 $ systemctl status collectd
61 $ vi /opt/stack/collectd.log
63 The following plugings should be found loaded:
64 aodh, gnocchi, hugepages, intel_rdt, mcelog, ovs_events, ovs_stats, snmp, virt
66 2. On the compute node, induce an event monitored by the plugins; e.g. a corrected memory error:
70 $ git clone https://git.kernel.org/pub/scm/utils/cpu/mce/mce-inject.git
75 Modify the test/corrected script to include the following:
80 STATUS 0xcc00008000010090
87 $ ./mce-inject < test/corrected
89 3. Connect to the controller and query the monitoring services. Make sure the overcloudrc.v3
90 file has been copied to the controller (from the undercloud VM or from the Jump Host) in order
91 to be able to authenticate for OpenStack services.
95 $ opnfv-util overcloud controller0
97 $ source overcloudrc.v3
101 The output for the gnocchi and aodh queries should be similar to the excerpts below:
105 +--------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------+-----------+-------------+
106 | id | archive_policy/name | name | unit | resource_id |
107 +--------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------+-----------+-------------+
109 | 0550d7c1-384f-4129-83bc-03321b6ba157 | high | overcloud-novacompute-0.jf.intel.com-hugepages-mm-2048Kb@vmpage_number.free | Pages | None |
110 | 0cf9f871-0473-4059-9497-1fea96e5d83a | high | overcloud-novacompute-0.jf.intel.com-hugepages-node0-2048Kb@vmpage_number.free | Pages | None |
111 | 0d56472e-99d2-4a64-8652-81b990cd177a | high | overcloud-novacompute-0.jf.intel.com-hugepages-node1-1048576Kb@vmpage_number.used | Pages | None |
112 | 0ed71a49-6913-4e57-a475-d30ca2e8c3d2 | high | overcloud-novacompute-0.jf.intel.com-hugepages-mm-1048576Kb@vmpage_number.used | Pages | None |
113 | 11c7be53-b2c1-4c0e-bad7-3152d82c6503 | high | overcloud-novacompute-0.jf.intel.com-mcelog- | None | None |
114 | | | SOCKET_0_CHANNEL_any_DIMM_any@errors.uncorrected_memory_errors_in_24h | | |
115 | 120752d4-385e-4153-aed8-458598a2a0e0 | high | overcloud-novacompute-0.jf.intel.com-cpu-24@cpu.interrupt | jiffies | None |
116 | 1213161e-472e-4e1b-9e56-5c6ad1647c69 | high | overcloud-novacompute-0.jf.intel.com-cpu-6@cpu.softirq | jiffies | None |
119 +--------------------------------------+-------+------------------------------------------------------------------+-------+----------+---------+
120 | alarm_id | type | name | state | severity | enabled |
121 +--------------------------------------+-------+------------------------------------------------------------------+-------+----------+---------+
122 | fbd06539-45dd-42c5-a991-5c5dbf679730 | event | gauge.memory_erros(overcloud-novacompute-0.jf.intel.com-mcelog) | ok | moderate | True |
123 | d73251a5-1c4e-4f16-bd3d-377dd1e8cdbe | event | gauge.mcelog_status(overcloud-novacompute-0.jf.intel.com-mcelog) | ok | moderate | True |
127 Barometer post installation verification for Compass4nfv
128 --------------------------------------------------------
130 For Fraser release, Compass4nfv integrated the ``barometer-collectd`` container of Barometer.
131 As a result, on the compute node, collectd runs in a Docker container. On the controller node,
132 Grafana and InfluxDB are installed and configured.
134 The following steps describe how to perform simple "manual" testing of the Barometer components
135 after successfully deploying a Barometer scenario using Compass4nfv:
139 1. Connect to any compute node and ensure that the collectd container is running.
143 root@host2:~# docker ps | grep collectd
145 You should see the container ``opnfv/barometer-collectd`` running.
147 2. Testing using mce-inject is similar to testing done in Apex.
151 3. Connect to the controller and query the monitoring services. Make sure to log in to the lxc-utility
152 container before using the OpenStack CLI. Please refer to this wiki for details:
153 https://wiki.opnfv.org/display/compass4nfv/Containerized+Compass#ContainerizedCompass-HowtouseOpenStackCLI
157 root@host1-utility-container-d15da033:~# source ~/openrc
158 root@host1-utility-container-d15da033:~# gnocchi metric list
159 root@host1-utility-container-d15da033:~# aodh alarm list
161 The output for the gnocchi and aodh queries should be similar to the excerpts shown in the section above for Apex.
163 4. Use a web browser to connect to Grafana at ``http://<serverip>:3000/``, using the hostname or
164 IP of your Ubuntu server and port 3000. Log in with admin/admin. You will see ``collectd``
165 InfluxDB database in the ``Data Sources``. Also, you will notice metrics coming in the several
166 dashboards such as ``CPU Usage`` and ``Host Overview``.
168 For more details on the Barometer containers, Grafana and InfluxDB, please refer to
169 the following documentation links:
170 https://wiki.opnfv.org/display/fastpath/Barometer+Containers#BarometerContainers-barometer-collectdcontainer
171 http://docs.opnfv.org/en/latest/submodules/barometer/docs/release/userguide/docker.userguide.html#barometer-collectd-image