diff options
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/collectd.userguide.rst | 404 | ||||
| -rw-r--r-- | docs/userguide/dpdk_ka.png | bin | 100808 -> 0 bytes | |||
| -rw-r--r-- | docs/userguide/index.rst | 9 | ||||
| -rw-r--r-- | docs/userguide/keepalive.userguide.rst | 128 | ||||
| -rw-r--r-- | docs/userguide/stats_and_timestamps.png | bin | 52193 -> 0 bytes |
5 files changed, 279 insertions, 262 deletions
diff --git a/docs/userguide/collectd.userguide.rst b/docs/userguide/collectd.userguide.rst index 5151befc..2dcb3593 100644 --- a/docs/userguide/collectd.userguide.rst +++ b/docs/userguide/collectd.userguide.rst @@ -2,193 +2,339 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation and others. -collectd plugins description -============================ -The SFQM collectd plugins enable the ability to monitor DPDK interfaces by -exposing stats and the relevant events to higher level telemetry and fault -management applications. The following sections will discuss the SFQM features -in detail. +collectd plugins +================= +Barometer has enabled the following collectd plugins: -Measuring Telco Traffic and Performance KPIs --------------------------------------------- -This section will discuss the SFQM features that enable Measuring Telco Traffic -and Performance KPIs. +* dpdkstat plugin: A read plugin that retrieve stats from the DPDK extended + NIC stats API. -.. Figure:: stats_and_timestamps.png +* `ceilometer plugin`_: A write plugin that pushes the retrieved stats to + Ceilometer. It's capable of pushing any stats read through collectd to + Ceilometer, not just the DPDK stats. - Measuring Telco Traffic and Performance KPIs +* hugepages plugin: A read plugin that retrieves the number of available + and free hugepages on a platform as well as what is available in terms of + hugepages per socket. -* The very first thing SFQM enabled was a call-back API in DPDK and an - associated application that used the API to demonstrate how to timestamp - packets and measure packet latency in DPDK (the sample app is called - rxtx_callbacks). This was upstreamed to DPDK 2.0 and is represented by - the interfaces 1 and 2 in Figure 1.2. +* RDT plugin: A read plugin that provides the last level cache utilitzation and + memory bandwidth utilization -* The second thing SFQM implemented in DPDK is the extended NIC statistics API, - which exposes NIC stats including error stats to the DPDK user by reading the - registers on the NIC. This is represented by interface 3 in Figure 1.2. +* Open vSwitch events Plugin: A read plugin that retrieves events from OVS. - * For DPDK 2.1 this API was only implemented for the ixgbe (10Gb) NIC driver, - in association with a sample application that runs as a DPDK secondary - process and retrieves the extended NIC stats. +All the plugins above are available on the collectd master, except for the +ceilometer plugin as it's a python based plugin and only C plugins are accepted +by the collectd community. The ceilometer plugin lives in the OpenStack +repositories. - * For DPDK 2.2 the API was implemented for igb, i40e and all the Virtual - Functions (VFs) for all drivers. +Other plugins under development or existing as a pull request into collectd master: - * For DPDK 16.07 the API migrated from using string value pairs to using id - value pairs, improving the overall performance of the API. +* dpdkevents: A read plugin that retrieves DPDK link status and DPDK + forwarding cores liveliness status (DPDK Keep Alive). -Monitoring DPDK interfaces --------------------------- -With the features SFQM enabled in DPDK to enable measuring Telco traffic and -performance KPIs, we can now retrieve NIC statistics including error stats and -relay them to a DPDK user. The next step is to enable monitoring of the DPDK -interfaces based on the stats that we are retrieving from the NICs, by relaying -the information to a higher level Fault Management entity. To enable this SFQM -has been enabling a number of plugins for collectd. +* Open vSwitch stats Plugin: A read plugin that retrieve flow and interface + stats from OVS. -collectd -~~~~~~~~ -collectd is a daemon which collects system performance statistics periodically -and provides a variety of mechanisms to publish the collected metrics. It -supports more than 90 different input and output plugins. Input plugins retrieve -metrics and publish them to the collectd deamon, while output plugins publish -the data they receive to an end point. collectd also has infrastructure to -support thresholding and notification. +* mcelog plugin: A read plugin that uses mcelog client protocol to check for + memory Machine Check Exceptions and sends the stats for reported exceptions. -collectd statistics and Notifications -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Within collectd notifications and performance data are dispatched in the same -way. There are producer plugins (plugins that create notifications/metrics), -and consumer plugins (plugins that receive notifications/metrics and do -something with them). +* SNMP write: A write plugin that will act as a SNMP subagent and will map + collectd metrics to relavent OIDs. Will only support SNMP: get, getnext and + walk. -Statistics in collectd consist of a value list. A value list includes: +* Legacy/IPMI: A read plugin that will report platform thermals, voltages, + fanspeed.... -* Values, can be one of: +Building collectd with the Barometer plugins and installing the dependencies +============================================================================= - * Derive: used for values where a change in the value since it's last been - read is of interest. Can be used to calculate and store a rate. +All plugins +----------- +The plugins that have been merged to the baromter master branch can all be +built and configured through the barometer repository. - * Counter: similar to derive values, but take the possibility of a counter - wrap around into consideration. +**Note**: sudo permissions are required to install collectd. - * Gauge: used for values that are stored as is. +**Note**: These are instructions for Ubuntu 16.04. - * Absolute: used for counters that are reset after reading. +To build and install these dependencies, clone the barometer repo: -* Value length: the number of values in the data set. +.. code:: c -* Time: timestamp at which the value was collected. + $ git clone https://gerrit.opnfv.org/gerrit/barometer -* Interval: interval at which to expect a new value. +Install the build dependencies -* Host: used to identify the host. +.. code:: bash -* Plugin: used to identify the plugin. + $ ./src/install_build_deps.sh -* Plugin instance (optional): used to group a set of values together. For e.g. - values belonging to a DPDK interface. +To install collectd as a service and install all it's dependencies: -* Type: unit used to measure a value. In other words used to refer to a data - set. +.. code:: bash -* Type instance (optional): used to distinguish between values that have an - identical type. + $ cd barometer/src && sudo make && sudo make install -* meta data: an opaque data structure that enables the passing of additional - information about a value list. "Meta data in the global cache can be used to - store arbitrary information about an identifier" [7]. +This will install collectd as a service and the base install directory +is /opt/collectd. -Host, plugin, plugin instance, type and type instance uniquely identify a -collectd value. +Sample configuration files can be found in '/opt/collectd/etc/collectd.conf.d' -Values lists are often accompanied by data sets that describe the values in more -detail. Data sets consist of: +Please note if you are using any Open vSwitch plugins you need to run: -* A type: a name which uniquely identifies a data set. +.. code:: bash -* One or more data sources (entries in a data set) which include: + $ sudo ovs-vsctl set-manager ptcp:6640 - * The name of the data source. If there is only a single data source this is - set to "value". +DPDK statistics plugin +----------------------- +Repo: https://github.com/collectd/collectd - * The type of the data source, one of: counter, gauge, absolute or derive. +Branch: master - * A min and a max value. +Dependencies: DPDK (http://dpdk.org/) -Types in collectd are defined in types.db. Examples of types in types.db: +To build and install DPDK to /usr please see: +https://github.com/collectd/collectd/blob/master/docs/BUILD.dpdkstat.md -.. code-block:: console +Building and installing collectd: - bitrate value:GAUGE:0:4294967295 - counter value:COUNTER:U:U - if_octets rx:COUNTER:0:4294967295, tx:COUNTER:0:4294967295 +.. code:: bash -In the example above if_octets has two data sources: tx and rx. + $ git clone https://github.com/collectd/collectd.git + $ cd collectd + $ ./build.sh + $ ./configure --enable-syslog --enable-logfile --enable-debug + $ make + $ sudo make install -Notifications in collectd are generic messages containing: -* An associated severity, which can be one of OKAY, WARNING, and FAILURE. +This will install collectd to /opt/collectd +The collectd configuration file can be found at /opt/collectd/etc +To configure the hugepages plugin you need to modify the configuration file to +include: -* A time. +.. code:: bash -* A Message + LoadPlugin dpdkstat + <Plugin dpdkstat> + Coremask "0xf" + ProcessType "secondary" + FilePrefix "rte" + EnabledPortMask 0xffff + </Plugin> -* A host. +For more information on the plugin parameters, please see: +https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod -* A plugin. +Please note if you are configuring collectd with the **static DPDK library** +you must compile the DPDK library with the -fPIC flag: -* A plugin instance (optional). +.. code:: bash -* A type. + $ make EXTRA_CFLAGS=-fPIC -* A types instance (optional). +You must also modify the configuration step when building collectd: -* Meta-data. +.. code:: bash -collectd plugins ----------------- -Barometer has enabled the following collectd plugins: + $ ./configure CFLAGS=" -lpthread -Wl,--whole-archive -Wl,-ldpdk -Wl,-lm -Wl,-lrt -Wl,-lpcap -Wl,-ldl -Wl,--no-whole-archive" -* dpdkstat plugin: A read plugin that retrieve stats from the DPDK extended - NIC stats API. +Please also note that if you are not building and installing DPDK system-wide +you will need to specify the specific paths to the header files and libraries +using LIBDPDK_CPPFLAGS and LIBDPDK_LDFLAGS. You will also need to add the DPDK +library symbols to the shared library path using ldconfig. Note that this +update to the shared library path is not persistant (i.e. it will not survive a +reboot). Pending a merge of https://github.com/collectd/collectd/pull/2073. -* `ceilometer plugin`_: A write plugin that pushes the retrieved stats to - Ceilometer. It's capable of pushing any stats read through collectd to - Ceilometer, not just the DPDK stats. +.. code:: bash -* hugepages plugin: A read plugin that retrieves the number of available - and free hugepages on a platform as well as what is available in terms of - hugepages per socket. + $ ./configure LIBDPDK_CPPFLAGS="path to DPDK header files" LIBDPDK_LDFLAGS="path to DPDK libraries" -* RDT plugin: A read plugin that provides the last level cache utilitzation and - memory bandwidth utilization -All the plugins above are available on the collectd master, except for the -ceilometer plugin as it's a python based plugin and only C plugins are accepted -by the collectd community. The ceilometer plugin lives in the OpenStack -repositories. +Hugepages Plugin +----------------- +Repo: https://github.com/collectd/collectd -Other plugins in progress: +Branch: master -* dpdkevents: A read plugin that retrieves DPDK link status and DPDK - forwarding cores liveliness status (DPDK Keep Alive). +Dependencies: None, but assumes hugepages are configured. -* Open vSwitch stats Plugin: A read plugin that retrieve flow and interface - stats from OVS. +To configure some hugepages: -* Open vSwitch events Plugin: A read plugin that retrieves events from OVS. +.. code:: bash -* mcelog plugin: A read plugin that uses mcelog client protocol to check for - memory Machine Check Exceptions and sends the stats for reported exceptions. + sudo mkdir -p /mnt/huge + sudo mount -t hugetlbfs nodev /mnt/huge + sudo echo 14336 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages -* SNMP write: A write plugin that will act as a SNMP subagent and will map - collectd metrics to relavent OIDs. Will only support SNMP: get, getnext and - walk. +Building and installing collectd: -* Legacy/IPMI: A read plugin that will report platform thermals, voltages, - fanspeed.... +.. code:: bash + + $ git clone https://github.com/collectd/collectd.git + $ cd collectd + $ ./build.sh + $ ./configure --enable-syslog --enable-logfile --enable-hugepages --enable-debug + $ make + $ sudo make install + +This will install collectd to /opt/collectd +The collectd configuration file can be found at /opt/collectd/etc +To configure the hugepages plugin you need to modify the configuration file to +include: + +.. code:: bash + + LoadPlugin hugepages + <Plugin hugepages> + ReportPerNodeHP true + ReportRootHP true + ValuesPages true + ValuesBytes false + ValuesPercentage false + </Plugin> + +For more information on the plugin parameters, please see: +https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod + +Intel RDT Plugin +----------------- +Repo: https://github.com/collectd/collectd + +Branch: master + +Dependencies: + + * PQoS/Intel RDT library https://github.com/01org/intel-cmt-cat.git + * msr kernel module + +Building and installing PQoS/Intel RDT library: + +.. code:: bash + + $ git clone https://github.com/01org/intel-cmt-cat.git + $ cd intel-cmt-cat.git + $ make + $ make install PREFIX=/usr + +Building and installing collectd: + +.. code:: bash + + $ git clone https://github.com/collectd/collectd.git + $ cd collectd + $ ./build.sh + $ ./configure --enable-syslog --enable-logfile --with-libpqos=/usr/ --enable-debug + $ make + $ sudo make install + +This will install collectd to /opt/collectd +The collectd configuration file can be found at /opt/collectd/etc +To configure the RDT plugin you need to modify the configuration file to +include: + +.. code:: bash + + <LoadPlugin intel_rdt> + Interval 1 + </LoadPlugin> + <Plugin "intel_rdt"> + Cores "" + </Plugin> + +For more information on the plugin parameters, please see: +https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod + +Installing collectd as a service +-------------------------------- +Collectd service scripts are available in the collectd/contrib directory. +To install collectd as a service: + +.. code:: bash + + $ sudo cp contrib/systemd.collectd.service /etc/systemd/system/ + $ cd /etc/systemd/system/ + $ sudo mv systemd.collectd.service collectd.service + $ sudo chmod +x collectd.service + +Modify collectd.service + +.. code:: bash + + [Service] + ExecStart=/opt/collectd/sbin/collectd + EnvironmentFile=-/opt/collectd/etc/ + EnvironmentFile=-/opt/collectd/etc/ + CapabilityBoundingSet=CAP_SETUID CAP_SETGID + +Reload + +.. code:: bash + + $ sudo systemctl daemon-reload + $ sudo systemctl start collectd.service + $ sudo systemctl status collectd.service should show success + +Additional useful plugins +-------------------------- + +Exec Plugin +~~~~~~~~~~~ + +Can be used to show you when notifications are being generated by calling a +bash script that dumps notifications to file. (handy for debug). Modify +/opt/collectd/etc/collectd.conf: + +.. code:: bash + + LoadPlugin exec + <Plugin exec> + # Exec "user:group" "/path/to/exec" + NotificationExec "user" "<path to barometer>/barometer/src/collectd/collectd_sample_configs/write_notification.sh" + </Plugin> + +write_notification.sh (just writes the notification passed from exec through +STDIN to a file (/tmp/notifications)): + +.. code:: bash + + #!/bin/bash + rm -f /tmp/notifications + while read x y + do + echo $x$y >> /tmp/notifications + done + +output to /tmp/notifications should look like: + +.. code:: bash + + Severity:WARNING + Time:1479991318.806 + Host:localhost + Plugin:ovs_events + PluginInstance:br-ex + Type:gauge + TypeInstance:link_status + uuid:f2aafeec-fa98-4e76-aec5-18ae9fc74589 + + linkstate of "br-ex" interface has been changed to "DOWN" + +logfile plugin +~~~~~~~~~~~~~~~ +Can be used to log collectd activity. Modify /opt/collectd/etc/collectd.conf to +include: + +.. code:: bash + + LoadPlugin logfile + <Plugin logfile> + LogLevel info + File "/var/log/collectd.log" + Timestamp true + PrintSeverity false + </Plugin> Monitoring Interfaces and Openstack Support ------------------------------------------- @@ -201,7 +347,7 @@ node, sending and receiving traffic. collectd is also running on this compute node retrieving the stats periodically from DPDK through the dpdkstat plugin and publishing the retrieved stats to Ceilometer through the ceilometer plugin. -To see this demo in action please checkout: `SFQM OPNFV Summit demo`_ +To see this demo in action please checkout: `Barometer OPNFV Summit demo`_ References ---------- @@ -213,5 +359,5 @@ References [6] https://collectd.org/wiki/index.php/Data_source [7] https://collectd.org/wiki/index.php/Meta_Data_Interface -.. _SFQM OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/ +.. _Barometer OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/ .. _ceilometer plugin: https://github.com/openstack/collectd-ceilometer-plugin/tree/stable/mitaka diff --git a/docs/userguide/dpdk_ka.png b/docs/userguide/dpdk_ka.png Binary files differdeleted file mode 100644 index 4a45e10c..00000000 --- a/docs/userguide/dpdk_ka.png +++ /dev/null diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index ae459d0a..bf62a43d 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -1,10 +1,10 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. - .. http://creativecommons.org/licenses/by/4.0 - .. (c) <optionally add copywriters name> +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Intel Corporation and OPNFV -==================== +******************** Barometer user guide -==================== +******************** .. The feature user guide should provide an OPNFV user with enough information to .. use the features provided by the feature project in the supported scenarios. @@ -16,4 +16,3 @@ Barometer user guide :maxdepth: 3 collectd.userguide.rst - keepalive.userguide.rst diff --git a/docs/userguide/keepalive.userguide.rst b/docs/userguide/keepalive.userguide.rst deleted file mode 100644 index 4b6e990d..00000000 --- a/docs/userguide/keepalive.userguide.rst +++ /dev/null @@ -1,128 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -DPDK Keep Alive description -=========================== -SFQM aims to enable fault detection within DPDK, the very first feature to -meet this goal is the DPDK Keep Alive Sample app that is part of DPDK 2.2. - -DPDK Keep Alive or KA is a sample application that acts as a heartbeat/watchdog -for DPDK packet processing cores, to detect application thread failure. The -application supports the detection of ‘failed’ DPDK cores and notification to a -HA/SA middleware. The purpose is to detect Packet Processing Core fails (e.g. -infinite loop) and ensure the failure of the core does not result in a fault -that is not detectable by a management entity. - -.. Figure:: dpdk_ka.png - - DPDK Keep Alive Sample Application - -Essentially the app demonstrates how to detect 'silent outages' on DPDK packet -processing cores. The application can be decomposed into two specific parts: -detection and notification. - -* The detection period is programmable/configurable but defaults to 5ms if no - timeout is specified. -* The Notification support is enabled by simply having a hook function that where this - can be 'call back support' for a fault management application with a compliant - heartbeat mechanism. - -DPDK Keep Alive Sample App Internals ------------------------------------- -This section provides some explanation of the The Keep-Alive/'Liveliness' -conceptual scheme as well as the DPDK Keep Alive App. The initialization and -run-time paths are very similar to those of the L2 forwarding application (see -`L2 Forwarding Sample Application (in Real and Virtualized Environments)`_ for more -information). - -There are two types of cores: a Keep Alive Monitor Agent Core (master DPDK core) -and Worker cores (Tx/Rx/Forwarding cores). The Keep Alive Monitor Agent Core -will supervise worker cores and report any failure (2 successive missed pings). -The Keep-Alive/'Liveliness' conceptual scheme is: - -* DPDK worker cores mark their liveliness as they forward traffic. -* A Keep Alive Monitor Agent Core runs a function every N Milliseconds to - inspect worker core liveliness. -* If keep-alive agent detects time-outs, it notifies the fault management - entity through a call-back function. - -**Note:** Only the worker cores state is monitored. There is no mechanism or agent -to monitor the Keep Alive Monitor Agent Core. - -DPDK Keep Alive Sample App Code Internals ------------------------------------------ -The following section provides some explanation of the code aspects that are -specific to the Keep Alive sample application. - -The heartbeat functionality is initialized with a struct rte_heartbeat and the -callback function to invoke in the case of a timeout. - -.. code:: c - - rte_global_keepalive_info = rte_keepalive_create(&dead_core, NULL); - if (rte_global_hbeat_info == NULL) - rte_exit(EXIT_FAILURE, "keepalive_create() failed"); - -The function that issues the pings hbeat_dispatch_pings() is configured to run -every check_period milliseconds. - -.. code:: c - - if (rte_timer_reset(&hb_timer, - (check_period * rte_get_timer_hz()) / 1000, - PERIODICAL, - rte_lcore_id(), - &hbeat_dispatch_pings, rte_global_keepalive_info - ) != 0 ) - rte_exit(EXIT_FAILURE, "Keepalive setup failure.\n"); - -The rest of the initialization and run-time path follows the same paths as the -the L2 forwarding application. The only addition to the main processing loop is -the mark alive functionality and the example random failures. - -.. code:: c - - rte_keepalive_mark_alive(&rte_global_hbeat_info); - cur_tsc = rte_rdtsc(); - - /* Die randomly within 7 secs for demo purposes.. */ - if (cur_tsc - tsc_initial > tsc_lifetime) - break; - -The rte_keepalive_mark_alive() function simply sets the core state to alive. - -.. code:: c - - static inline void - rte_keepalive_mark_alive(struct rte_heartbeat *keepcfg) - { - keepcfg->state_flags[rte_lcore_id()] = 1; - } - -Keep Alive Monitor Agent Core Monitoring Options -The application can run on either a host or a guest. As such there are a number -of options for monitoring the Keep Alive Monitor Agent Core through a Local -Agent on the compute node: - - ====================== ========== ============= - Application Location DPDK KA LOCAL AGENT - ====================== ========== ============= - HOST X HOST/GUEST - GUEST X HOST/GUEST - ====================== ========== ============= - - -For the first implementation of a Local Agent SFQM will enable: - - ====================== ========== ============= - Application Location DPDK KA LOCAL AGENT - ====================== ========== ============= - HOST X HOST - ====================== ========== ============= - -Through extending the dpdkstat plugin for collectd with KA functionality, and -integrating the extended plugin with Monasca for high performing, resilient, -and scalable fault detection. - -.. _L2 Forwarding Sample Application (in Real and Virtualized Environments): http://dpdk.org/doc/guides/sample_app_ug/l2_forward_real_virtual.html diff --git a/docs/userguide/stats_and_timestamps.png b/docs/userguide/stats_and_timestamps.png Binary files differdeleted file mode 100644 index 84aef726..00000000 --- a/docs/userguide/stats_and_timestamps.png +++ /dev/null |
