1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) <optionally add copywriters name>
5 ===================================
6 OPNFV Barometer User Guide
7 ===================================
9 Barometer collectd plugins description
10 ---------------------------------------
11 .. Describe the specific features and how it is realised in the scenario in a brief manner
12 .. to ensure the user understand the context for the user guide instructions to follow.
14 Collectd is a daemon which collects system performance statistics periodically
15 and provides a variety of mechanisms to publish the collected metrics. It
16 supports more than 90 different input and output plugins. Input plugins
17 retrieve metrics and publish them to the collectd deamon, while output plugins
18 publish the data they receive to an end point. collectd also has infrastructure
19 to support thresholding and notification.
21 Barometer has enabled the following collectd plugins:
23 * *dpdkstat plugin*: A read plugin that retrieves stats from the DPDK extended
26 * *dpdkevents plugin*: A read plugin that retrieves DPDK link status and DPDK
27 forwarding cores liveliness status (DPDK Keep Alive).
29 * `gnocchi plugin`_: A write plugin that pushes the retrieved stats to
30 Gnocchi. It's capable of pushing any stats read through collectd to
31 Gnocchi, not just the DPDK stats.
33 * `aodh plugin`_: A notification plugin that pushes events to Aodh, and
34 creates/updates alarms appropriately.
36 * *hugepages plugin*: A read plugin that retrieves the number of available
37 and free hugepages on a platform as well as what is available in terms of
40 * *Open vSwitch events Plugin*: A read plugin that retrieves events from OVS.
42 * *Open vSwitch stats Plugin*: A read plugin that retrieves flow and interface
45 * *mcelog plugin*: A read plugin that uses mcelog client protocol to check for
46 memory Machine Check Exceptions and sends the stats for reported exceptions.
48 * *PMU plugin*: A read plugin that provides performance counters data on
49 Intel CPUs using Linux perf interface.
51 * *RDT plugin*: A read plugin that provides the last level cache utilization and
52 memory bandwidth utilization.
54 * *virt*: A read plugin that uses virtualization API *libvirt* to gather
55 statistics about virtualized guests on a system directly from the hypervisor,
56 without a need to install collectd instance on the guest.
58 * *SNMP Agent*: A write plugin that will act as a AgentX subagent that receives
59 and handles queries from SNMP master agent and returns the data collected
60 by read plugins. The SNMP Agent plugin handles requests only for OIDs
61 specified in configuration file. To handle SNMP queries the plugin gets data
62 from collectd and translates requested values from collectd's internal format
63 to SNMP format. Supports SNMP: get, getnext and walk requests.
65 All the plugins above are available on the collectd master, except for the
66 Gnocchi and Aodh plugins as they are Python-based plugins and only C plugins
67 are accepted by the collectd community. The Gnocchi and Aodh plugins live in
68 the OpenStack repositories.
70 Other plugins existing as a pull request into collectd master:
72 * *Legacy/IPMI*: A read plugin that reports platform thermals, voltages,
73 fanspeed, current, flow, power etc. Also, the plugin monitors Intelligent
74 Platform Management Interface (IPMI) System Event Log (SEL) and sends the
75 appropriate notifications based on monitored SEL events.
77 * *PCIe AER*: A read plugin that monitors PCIe standard and advanced errors and
78 sends notifications about those errors.
81 Third party application in Barometer repository:
83 * *Open vSwitch PMD stats*: An aplication that retrieves PMD stats from OVS. It is run
86 **Plugins and application included in the Euphrates release:**
88 Write Plugins: aodh plugin, SNMP agent plugin, gnocchi plugin.
90 Read Plugins/application: Intel RDT plugin, virt plugin, Open vSwitch stats plugin,
91 Open vSwitch PMD stats application.
93 Collectd capabilities and usage
94 ------------------------------------
95 .. Describe the specific capabilities and usage for <XYZ> feature.
96 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
98 .. note:: Plugins included in the OPNFV E release will be built-in for Apex integration
99 and can be configured as shown in the examples below.
101 The collectd plugins in OPNFV are configured with reasonable defaults, but can
104 Building all Barometer upstreamed plugins from scratch
105 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
106 The plugins that have been merged to the collectd master branch can all be
107 built and configured through the barometer repository.
110 * sudo permissions are required to install collectd.
111 * These instructions are for Centos 7.
113 To build all the upstream plugins, clone the barometer repo:
117 $ git clone https://gerrit.opnfv.org/gerrit/barometer
119 To install collectd as a service and install all it's dependencies:
123 $ cd barometer/systems && ./build_base_machine.sh
125 This will install collectd as a service and the base install directory
126 will be /opt/collectd.
128 Sample configuration files can be found in '/opt/collectd/etc/collectd.conf.d'
131 If you don't want to use one of the Barometer plugins, simply remove the
132 sample config file from '/opt/collectd/etc/collectd.conf.d'
134 If you plan on using the Exec plugin (for OVS_PMD_STATS or for executing scripts
135 on notification generation), the plugin requires a non-root user to execute scripts.
136 By default, `collectd_exec` user is used in the exec.conf provided in the sample
137 configurations directory under src/collectd in the Barometer repo. These scripts *DO NOT* create this user.
138 You need to create this user or modify the configuration in the sample configurations directory
139 under src/collectd to use another existing non root user before running build_base_machine.sh.
142 If you are using any Open vSwitch plugins you need to run:
146 $ sudo ovs-vsctl set-manager ptcp:6640
148 After this, you should be able to start collectd as a service
152 $ sudo systemctl status collectd
154 If you want to use granfana to display the metrics you collect, please see:
157 For more information on configuring and installing OpenStack plugins for
158 collectd, check out the `collectd-openstack-plugins GSG`_.
160 Below is the per plugin installation and configuration guide, if you only want
161 to install some/particular plugins.
165 Repo: https://github.com/collectd/collectd
169 Dependencies: DPDK (http://dpdk.org/)
171 .. note:: DPDK statistics plugin requires DPDK version 16.04 or later.
173 To build and install DPDK to /usr please see:
174 https://github.com/collectd/collectd/blob/master/docs/BUILD.dpdkstat.md
176 Building and installing collectd:
180 $ git clone https://github.com/collectd/collectd.git
183 $ ./configure --enable-syslog --enable-logfile --enable-debug
187 .. note:: If DPDK was installed in a non standard location you will need to
188 specify paths to the header files and libraries using *LIBDPDK_CPPFLAGS* and
189 *LIBDPDK_LDFLAGS*. You will also need to add the DPDK library symbols to the
190 shared library path using *ldconfig*. Note that this update to the shared
191 library path is not persistant (i.e. it will not survive a reboot).
193 Example of specifying custom paths to DPDK headers and libraries:
197 $ ./configure LIBDPDK_CPPFLAGS="path to DPDK header files" LIBDPDK_LDFLAGS="path to DPDK libraries"
199 This will install collectd to default folder ``/opt/collectd``. The collectd
200 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
201 To configure the dpdkstats plugin you need to modify the configuration file to
209 ProcessType "secondary"
211 EnabledPortMask 0xffff
212 PortName "interface1"
213 PortName "interface2"
217 To configure the dpdkevents plugin you need to modify the configuration file to
222 <LoadPlugin dpdkevents>
226 <Plugin "dpdkevents">
232 <Event "link_status">
233 SendEventsOnUpdate false
234 EnabledPortMask 0xffff
235 SendNotification true
238 SendEventsOnUpdate false
240 KeepAliveShmName "/dpdk_keepalive_shm_name"
241 SendNotification true
245 .. note:: Currently, the DPDK library doesn’t support API to de-initialize
246 the DPDK resources allocated on the initialization. It means, the collectd
247 plugin will not be able to release the allocated DPDK resources
248 (locks/memory/pci bindings etc.) correctly on collectd shutdown or reinitialize
249 the DPDK library if primary DPDK process is restarted. The only way to release
250 those resources is to terminate the process itself. For this reason, the plugin
251 forks off a separate collectd process. This child process becomes a secondary
252 DPDK process which can be run on specific CPU cores configured by user through
253 collectd configuration file (“Coremask” EAL configuration option, the
254 hexadecimal bitmask of the cores to run on).
256 For more information on the plugin parameters, please see:
257 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
259 .. note:: dpdkstat plugin initialization time depends on read interval. It
260 requires 5 read cycles to set up internal buffers and states, during that time
261 no statistics are submitted. Also, if plugin is running and the number of DPDK
262 ports is increased, internal buffers are resized. That requires 3 read cycles
263 and no port statistics are submitted during that time.
265 The Address-Space Layout Randomization (ASLR) security feature in Linux should be
266 disabled, in order for the same hugepage memory mappings to be present in all
267 DPDK multi-process applications.
273 $ sudo echo 0 > /proc/sys/kernel/randomize_va_space
275 To fully enable ASLR:
279 $ sudo echo 2 > /proc/sys/kernel/randomize_va_space
281 .. warning:: Disabling Address-Space Layout Randomization (ASLR) may have security
282 implications. It is recommended to be disabled only when absolutely necessary,
283 and only when all implications of this change have been understood.
285 For more information on multi-process support, please see:
286 http://dpdk.org/doc/guides/prog_guide/multi_proc_support.html
288 **DPDK stats plugin limitations:**
290 1. The DPDK primary process application should use the same version of DPDK
291 that collectd DPDK plugin is using;
293 2. L2 statistics are only supported;
295 3. The plugin has been tested on Intel NIC’s only.
297 **DPDK stats known issues:**
299 * DPDK port visibility
301 When network port controlled by Linux is bound to DPDK driver, the port
302 will not be available in the OS. It affects the SNMP write plugin as those
303 ports will not be present in standard IF-MIB. Thus, additional work is
304 required to be done to support DPDK ports and statistics.
308 Repo: https://github.com/collectd/collectd
312 Dependencies: None, but assumes hugepages are configured.
314 To configure some hugepages:
318 $ sudo mkdir -p /mnt/huge
319 $ sudo mount -t hugetlbfs nodev /mnt/huge
320 $ sudo bash -c "echo 14336 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages"
322 Building and installing collectd:
326 $ git clone https://github.com/collectd/collectd.git
329 $ ./configure --enable-syslog --enable-logfile --enable-hugepages --enable-debug
333 This will install collectd to default folder ``/opt/collectd``. The collectd
334 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
335 To configure the hugepages plugin you need to modify the configuration file to
346 ValuesPercentage false
349 For more information on the plugin parameters, please see:
350 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
354 Repo: https://github.com/collectd/collectd
360 * PMU tools (jevents library) https://github.com/andikleen/pmu-tools
362 To be suitable for use in collectd plugin shared library *libjevents* should be
363 compiled as position-independent code. To do this add the following line to
364 *pmu-tools/jevents/Makefile*:
370 Building and installing *jevents* library:
374 $ git clone https://github.com/andikleen/pmu-tools.git
375 $ cd pmu-tools/jevents/
379 Download the Hardware Events that are relevant to your CPU, download the appropriate
380 CPU event list json file:
384 $ wget https://raw.githubusercontent.com/andikleen/pmu-tools/master/event_download.py
385 $ python event_download.py
387 This will download the json files to the location: $HOME/.cache/pmu-events/. If you don't want to
388 download these files to the aforementioned location, set the environment variable XDG_CACHE_HOME to
389 the location you want the files downloaded to.
391 Building and installing collectd:
395 $ git clone https://github.com/collectd/collectd.git
398 $ ./configure --enable-syslog --enable-logfile --with-libjevents=/usr/local --enable-debug
402 This will install collectd to default folder ``/opt/collectd``. The collectd
403 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
404 To configure the PMU plugin you need to modify the configuration file to
409 <LoadPlugin intel_pmu>
413 ReportHardwareCacheEvents true
414 ReportKernelPMUEvents true
415 ReportSoftwareEvents true
418 If you want to monitor Intel CPU specific CPU events, make sure to enable the
419 additional two options shown below:
424 ReportHardwareCacheEvents true
425 ReportKernelPMUEvents true
426 ReportSoftwareEvents true
427 EventList "$HOME/.cache/pmu-events/GenuineIntel-6-2D-core.json"
428 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
432 If you set XDG_CACHE_HOME to anything other than the variable above - you will need to modify
433 the path for the EventList configuration.
435 For more information on the plugin parameters, please see:
436 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
440 The plugin opens file descriptors whose quantity depends on number of
441 monitored CPUs and number of monitored counters. Depending on configuration,
442 it might be required to increase the limit on the number of open file
443 descriptors allowed. This can be done using 'ulimit -n' command. If collectd
444 is executed as a service 'LimitNOFILE=' directive should be defined in
445 [Service] section of *collectd.service* file.
449 Repo: https://github.com/collectd/collectd
455 * PQoS/Intel RDT library https://github.com/01org/intel-cmt-cat.git
458 Building and installing PQoS/Intel RDT library:
462 $ git clone https://github.com/01org/intel-cmt-cat.git
465 $ make install PREFIX=/usr
467 You will need to insert the msr kernel module:
473 Building and installing collectd:
477 $ git clone https://github.com/collectd/collectd.git
480 $ ./configure --enable-syslog --enable-logfile --with-libpqos=/usr/ --enable-debug
484 This will install collectd to default folder ``/opt/collectd``. The collectd
485 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
486 To configure the RDT plugin you need to modify the configuration file to
491 <LoadPlugin intel_rdt>
498 For more information on the plugin parameters, please see:
499 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
503 Repo: https://github.com/collectd/collectd
505 Branch: feat_ipmi_events, feat_ipmi_analog
507 Dependencies: OpenIPMI library (http://openipmi.sourceforge.net/)
509 The IPMI plugin is already implemented in the latest collectd and sensors
510 like temperature, voltage, fanspeed, current are already supported there.
511 The list of supported IPMI sensors has been extended and sensors like flow,
512 power are supported now. Also, a System Event Log (SEL) notification feature
515 * The feat_ipmi_events branch includes new SEL feature support in collectd
516 IPMI plugin. If this feature is enabled, the collectd IPMI plugin will
517 dispatch notifications about new events in System Event Log.
519 * The feat_ipmi_analog branch includes the support of extended IPMI sensors in
520 collectd IPMI plugin.
522 **Install dependencies**
524 On Centos, install OpenIPMI library:
528 $ sudo yum install OpenIPMI ipmitool
530 Anyway, it's recommended to use the latest version of the OpenIPMI library as
531 it includes fixes of known issues which aren't included in standard OpenIPMI
532 library package. The latest version of the library can be found at
533 https://sourceforge.net/p/openipmi/code/ci/master/tree/. Steps to install the
534 library from sources are described below.
536 Remove old version of OpenIPMI library:
540 $ sudo yum remove OpenIPMI ipmitool
542 Build and install OpenIPMI library:
546 $ git clone https://git.code.sf.net/p/openipmi/code openipmi-code
548 $ autoreconf --install
549 $ ./configure --prefix=/usr
553 Add the directory containing ``OpenIPMI*.pc`` files to the ``PKG_CONFIG_PATH``
554 environment variable:
558 export PKG_CONFIG_PATH=/usr/lib/pkgconfig
560 Enable IPMI support in the kernel:
564 $ sudo modprobe ipmi_devintf
565 $ sudo modprobe ipmi_si
568 If HW supports IPMI, the ``/dev/ipmi0`` character device will be
571 Clone and install the collectd IPMI plugin:
575 $ git clone https://github.com/collectd/collectd
578 $ ./configure --enable-syslog --enable-logfile --enable-debug
582 This will install collectd to default folder ``/opt/collectd``. The collectd
583 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
584 To configure the IPMI plugin you need to modify the file to include:
591 SELEnabled true # only feat_ipmi_events branch supports this
596 By default, IPMI plugin will read all available analog sensor values,
597 dispatch the values to collectd and send SEL notifications.
599 For more information on the IPMI plugin parameters and SEL feature configuration,
600 please see: https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
602 Extended analog sensors support doesn't require additional configuration. The usual
603 collectd IPMI documentation can be used:
605 - https://collectd.org/wiki/index.php/Plugin:IPMI
606 - https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ipmi
610 - https://www.kernel.org/doc/Documentation/IPMI.txt
611 - http://www.intel.com/content/www/us/en/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
615 Repo: https://github.com/collectd/collectd
621 Start by installing mcelog.
624 The kernel has to have CONFIG_X86_MCE enabled. For 32bit kernels you
625 need atleast a 2.6,30 kernel.
631 $ sudo yum install mcelog
637 $ git clone https://git.kernel.org/pub/scm/utils/cpu/mce/mcelog.git
642 $ cp mcelog.service /etc/systemd/system/
643 $ systemctl enable mcelog.service
644 $ systemctl start mcelog.service
647 Verify you got a /dev/mcelog. You can verify the daemon is running completely
654 This should query the information in the running daemon. If it prints nothing
655 that is fine (no errors logged yet). More info @
656 http://www.mcelog.org/installation.html
658 Modify the mcelog configuration file "/etc/mcelog/mcelog.conf" to include or
663 socket-path = /var/run/mcelog-client
665 dimm-tracking-enabled = yes
666 dmi-prepopulate = yes
667 uc-error-threshold = 1 / 24h
668 ce-error-threshold = 10 / 24h
671 socket-tracking-enabled = yes
672 mem-uc-error-threshold = 100 / 24h
673 mem-ce-error-threshold = 100 / 24h
674 mem-ce-error-log = yes
677 memory-ce-threshold = 10 / 24h
679 memory-ce-action = soft
683 directory = /etc/mcelog
686 Clone and install the collectd mcelog plugin:
690 $ git clone https://github.com/collectd/collectd
693 $ ./configure --enable-syslog --enable-logfile --enable-debug
697 This will install collectd to default folder ``/opt/collectd``. The collectd
698 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
699 To configure the mcelog plugin you need to modify the configuration file to
709 McelogClientSocket "/var/run/mcelog-client"
710 PersistentNotification false
712 #McelogLogfile "/var/log/mcelog"
715 For more information on the plugin parameters, please see:
716 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
718 Simulating a Machine Check Exception can be done in one of 3 ways:
720 * Running $make test in the mcelog cloned directory - mcelog test suite
724 **mcelog test suite:**
726 It is always a good idea to test an error handling mechanism before it is
727 really needed. mcelog includes a test suite. The test suite relies on
728 mce-inject which needs to be installed and in $PATH.
730 You also need the mce-inject kernel module configured (with
731 CONFIG_X86_MCE_INJECT=y), compiled, installed and loaded:
735 $ modprobe mce-inject
737 Then you can run the mcelog test suite with
743 This will inject different classes of errors and check that the mcelog triggers
744 runs. There will be some kernel messages about page offlining attempts. The
745 test will also lose a few pages of memory in your system (not significant).
748 This test will kill any running mcelog, which needs to be restarted
753 A utility to inject corrected, uncorrected and fatal machine check exceptions
757 $ git clone https://git.kernel.org/pub/scm/utils/cpu/mce/mce-inject.git
760 $ modprobe mce-inject
762 Modify the test/corrected script to include the following:
767 STATUS 0xcc00008000010090
773 $ ./mce-inject < test/corrected
776 The uncorrected and fatal scripts under test will cause a platform reset.
777 Only the fatal script generates the memory errors**. In order to quickly
778 emulate uncorrected memory errors and avoid host reboot following test errors
779 from mce-test suite can be injected:
783 $ mce-inject mce-test/cases/coverage/soft-inj/recoverable_ucr/data/srao_mem_scrub
787 In addition a more in-depth test of the Linux kernel machine check facilities
788 can be done with the mce-test test suite. mce-test supports testing uncorrected
789 error handling, real error injection, handling of different soft offlining
790 cases, and other tests.
792 **Corrected memory error injection:**
794 To inject corrected memory errors:
796 * Remove sb_edac and edac_core kernel modules: rmmod sb_edac rmmod edac_core
797 * Insert einj module: modprobe einj param_extension=1
798 * Inject an error by specifying details (last command should be repeated at least two times):
802 $ APEI_IF=/sys/kernel/debug/apei/einj
803 $ echo 0x8 > $APEI_IF/error_type
804 $ echo 0x01f5591000 > $APEI_IF/param1
805 $ echo 0xfffffffffffff000 > $APEI_IF/param2
806 $ echo 1 > $APEI_IF/notrigger
807 $ echo 1 > $APEI_IF/error_inject
809 * Check the MCE statistic: mcelog --client. Check the mcelog log for injected error details: less /var/log/mcelog.
812 ^^^^^^^^^^^^^^^^^^^^^
813 OvS Plugins Repo: https://github.com/collectd/collectd
815 OvS Plugins Branch: master
817 OvS Events MIBs: The SNMP OVS interface link status is provided by standard
818 IF-MIB (http://www.net-snmp.org/docs/mibs/IF-MIB.txt)
820 Dependencies: Open vSwitch, Yet Another JSON Library (https://github.com/lloyd/yajl)
822 On Centos, install the dependencies and Open vSwitch:
826 $ sudo yum install yajl-devel
828 Steps to install Open vSwtich can be found at
829 http://docs.openvswitch.org/en/latest/intro/install/fedora/
831 Start the Open vSwitch service:
835 $ sudo service openvswitch-switch start
837 Configure the ovsdb-server manager:
841 $ sudo ovs-vsctl set-manager ptcp:6640
843 Clone and install the collectd ovs plugin:
849 $ git checkout master
851 $ ./configure --enable-syslog --enable-logfile --enable-debug
855 This will install collectd to default folder ``/opt/collectd``. The collectd
856 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
857 To configure the OVS events plugin you need to modify the configuration file to include:
861 <LoadPlugin ovs_events>
867 Socket "/var/run/openvswitch/db.sock"
868 Interfaces "br0" "veth0"
869 SendNotification true
872 To configure the OVS stats plugin you need to modify the configuration file
877 <LoadPlugin ovs_stats>
883 Socket "/var/run/openvswitch/db.sock"
887 For more information on the plugin parameters, please see:
888 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
892 Repo: https://gerrit.opnfv.org/gerrit/barometer
895 1. Open vSwitch dependencies are installed.
896 2. Open vSwitch service is running.
897 3. Ovsdb-server manager is configured.
898 You can refer `Open vSwitch Plugins`_ section above for each one of them.
900 OVS PMD stats application is run through the exec plugin.
902 To configure the OVS PMD stats application you need to modify the exec plugin configuration
911 Exec "user:group" "<path to ovs_pmd_stat.sh>"
914 .. note:: Exec plugin configuration has to be changed to use appropriate user before starting collectd service.
916 ovs_pmd_stat.sh calls the script for OVS PMD stats application with its argument:
920 sudo python /usr/local/src/ovs_pmd_stats.py" "--socket-pid-file"
921 "/var/run/openvswitch/ovs-vswitchd.pid"
925 Repo: https://github.com/collectd/collectd
929 Dependencies: NET-SNMP library
931 Start by installing net-snmp and dependencies.
937 $ sudo yum install net-snmp net-snmp-libs net-snmp-utils net-snmp-devel
938 $ sudo systemctl start snmpd.service
940 go to the `snmp configuration`_ steps.
944 Clone and build net-snmp:
948 $ git clone https://github.com/haad/net-snmp.git
950 $ ./configure --with-persistent-directory="/var/net-snmp" --with-systemd --enable-shared --prefix=/usr
959 Copy default configuration to persistent folder:
963 $ cp EXAMPLE.conf /usr/share/snmp/snmpd.conf
965 Set library path and default MIB configuration:
970 $ echo export LD_LIBRARY_PATH=/usr/lib >> .bashrc
971 $ net-snmp-config --default-mibdirs
972 $ net-snmp-config --snmpconfpath
974 Configure snmpd as a service:
979 $ cp ./dist/snmpd.service /etc/systemd/system/
980 $ systemctl enable snmpd.service
981 $ systemctl start snmpd.service
983 .. _`snmp configuration`:
985 Add the following line to snmpd.conf configuration file
986 ``/etc/snmp/snmpd.conf`` to make all OID tree visible for SNMP clients:
990 view systemview included .1
992 To verify that SNMP is working you can get IF-MIB table using SNMP client
993 to view the list of Linux interfaces:
997 $ snmpwalk -v 2c -c public localhost IF-MIB::interfaces
999 Get the default MIB location:
1003 $ net-snmp-config --default-mibdirs
1004 /opt/stack/.snmp/mibs:/usr/share/snmp/mibs
1006 Install Intel specific MIBs (if needed) into location received by
1007 ``net-snmp-config`` command (e.g. ``/usr/share/snmp/mibs``).
1011 $ git clone https://gerrit.opnfv.org/gerrit/barometer.git
1012 $ sudo cp -f barometer/mibs/*.txt /usr/share/snmp/mibs/
1013 $ sudo systemctl restart snmpd.service
1015 Clone and install the collectd snmp_agent plugin:
1020 $ git clone https://github.com/collectd/collectd
1023 $ ./configure --enable-syslog --enable-logfile --enable-debug --enable-snmp --with-libnetsnmp
1027 This will install collectd to default folder ``/opt/collectd``. The collectd
1028 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
1030 **SNMP Agent plugin is a generic plugin and cannot work without configuration**.
1031 To configure the snmp_agent plugin you need to modify the configuration file to
1032 include OIDs mapped to collectd types. The following example maps scalar
1033 memAvailReal OID to value represented as free memory type of memory plugin:
1037 LoadPlugin snmp_agent
1038 <Plugin "snmp_agent">
1039 <Data "memAvailReal">
1043 OIDs "1.3.6.1.4.1.2021.4.6.0"
1048 The ``snmpwalk`` command can be used to validate the collectd configuration:
1052 $ snmpwalk -v 2c -c public localhost 1.3.6.1.4.1.2021.4.6.0
1053 UCD-SNMP-MIB::memAvailReal.0 = INTEGER: 135237632 kB
1058 * Object instance with Counter64 type is not supported in SNMPv1. When GetNext
1059 request is received, Counter64 type objects will be skipped. When Get
1060 request is received for Counter64 type object, the error will be returned.
1061 * Interfaces that are not visible to Linux like DPDK interfaces cannot be
1062 retreived using standard IF-MIB tables.
1064 For more information on the plugin parameters, please see:
1065 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
1067 For more details on AgentX subagent, please see:
1068 http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/
1074 Repo: https://github.com/collectd/collectd
1078 Dependencies: libvirt (https://libvirt.org/), libxml2
1080 On Centos, install the dependencies:
1084 $ sudo yum install libxml2-devel libpciaccess-devel yajl-devel device-mapper-devel
1088 .. note:: libvirt version in package manager might be quite old and offer only
1089 limited functionality. Hence, building and installing libvirt from sources
1090 is recommended. Detailed instructions can bet found at:
1091 https://libvirt.org/compiling.html
1095 $ sudo yum install libvirt-devel
1097 Certain metrics provided by the plugin have a requirement on a minimal version of
1098 the libvirt API. *File system information* statistics require a *Guest Agent (GA)*
1099 to be installed and configured in a VM. User must make sure that installed GA
1100 version supports retrieving file system information. Number of *Performance monitoring events*
1101 metrics depends on running libvirt daemon version.
1103 .. note:: Please keep in mind that RDT metrics (part of *Performance monitoring
1104 events*) have to be supported by hardware. For more details on hardware support,
1106 https://github.com/01org/intel-cmt-cat
1108 Additionally perf metrics **cannot** be collected if *Intel RDT* plugin is enabled.
1110 libvirt version can be checked with following commands:
1115 $ libvirtd --version
1117 .. table:: Extended statistics requirements
1119 +-------------------------------+--------------------------+-------------+
1120 | Statistic | Min. libvirt API version | Requires GA |
1121 +===============================+==========================+=============+
1122 | Domain reason | 0.9.2 | No |
1123 +-------------------------------+--------------------------+-------------+
1124 | Disk errors | 0.9.10 | No |
1125 +-------------------------------+--------------------------+-------------+
1126 | Job statistics | 1.2.9 | No |
1127 +-------------------------------+--------------------------+-------------+
1128 | File system information | 1.2.11 | Yes |
1129 +-------------------------------+--------------------------+-------------+
1130 | Performance monitoring events | 1.3.3 | No |
1131 +-------------------------------+--------------------------+-------------+
1133 Start libvirt daemon:
1137 $ systemctl start libvirtd
1139 Create domain (VM) XML configuration file. For more information on domain XML
1140 format and examples, please see:
1141 https://libvirt.org/formatdomain.html
1143 .. note:: Installing additional hypervisor dependencies might be required before
1144 deploying virtual machine.
1146 Create domain, based on created XML file:
1150 $ virsh define DOMAIN_CFG_FILE.xml
1156 $ virsh start DOMAIN_NAME
1158 Check if domain is running:
1164 Check list of available *Performance monitoring events* and their settings:
1168 $ virsh perf DOMAIN_NAME
1170 Enable or disable *Performance monitoring events* for domain:
1174 $ virsh perf DOMAIN_NAME [--enable | --disable] EVENT_NAME --live
1176 Clone and install the collectd virt plugin:
1183 $ ./configure --enable-syslog --enable-logfile --enable-debug
1187 Where ``$REPO`` is equal to information provided above.
1189 This will install collectd to ``/opt/collectd``. The collectd configuration file
1190 ``collectd.conf`` can be found at ``/opt/collectd/etc``.
1191 To load the virt plugin user needs to modify the configuration file to include:
1197 Additionally, user can specify plugin configuration parameters in this file,
1198 such as connection URL, domain name and much more. By default extended virt plugin
1199 statistics are disabled. They can be enabled with ``ExtraStats`` option.
1205 ExtraStats "cpu_util disk disk_err domain_state fs_info job_stats_background pcpu perf vcpupin"
1208 For more information on the plugin parameters, please see:
1209 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
1211 .. _install-collectd-as-a-service:
1213 Installing collectd as a service
1214 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1215 **NOTE**: In an OPNFV installation, collectd is installed and configured as a
1218 Collectd service scripts are available in the collectd/contrib directory.
1219 To install collectd as a service:
1223 $ sudo cp contrib/systemd.collectd.service /etc/systemd/system/
1224 $ cd /etc/systemd/system/
1225 $ sudo mv systemd.collectd.service collectd.service
1226 $ sudo chmod +x collectd.service
1228 Modify collectd.service
1233 ExecStart=/opt/collectd/sbin/collectd
1234 EnvironmentFile=-/opt/collectd/etc/
1235 EnvironmentFile=-/opt/collectd/etc/
1236 CapabilityBoundingSet=CAP_SETUID CAP_SETGID
1242 $ sudo systemctl daemon-reload
1243 $ sudo systemctl start collectd.service
1244 $ sudo systemctl status collectd.service should show success
1246 Additional useful plugins
1247 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1249 **Exec Plugin** : Can be used to show you when notifications are being
1250 generated by calling a bash script that dumps notifications to file. (handy
1251 for debug). Modify /opt/collectd/etc/collectd.conf:
1257 # Exec "user:group" "/path/to/exec"
1258 NotificationExec "user" "<path to barometer>/barometer/src/collectd/collectd_sample_configs/write_notification.sh"
1261 write_notification.sh (just writes the notification passed from exec through
1262 STDIN to a file (/tmp/notifications)):
1267 rm -f /tmp/notifications
1270 echo $x$y >> /tmp/notifications
1273 output to /tmp/notifications should look like:
1281 PluginInstance:br-ex
1283 TypeInstance:link_status
1284 uuid:f2aafeec-fa98-4e76-aec5-18ae9fc74589
1286 linkstate of "br-ex" interface has been changed to "DOWN"
1288 * **logfile plugin**: Can be used to log collectd activity. Modify
1289 /opt/collectd/etc/collectd.conf to include:
1296 File "/var/log/collectd.log"
1302 Monitoring Interfaces and Openstack Support
1303 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1304 .. Figure:: monitoring_interfaces.png
1306 Monitoring Interfaces and Openstack Support
1308 The figure above shows the DPDK L2 forwarding application running on a compute
1309 node, sending and receiving traffic. Collectd is also running on this compute
1310 node retrieving the stats periodically from DPDK through the dpdkstat plugin
1311 and publishing the retrieved stats to OpenStack through the
1312 collectd-openstack-plugins.
1314 To see this demo in action please checkout: `Barometer OPNFV Summit demo`_
1316 For more information on configuring and installing OpenStack plugins for
1317 collectd, check out the `collectd-openstack-plugins GSG`_.
1321 * AAA – on top of collectd there secure agents like SNMP V3, Openstack agents
1322 etc. with their own AAA methods.
1324 * Collectd runs as a daemon with root permissions.
1326 * The `Exec plugin`_ allows the execution of external programs but counters the security
1329 * Ensuring that only one instance of the program is executed by collectd at any time
1330 * Forcing the plugin to check that custom programs are never executed with superuser
1333 * Protection of Data in flight:
1335 * It's recommend to use a minimum version of 4.7 of the Network plugin which provides
1336 the possibility to cryptographically sign or encrypt the network traffic.
1337 * Write Redis plugin or the Write MongoDB plugin are recommended to store the data.
1338 * For more information, please see: https://collectd.org/wiki/index.php?title=Networking_introduction
1340 * Known vulnerabilities include:
1342 * https://www.cvedetails.com/vulnerability-list/vendor_id-11242/Collectd.html
1344 * `CVE-2017-7401`_ fixed https://github.com/collectd/collectd/issues/2174 in Version 5.7.2.
1345 * `CVE-2016-6254`_ fixed https://mailman.verplant.org/pipermail/collectd/2016-July/006838.html
1347 * `CVE-2010-4336`_ fixed https://mailman.verplant.org/pipermail/collectd/2010-November/004277.html
1350 * http://www.cvedetails.com/product/20310/Collectd-Collectd.html?vendor_id=11242
1352 * It's recommended to only use collectd plugins from signed packages.
1356 .. [1] https://collectd.org/wiki/index.php/Naming_schema
1357 .. [2] https://github.com/collectd/collectd/blob/master/src/daemon/plugin.h
1358 .. [3] https://collectd.org/wiki/index.php/Value_list_t
1359 .. [4] https://collectd.org/wiki/index.php/Data_set
1360 .. [5] https://collectd.org/documentation/manpages/types.db.5.shtml
1361 .. [6] https://collectd.org/wiki/index.php/Data_source
1362 .. [7] https://collectd.org/wiki/index.php/Meta_Data_Interface
1364 .. _Barometer OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/
1365 .. _gnocchi plugin: https://github.com/openstack/collectd-openstack-plugins/tree/stable/ocata/
1366 .. _aodh plugin: https://github.com/openstack/collectd-openstack-plugins/tree/stable/ocata/
1367 .. _collectd-openstack-plugins GSG: https://github.com/openstack/collectd-openstack-plugins/blob/master/doc/source/GSG.rst
1368 .. _grafana guide: https://wiki.opnfv.org/display/fastpath/Installing+and+configuring+InfluxDB+and+Grafana+to+display+metrics+with+collectd
1369 .. _CVE-2017-7401: https://www.cvedetails.com/cve/CVE-2017-7401/
1370 .. _CVE-2016-6254: https://www.cvedetails.com/cve/CVE-2016-6254/
1371 .. _CVE-2010-4336: https://www.cvedetails.com/cve/CVE-2010-4336/
1372 .. _Exec plugin: https://collectd.org/wiki/index.php/Plugin:Exec