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 Release Notes
6 ======================================================================
8 This document provides the release notes for Euphrates release of Barometer.
17 The Barometer@OPNFV project adds a platform telemetry agent to compute nodes
18 that is capable of retrieving platform statistics and events, and relay them
19 to Openstack Gnocchi and Aodh. The telemetry agent currently supported by barometer
20 is collectd. Some additional collectd plugins and application were developed to add
21 the following functionality:
23 Write/publishing Plugins:
25 - aodh plugin: A notification plugin that pushes events to Aodh, and
26 creates/updates alarms appropriately.
27 - SNMP agent plugin: A write plugin that will act as an AgentX subagent that
28 receives and handles queries from SNMP master agent and returns the data
29 collected by read plugins. The SNMP Agent plugin handles requests only for OIDs
30 specified in configuration file. To handle SNMP queries the plugin gets data
31 from collectd and translates requested values from collectd’s internal format
32 to SNMP format. Supports SNMP: get, getnext and walk requests.
33 - gnocchi plugin: A write plugin that pushes the retrieved stats to Gnocchi.
34 It’s capable of pushing any stats read through collectd to Gnocchi, not just
39 - Intel RDT plugin: A read plugin that provides the last level cache
40 utilization and memory bandwidth utilization.
41 - virt plugin: A read plugin that uses virtualization API libvirt to gather
42 statistics and events about virtualized guests on a system directly from the
43 hypervisor, without a need to install collectd instance on the guest.
44 - Open vSwitch stats plugin: A read plugin that retrieves interface stats from
47 In addition to the previous plugins from the Danube Release described below.
52 +--------------------------------------+--------------------------------------+
53 | **Project** | Euphrates/barometer/barometer@opnfv |
55 +--------------------------------------+--------------------------------------+
56 | **Repo/commit-ID** | barometer/opnfv-5.1.0 |
58 +--------------------------------------+--------------------------------------+
59 | **Release designation** | Euphrates 5.1.0 |
61 +--------------------------------------+--------------------------------------+
62 | **Release date** | December 15th, 2017 |
64 +--------------------------------------+--------------------------------------+
65 | **Purpose of the delivery** | Official OPNFV release |
67 +--------------------------------------+--------------------------------------+
72 Module version changes
73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75 - There have been no version changes.
77 Document version changes
78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84 ~~~~~~~~~~~~~~~~~~~~~~~
88 +--------------------------------------+--------------------------------------+
89 | **JIRA REFERENCE** | **SLOGAN** |
91 +--------------------------------------+--------------------------------------+
92 | BAROMETER-51 | RDT Cache Feature |
94 +--------------------------------------+--------------------------------------+
95 | BAROMETER-53 | RAS Metrics and Events/ |
96 | | MCELOG Memory Errors |
97 +--------------------------------------+--------------------------------------+
98 | BAROMETER-55 | Libvirt Metrics and Events |
100 +--------------------------------------+--------------------------------------+
101 | BAROMETER-56 | Openvswitch Mrtics and Events |
103 +--------------------------------------+--------------------------------------+
104 | BAROMETER-59 | AODH plugin |
106 +--------------------------------------+--------------------------------------+
107 | BAROMETER-60 | Gnocchi Plugin |
109 +--------------------------------------+--------------------------------------+
110 | BAROMETER-58 | SNMP Agent |
112 +--------------------------------------+--------------------------------------+
119 +--------------------------------------+--------------------------------------+
120 | **JIRA REFERENCE** | **SLOGAN** |
122 +--------------------------------------+--------------------------------------+
123 | BAROMETER-80 | SNMP Agent testing with Intel RDT, |
124 | | MCELOG, Hugepages, and OVS Stats not |
125 | | functional in the Apex image of OPNFV|
127 +--------------------------------------+--------------------------------------+
130 +--------------------------------------+--------------------------------------+
135 Software deliverables
136 ^^^^^^^^^^^^^^^^^^^^^^^
143 The features implemented for OPNFV release B (as part of SFQM) in DPDK include:
145 * Callback API to enable TX/RX timestamping to measure latency through DPDK.
146 * Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed
147 statistics for DPDK interfaces in addition to the overall aggregate statistics.
152 The features implemented for OPNFV release C (as part of SFQM) include:
154 * DPDK extended NIC stats API improvement; migrate from key value pairs to
155 using id value pairs.
156 * DPDK Keep Alive improvement, so that core status is exposed through a posix
157 shared memory object.
158 * collectd dpdkstat plugin that can retrieve DPDK interface statistics.
159 * collectd ceilometer plugin that can publish any statistics collected by
160 collectd to ceilometer.
161 * Fuel plugin support for the collectd ceilometer plugin for OPNFV.
165 The features implemented for OPNFV release D include:
167 * collectd hugepages plugin that can retrieves the number of available and free hugepages
168 on a platform as well as what is available in terms of hugepages per socket.
169 * collectd Open vSwitch Events plugin that can retrieves events from OVS.
170 * collectd mcelog plugin that can use mcelog client protocol to check for memory Machine
171 Check Exceptions and sends the stats for reported exceptions.
172 * collectd ceilometer plugin that can publish any statistics collected by
173 collectd to ceilometer.
175 Documentation deliverables
176 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
178 - Configuration guide
181 - Scenario documentation.
183 Known Limitations, Issues and Workarounds
184 --------------------------------------------
189 For Intel RDT plugin, compute node needs to support Intel RDT.
194 No known issues to date.
198 +--------------------------------------+--------------------------------------+
199 | **JIRA REFERENCE** | **SLOGAN** |
201 +--------------------------------------+--------------------------------------+
205 +--------------------------------------+--------------------------------------+
209 +--------------------------------------+--------------------------------------+
219 Barometer@OPNFV Euphrates has undergone QA test runs with the following results:
221 +--------------------------------------+--------------------------------------+
222 | **TEST-SUITE** | **Results:** |
224 +--------------------------------------+--------------------------------------+
225 | barometercollectd | |
230 +--------------------------------------+--------------------------------------+
236 +--------------------------------------+--------------------------------------+