aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaryam Tahhan <maryam.tahhan@intel.com>2017-09-01 10:26:33 +0100
committerMaryam Tahhan <maryam.tahhan@intel.com>2017-09-01 12:22:23 +0000
commit40751018a8118e7c28ed93b98d04e41c78240bea (patch)
tree81a017e1bfe947f9bc23df1c8e9f870c78f02323
parent7160548a5f1739770d6b8a7207ddeb49a72d6f5e (diff)
docs: added detailed descriptions for the plugins
Change-Id: I151793a234615a96795d04eede486eba7aea5990 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
-rw-r--r--docs/release/release-notes/release-notes.rst35
1 files changed, 28 insertions, 7 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 428307c..c60663c 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -33,15 +33,36 @@ None to date.
Summary
------------
The Barometer@OPNFV project adds a platform telemetry agent to compute nodes
-that is capabable of retrieving platform statistics and events, and relay them
+that is capable of retrieving platform statistics and events, and relay them
to Openstack Gnocchi and Aodh. The telemetry agent currently supported by barometer
is collectd. Some additional collectd plugins and application were developed to add
-functionality to retrieve statistics or events for:
-
-Write Plugins: aodh plugin, SNMP agent plugin, gnocchi plugin.
-
-Read Plugins/application: Intel RDT plugin, virt plugin, Open vSwitch stats plugin,
-Open vSwitch PMD stats application.
+the following functionality:
+
+Write/publishing Plugins:
+
+- aodh plugin: A notification plugin that pushes events to Aodh, and
+ creates/updates alarms appropriately.
+- SNMP agent plugin: A write plugin that will act as an AgentX subagent that
+ receives and handles queries from SNMP master agent and returns the data
+ collected by read plugins. The SNMP Agent plugin handles requests only for OIDs
+ specified in configuration file. To handle SNMP queries the plugin gets data
+ from collectd and translates requested values from collectd’s internal format
+ to SNMP format. Supports SNMP: get, getnext and walk requests.
+- gnocchi plugin: A write plugin that pushes the retrieved stats to Gnocchi.
+ It’s capable of pushing any stats read through collectd to Gnocchi, not just
+ the DPDK stats.
+
+Read Plugins:
+
+- Intel RDT plugin: A read plugin that provides the last level cache
+ utilization and memory bandwidth utilization.
+- virt plugin: A read plugin that uses virtualization API libvirt to gather
+ statistics and events about virtualized guests on a system directly from the
+ hypervisor, without a need to install collectd instance on the guest.
+- Open vSwitch stats plugin: A read plugin that retrieves interface stats from
+ OVS.
+
+In addition to the previous plugins from the Danube Release described below.
Release Data
---------------