1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Anuket and others
5 ===========================
6 Anuket 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 * *dpdk_telemetry plugin*: A read plugin to collect dpdk interface stats and
30 application or global stats from dpdk telemetry library. Both 'dpdkstat' and
31 'dpdk_telemetry' plugins provides dpdk NIC Stats, but only 'dpdk_telemetry'
32 provides the DPDK Application stats. So in other words, 'dpdk_telemetry' is
33 an advanced version of dpdkstat. This plugin don't deal with dpdk events.
34 So not in related with 'dpdkevents' plugin. The mimimum dpdk version required
35 to use this plugin is 19.08.
38 dpdpkstat and dpdk_telemetry should not be used together. Use dpdk_telemetry
39 if your version of dpdk supports it (i.e. DPDK >= 19.08) and use dpdkstat otherwise.
40 dpdkstat, dpdkevents and dpdk_telemetry plugins should only be used if your dpdk
41 application doesn't already have more relevant metrics available(e.g.ovs_stats).
44 * `gnocchi plugin`_: A write plugin that pushes the retrieved stats to
45 Gnocchi. It's capable of pushing any stats read through collectd to
46 Gnocchi, not just the DPDK stats.
48 * `aodh plugin`_: A notification plugin that pushes events to Aodh, and
49 creates/updates alarms appropriately.
51 * *hugepages plugin*: A read plugin that retrieves the number of available
52 and free hugepages on a platform as well as what is available in terms of
55 * *Open vSwitch events Plugin*: A read plugin that retrieves events from OVS.
57 * *Open vSwitch stats Plugin*: A read plugin that retrieves flow and interface
60 * *mcelog plugin*: A read plugin that uses mcelog client protocol to check for
61 memory Machine Check Exceptions and sends the stats for reported exceptions.
63 * *PMU plugin*: A read plugin that provides performance counters data on
64 Intel CPUs using Linux perf interface.
66 * *RDT plugin*: A read plugin that provides the last level cache utilization and
67 memory bandwidth utilization.
69 * *virt*: A read plugin that uses virtualization API *libvirt* to gather
70 statistics about virtualized guests on a system directly from the hypervisor,
71 without a need to install collectd instance on the guest.
73 * *SNMP Agent*: A write plugin that will act as a AgentX subagent that receives
74 and handles queries from SNMP master agent and returns the data collected
75 by read plugins. The SNMP Agent plugin handles requests only for OIDs
76 specified in configuration file. To handle SNMP queries the plugin gets data
77 from collectd and translates requested values from collectd's internal format
78 to SNMP format. Supports SNMP: get, getnext and walk requests.
80 All the plugins above are available on the collectd main branch, except for
81 the Gnocchi and Aodh plugins as they are Python-based plugins and only C
82 plugins are accepted by the collectd community. The Gnocchi and Aodh plugins
83 live in the OpenStack repositories.
85 .. TODO: Update this to reflect merging of these PRs
86 Other plugins existing as a pull request into collectd main:
88 * *Legacy/IPMI*: A read plugin that reports platform thermals, voltages,
89 fanspeed, current, flow, power etc. Also, the plugin monitors Intelligent
90 Platform Management Interface (IPMI) System Event Log (SEL) and sends the
91 appropriate notifications based on monitored SEL events.
93 * *PCIe AER*: A read plugin that monitors PCIe standard and advanced errors and
94 sends notifications about those errors.
97 Third party application in Barometer repository:
99 * *Open vSwitch PMD stats*: An aplication that retrieves PMD stats from OVS. It is run
102 **Plugins and application included in the Euphrates release:**
104 Write Plugins: aodh plugin, SNMP agent plugin, gnocchi plugin.
106 Read Plugins/application: Intel RDT plugin, virt plugin, Open vSwitch stats plugin,
107 Open vSwitch PMD stats application.
109 Collectd capabilities and usage
110 -------------------------------
111 .. Describe the specific capabilities and usage for <XYZ> feature.
112 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
114 The collectd plugins in Anuket are configured with reasonable defaults, but can
117 Building all Barometer upstreamed plugins from scratch
118 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
119 The plugins that have been merged to the collectd main branch can all be
120 built and configured through the barometer repository.
123 * sudo permissions are required to install collectd.
124 * These instructions are for Centos 7.
126 To build all the upstream plugins, clone the barometer repo:
130 $ git clone https://gerrit.opnfv.org/gerrit/barometer
132 To install collectd as a service and install all it's dependencies:
136 $ cd barometer/systems && ./build_base_machine.sh
138 This will install collectd as a service and the base install directory
139 will be /opt/collectd.
141 Sample configuration files can be found in '/opt/collectd/etc/collectd.conf.d'
144 If you don't want to use one of the Barometer plugins, simply remove the
145 sample config file from '/opt/collectd/etc/collectd.conf.d'
147 If you plan on using the Exec plugin (for OVS_PMD_STATS or for executing scripts
148 on notification generation), the plugin requires a non-root user to execute scripts.
149 By default, `collectd_exec` user is used in the exec.conf provided in the sample
150 configurations directory under src/collectd in the Barometer repo. These scripts *DO NOT* create this user.
151 You need to create this user or modify the configuration in the sample configurations directory
152 under src/collectd to use another existing non root user before running build_base_machine.sh.
155 If you are using any Open vSwitch plugins you need to run:
159 $ sudo ovs-vsctl set-manager ptcp:6640
161 After this, you should be able to start collectd as a service
165 $ sudo systemctl status collectd
167 If you want to use granfana to display the metrics you collect, please see:
170 For more information on configuring and installing OpenStack plugins for
171 collectd, check out the `collectd-openstack-plugins GSG`_.
173 Below is the per plugin installation and configuration guide, if you only want
174 to install some/particular plugins.
178 Repo: https://github.com/collectd/collectd
182 Dependencies: `DPDK <https://www.dpdk.org/>`_
184 .. note:: DPDK statistics plugin requires DPDK version 16.04 or later.
186 To build and install DPDK to /usr please see:
187 https://github.com/collectd/collectd/blob/main/docs/BUILD.dpdkstat.md
189 Building and installing collectd:
193 $ git clone https://github.com/collectd/collectd.git
196 $ ./configure --enable-syslog --enable-logfile --enable-debug
200 .. note:: If DPDK was installed in a non standard location you will need to
201 specify paths to the header files and libraries using *LIBDPDK_CPPFLAGS* and
202 *LIBDPDK_LDFLAGS*. You will also need to add the DPDK library symbols to the
203 shared library path using *ldconfig*. Note that this update to the shared
204 library path is not persistant (i.e. it will not survive a reboot).
206 Example of specifying custom paths to DPDK headers and libraries:
210 $ ./configure LIBDPDK_CPPFLAGS="path to DPDK header files" LIBDPDK_LDFLAGS="path to DPDK libraries"
212 This will install collectd to default folder ``/opt/collectd``. The collectd
213 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
214 To configure the dpdkstats plugin you need to modify the configuration file to
215 include (uncomment lines as appropriate):
217 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/dpdkstat.conf
218 :start-at: LoadPlugin
221 To configure the dpdkevents plugin you need to modify the configuration file to
222 include (uncomment lines as appropriate):
224 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/dpdkevents.conf
225 :start-at: LoadPlugin
228 .. note:: Currently, the DPDK library doesn’t support API to de-initialize
229 the DPDK resources allocated on the initialization. It means, the collectd
230 plugin will not be able to release the allocated DPDK resources
231 (locks/memory/pci bindings etc.) correctly on collectd shutdown or reinitialize
232 the DPDK library if primary DPDK process is restarted. The only way to release
233 those resources is to terminate the process itself. For this reason, the plugin
234 forks off a separate collectd process. This child process becomes a secondary
235 DPDK process which can be run on specific CPU cores configured by user through
236 collectd configuration file (“Coremask” EAL configuration option, the
237 hexadecimal bitmask of the cores to run on).
239 For more information on the plugin parameters, please see:
240 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
242 .. note:: dpdkstat plugin initialization time depends on read interval. It
243 requires 5 read cycles to set up internal buffers and states, during that time
244 no statistics are submitted. Also, if plugin is running and the number of DPDK
245 ports is increased, internal buffers are resized. That requires 3 read cycles
246 and no port statistics are submitted during that time.
248 The Address-Space Layout Randomization (ASLR) security feature in Linux should be
249 disabled, in order for the same hugepage memory mappings to be present in all
250 DPDK multi-process applications.
256 $ sudo echo 0 > /proc/sys/kernel/randomize_va_space
258 To fully enable ASLR:
262 $ sudo echo 2 > /proc/sys/kernel/randomize_va_space
264 .. warning:: Disabling Address-Space Layout Randomization (ASLR) may have security
265 implications. It is recommended to be disabled only when absolutely necessary,
266 and only when all implications of this change have been understood.
268 For more information on multi-process support, please see:
269 https://doc.dpdk.org/guides/prog_guide/multi_proc_support.html
271 **DPDK stats plugin limitations:**
273 1. The DPDK primary process application should use the same version of DPDK
274 that collectd DPDK plugin is using;
276 2. L2 statistics are only supported;
278 3. The plugin has been tested on Intel NIC’s only.
280 **DPDK stats known issues:**
282 * DPDK port visibility
284 When network port controlled by Linux is bound to DPDK driver, the port
285 will not be available in the OS. It affects the SNMP write plugin as those
286 ports will not be present in standard IF-MIB. Thus, additional work is
287 required to be done to support DPDK ports and statistics.
289 **DPDK telemetry plugin**
291 Please refer to https://wiki.anuket.io/display/HOME/DPDK+Telemetry+Plugin
295 Repo: https://github.com/collectd/collectd
299 Dependencies: None, but assumes hugepages are configured.
301 To configure some hugepages:
305 $ sudo mkdir -p /mnt/huge
306 $ sudo mount -t hugetlbfs nodev /mnt/huge
307 $ sudo bash -c "echo 14336 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages"
309 Building and installing collectd:
313 $ git clone https://github.com/collectd/collectd.git
316 $ ./configure --enable-syslog --enable-logfile --enable-hugepages --enable-debug
320 This will install collectd to default folder ``/opt/collectd``. The collectd
321 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
322 To configure the hugepages plugin you need to modify the configuration file to
325 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/hugepages.conf
326 :start-at: LoadPlugin
329 For more information on the plugin parameters, please see:
330 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
334 Repo: https://github.com/collectd/collectd
340 * PMU tools (jevents library) https://github.com/andikleen/pmu-tools
342 To be suitable for use in collectd plugin shared library *libjevents* should be
343 compiled as position-independent code. To do this add the following line to
344 *pmu-tools/jevents/Makefile*:
350 Building and installing *jevents* library:
354 $ git clone https://github.com/andikleen/pmu-tools.git
355 $ cd pmu-tools/jevents/
359 Download the Hardware Events that are relevant to your CPU, download the appropriate
360 CPU event list json file:
364 $ wget https://raw.githubusercontent.com/andikleen/pmu-tools/main/event_download.py
365 $ python event_download.py
367 This will download the json files to the location: $HOME/.cache/pmu-events/. If you don't want to
368 download these files to the aforementioned location, set the environment variable XDG_CACHE_HOME to
369 the location you want the files downloaded to.
371 Building and installing collectd:
375 $ git clone https://github.com/collectd/collectd.git
378 $ ./configure --enable-syslog --enable-logfile --with-libjevents=/usr/local --enable-debug
382 This will install collectd to default folder ``/opt/collectd``. The collectd
383 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
384 To configure the PMU plugin you need to modify the configuration file to
387 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/intel_pmu.conf
388 :start-at: LoadPlugin
391 If you want to monitor Intel CPU specific CPU events, make sure to uncomment the
392 ``EventList`` and ``HardwareEvents`` options above.
395 If you set XDG_CACHE_HOME to anything other than the variable above - you will need to modify
396 the path for the EventList configuration.
398 Use ``Cores`` option to monitor metrics only for configured cores. If an empty string is provided
399 as value for this field default cores configuration is applied - that is all available cores
400 are monitored separately. To limit monitoring to cores 0-7 set the option as shown below:
406 For more information on the plugin parameters, please see:
407 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
411 The plugin opens file descriptors whose quantity depends on number of
412 monitored CPUs and number of monitored counters. Depending on configuration,
413 it might be required to increase the limit on the number of open file
414 descriptors allowed. This can be done using 'ulimit -n' command. If collectd
415 is executed as a service 'LimitNOFILE=' directive should be defined in
416 [Service] section of *collectd.service* file.
420 Repo: https://github.com/collectd/collectd
426 * PQoS/Intel RDT library https://github.com/intel/intel-cmt-cat
429 Building and installing PQoS/Intel RDT library:
433 $ git clone https://github.com/intel/intel-cmt-cat
436 $ make install PREFIX=/usr
438 You will need to insert the msr kernel module:
444 Building and installing collectd:
448 $ git clone https://github.com/collectd/collectd.git
451 $ ./configure --enable-syslog --enable-logfile --with-libpqos=/usr/ --enable-debug
455 This will install collectd to default folder ``/opt/collectd``. The collectd
456 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
457 To configure the RDT plugin you need to modify the configuration file to
460 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/rdt.conf
461 :start-at: LoadPlugin
464 For more information on the plugin parameters, please see:
465 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
469 Repo: https://github.com/collectd/collectd
471 Branch: feat_ipmi_events, feat_ipmi_analog
473 Dependencies: `OpenIPMI library <https://openipmi.sourceforge.io/>`_
475 The IPMI plugin is already implemented in the latest collectd and sensors
476 like temperature, voltage, fanspeed, current are already supported there.
477 The list of supported IPMI sensors has been extended and sensors like flow,
478 power are supported now. Also, a System Event Log (SEL) notification feature
481 * The feat_ipmi_events branch includes new SEL feature support in collectd
482 IPMI plugin. If this feature is enabled, the collectd IPMI plugin will
483 dispatch notifications about new events in System Event Log.
485 * The feat_ipmi_analog branch includes the support of extended IPMI sensors in
486 collectd IPMI plugin.
488 **Install dependencies**
490 On Centos, install OpenIPMI library:
494 $ sudo yum install OpenIPMI ipmitool
496 Anyway, it's recommended to use the latest version of the OpenIPMI library as
497 it includes fixes of known issues which aren't included in standard OpenIPMI
498 library package. The latest version of the library can be found at
499 https://sourceforge.net/p/openipmi/code/ci/master/tree/. Steps to install the
500 library from sources are described below.
502 Remove old version of OpenIPMI library:
506 $ sudo yum remove OpenIPMI ipmitool
508 Build and install OpenIPMI library:
512 $ git clone https://git.code.sf.net/p/openipmi/code openipmi-code
514 $ autoreconf --install
515 $ ./configure --prefix=/usr
519 Add the directory containing ``OpenIPMI*.pc`` files to the ``PKG_CONFIG_PATH``
520 environment variable:
524 export PKG_CONFIG_PATH=/usr/lib/pkgconfig
526 Enable IPMI support in the kernel:
530 $ sudo modprobe ipmi_devintf
531 $ sudo modprobe ipmi_si
534 If HW supports IPMI, the ``/dev/ipmi0`` character device will be
537 Clone and install the collectd IPMI plugin:
541 $ git clone https://github.com/collectd/collectd
544 $ ./configure --enable-syslog --enable-logfile --enable-debug
548 This will install collectd to default folder ``/opt/collectd``. The collectd
549 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
550 To configure the IPMI plugin you need to modify the file to include:
557 SELEnabled true # only feat_ipmi_events branch supports this
562 By default, IPMI plugin will read all available analog sensor values,
563 dispatch the values to collectd and send SEL notifications.
565 For more information on the IPMI plugin parameters and SEL feature configuration,
566 please see: https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
568 Extended analog sensors support doesn't require additional configuration. The usual
569 collectd IPMI documentation can be used:
571 - https://collectd.org/wiki/index.php/Plugin:IPMI
572 - https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ipmi
576 - https://www.kernel.org/doc/Documentation/IPMI.txt
577 - https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
581 Repo: https://github.com/collectd/collectd
585 Dependencies: `mcelog <http://mcelog.org/>`_
587 Start by installing mcelog.
590 The kernel has to have CONFIG_X86_MCE enabled. For 32bit kernels you
591 need atleast a 2.6,30 kernel.
597 $ sudo yum install mcelog
603 $ git clone https://git.kernel.org/pub/scm/utils/cpu/mce/mcelog.git
608 $ cp mcelog.service /etc/systemd/system/
609 $ systemctl enable mcelog.service
610 $ systemctl start mcelog.service
613 Verify you got a /dev/mcelog. You can verify the daemon is running completely
620 This should query the information in the running daemon. If it prints nothing
621 that is fine (no errors logged yet). More info @
622 http://www.mcelog.org/installation.html
624 Modify the mcelog configuration file "/etc/mcelog/mcelog.conf" to include or
629 socket-path = /var/run/mcelog-client
631 dimm-tracking-enabled = yes
632 dmi-prepopulate = yes
633 uc-error-threshold = 1 / 24h
634 ce-error-threshold = 10 / 24h
637 socket-tracking-enabled = yes
638 mem-uc-error-threshold = 100 / 24h
639 mem-ce-error-threshold = 100 / 24h
640 mem-ce-error-log = yes
643 memory-ce-threshold = 10 / 24h
645 memory-ce-action = soft
649 directory = /etc/mcelog
652 Clone and install the collectd mcelog plugin:
656 $ git clone https://github.com/collectd/collectd
659 $ ./configure --enable-syslog --enable-logfile --enable-debug
663 This will install collectd to default folder ``/opt/collectd``. The collectd
664 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
665 To configure the mcelog plugin you need to modify the configuration file to
668 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/mcelog.conf
669 :start-at: LoadPlugin
672 For more information on the plugin parameters, please see:
673 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
675 Simulating a Machine Check Exception can be done in one of 3 ways:
677 * Running $make test in the mcelog cloned directory - mcelog test suite
681 **mcelog test suite:**
683 It is always a good idea to test an error handling mechanism before it is
684 really needed. mcelog includes a test suite. The test suite relies on
685 mce-inject which needs to be installed and in $PATH.
687 You also need the mce-inject kernel module configured (with
688 CONFIG_X86_MCE_INJECT=y), compiled, installed and loaded:
692 $ modprobe mce-inject
694 Then you can run the mcelog test suite with
700 This will inject different classes of errors and check that the mcelog triggers
701 runs. There will be some kernel messages about page offlining attempts. The
702 test will also lose a few pages of memory in your system (not significant).
705 This test will kill any running mcelog, which needs to be restarted
710 A utility to inject corrected, uncorrected and fatal machine check exceptions
714 $ git clone https://git.kernel.org/pub/scm/utils/cpu/mce/mce-inject.git
717 $ modprobe mce-inject
719 Modify the test/corrected script to include the following:
724 STATUS 0xcc00008000010090
730 $ ./mce-inject < test/corrected
733 The uncorrected and fatal scripts under test will cause a platform reset.
734 Only the fatal script generates the memory errors**. In order to quickly
735 emulate uncorrected memory errors and avoid host reboot following test errors
736 from mce-test suite can be injected:
740 $ mce-inject mce-test/cases/coverage/soft-inj/recoverable_ucr/data/srao_mem_scrub
744 In addition a more in-depth test of the Linux kernel machine check facilities
745 can be done with the mce-test test suite. mce-test supports testing uncorrected
746 error handling, real error injection, handling of different soft offlining
747 cases, and other tests.
749 **Corrected memory error injection:**
751 To inject corrected memory errors:
753 * Remove sb_edac and edac_core kernel modules: rmmod sb_edac rmmod edac_core
754 * Insert einj module: modprobe einj param_extension=1
755 * Inject an error by specifying details (last command should be repeated at least two times):
759 $ APEI_IF=/sys/kernel/debug/apei/einj
760 $ echo 0x8 > $APEI_IF/error_type
761 $ echo 0x01f5591000 > $APEI_IF/param1
762 $ echo 0xfffffffffffff000 > $APEI_IF/param2
763 $ echo 1 > $APEI_IF/notrigger
764 $ echo 1 > $APEI_IF/error_inject
766 * Check the MCE statistic: mcelog --client. Check the mcelog log for injected error details: less /var/log/mcelog.
770 OvS Plugins Repo: https://github.com/collectd/collectd
772 OvS Plugins Branch: main
774 OvS Events MIBs: The SNMP OVS interface link status is provided by standard
775 `IF-MIB <http://www.net-snmp.org/docs/mibs/IF-MIB.txt>`_
777 Dependencies: Open vSwitch, `Yet Another JSON Library <https://github.com/lloyd/yajl>`_
779 On Centos, install the dependencies and Open vSwitch:
783 $ sudo yum install yajl-devel
785 Steps to install Open vSwtich can be found at
786 https://docs.openvswitch.org/en/latest/intro/install/fedora/
788 Start the Open vSwitch service:
792 $ sudo service openvswitch-switch start
794 Configure the ovsdb-server manager:
798 $ sudo ovs-vsctl set-manager ptcp:6640
800 Clone and install the collectd ovs plugin:
808 $ ./configure --enable-syslog --enable-logfile --enable-debug
812 This will install collectd to default folder ``/opt/collectd``. The collectd
813 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
814 To configure the OVS events plugin you need to modify the configuration file
815 (uncommenting and updating values as appropriate) to include:
817 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/ovs_events.conf
818 :start-at: LoadPlugin
821 To configure the OVS stats plugin you need to modify the configuration file
822 (uncommenting and updating values as appropriate) to include:
824 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/ovs_stats.conf
825 :start-at: LoadPlugin
828 For more information on the plugin parameters, please see:
829 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
833 Repo: https://gerrit.opnfv.org/gerrit/gitweb?p=barometer.git
837 #. Open vSwitch dependencies are installed.
838 #. Open vSwitch service is running.
839 #. Ovsdb-server manager is configured.
841 You can refer `Open vSwitch Plugins`_ section above for each one of them.
843 OVS PMD stats application is run through the exec plugin.
845 To configure the OVS PMD stats application you need to modify the exec plugin configuration
854 Exec "user:group" "<path to ovs_pmd_stat.sh>"
857 .. note:: Exec plugin configuration has to be changed to use appropriate user before starting collectd service.
859 ``ovs_pmd_stat.sh`` calls the script for OVS PMD stats application with its argument:
861 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/ovs_pmd_stats.sh
867 Repo: https://github.com/collectd/collectd
871 Dependencies: NET-SNMP library
873 Start by installing net-snmp and dependencies.
879 $ sudo yum install net-snmp net-snmp-libs net-snmp-utils net-snmp-devel
880 $ sudo systemctl start snmpd.service
882 go to the `snmp configuration`_ steps.
886 Clone and build net-snmp:
890 $ git clone https://github.com/haad/net-snmp.git
892 $ ./configure --with-persistent-directory="/var/net-snmp" --with-systemd --enable-shared --prefix=/usr
901 Copy default configuration to persistent folder:
905 $ cp EXAMPLE.conf /usr/share/snmp/snmpd.conf
907 Set library path and default MIB configuration:
912 $ echo export LD_LIBRARY_PATH=/usr/lib >> .bashrc
913 $ net-snmp-config --default-mibdirs
914 $ net-snmp-config --snmpconfpath
916 Configure snmpd as a service:
921 $ cp ./dist/snmpd.service /etc/systemd/system/
922 $ systemctl enable snmpd.service
923 $ systemctl start snmpd.service
925 .. _`snmp configuration`:
927 Add the following line to snmpd.conf configuration file
928 ``/etc/snmp/snmpd.conf`` to make all OID tree visible for SNMP clients:
932 view systemview included .1
934 To verify that SNMP is working you can get IF-MIB table using SNMP client
935 to view the list of Linux interfaces:
939 $ snmpwalk -v 2c -c public localhost IF-MIB::interfaces
941 Get the default MIB location:
945 $ net-snmp-config --default-mibdirs
946 /opt/stack/.snmp/mibs:/usr/share/snmp/mibs
948 Install Intel specific MIBs (if needed) into location received by
949 ``net-snmp-config`` command (e.g. ``/usr/share/snmp/mibs``).
953 $ git clone https://gerrit.opnfv.org/gerrit/barometer.git
954 $ sudo cp -f barometer/mibs/*.txt /usr/share/snmp/mibs/
955 $ sudo systemctl restart snmpd.service
957 Clone and install the collectd snmp_agent plugin:
962 $ git clone https://github.com/collectd/collectd
965 $ ./configure --enable-syslog --enable-logfile --enable-debug --enable-snmp --with-libnetsnmp
969 This will install collectd to default folder ``/opt/collectd``. The collectd
970 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
972 **SNMP Agent plugin is a generic plugin and cannot work without configuration**.
973 To configure the snmp_agent plugin you need to modify the configuration file to
974 include OIDs mapped to collectd types. The following example maps scalar
975 memAvailReal OID to value represented as free memory type of memory plugin:
979 LoadPlugin snmp_agent
980 <Plugin "snmp_agent">
981 <Data "memAvailReal">
985 OIDs "1.3.6.1.4.1.2021.4.6.0"
990 The ``snmpwalk`` command can be used to validate the collectd configuration:
994 $ snmpwalk -v 2c -c public localhost 1.3.6.1.4.1.2021.4.6.0
995 UCD-SNMP-MIB::memAvailReal.0 = INTEGER: 135237632 kB
1000 * Object instance with Counter64 type is not supported in SNMPv1. When GetNext
1001 request is received, Counter64 type objects will be skipped. When Get
1002 request is received for Counter64 type object, the error will be returned.
1003 * Interfaces that are not visible to Linux like DPDK interfaces cannot be
1004 retreived using standard IF-MIB tables.
1006 For more information on the plugin parameters, please see:
1007 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
1009 For more details on AgentX subagent, please see:
1010 http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/
1016 Repo: https://github.com/collectd/collectd
1020 Dependencies: `libvirt <https://libvirt.org/>`_, libxml2
1022 On Centos, install the dependencies:
1026 $ sudo yum install libxml2-devel libpciaccess-devel yajl-devel device-mapper-devel
1030 .. note:: libvirt version in package manager might be quite old and offer only
1031 limited functionality. Hence, building and installing libvirt from sources
1032 is recommended. Detailed instructions can bet found at:
1033 https://libvirt.org/compiling.html
1037 $ sudo yum install libvirt-devel
1039 Certain metrics provided by the plugin have a requirement on a minimal version of
1040 the libvirt API. *File system information* statistics require a *Guest Agent (GA)*
1041 to be installed and configured in a VM. User must make sure that installed GA
1042 version supports retrieving file system information. Number of *Performance monitoring events*
1043 metrics depends on running libvirt daemon version.
1045 .. note:: Please keep in mind that RDT metrics (part of *Performance monitoring
1046 events*) have to be supported by hardware. For more details on hardware support,
1048 https://github.com/intel/intel-cmt-cat
1050 Additionally perf metrics **cannot** be collected if *Intel RDT* plugin is enabled.
1052 libvirt version can be checked with following commands:
1057 $ libvirtd --version
1059 .. table:: Extended statistics requirements
1061 +-------------------------------+--------------------------+-------------+
1062 | Statistic | Min. libvirt API version | Requires GA |
1063 +===============================+==========================+=============+
1064 | Domain reason | 0.9.2 | No |
1065 +-------------------------------+--------------------------+-------------+
1066 | Disk errors | 0.9.10 | No |
1067 +-------------------------------+--------------------------+-------------+
1068 | Job statistics | 1.2.9 | No |
1069 +-------------------------------+--------------------------+-------------+
1070 | File system information | 1.2.11 | Yes |
1071 +-------------------------------+--------------------------+-------------+
1072 | Performance monitoring events | 1.3.3 | No |
1073 +-------------------------------+--------------------------+-------------+
1075 Start libvirt daemon:
1079 $ systemctl start libvirtd
1081 Create domain (VM) XML configuration file. For more information on domain XML
1082 format and examples, please see:
1083 https://libvirt.org/formatdomain.html
1085 .. note:: Installing additional hypervisor dependencies might be required before
1086 deploying virtual machine.
1088 Create domain, based on created XML file:
1092 $ virsh define DOMAIN_CFG_FILE.xml
1098 $ virsh start DOMAIN_NAME
1100 Check if domain is running:
1106 Check list of available *Performance monitoring events* and their settings:
1110 $ virsh perf DOMAIN_NAME
1112 Enable or disable *Performance monitoring events* for domain:
1116 $ virsh perf DOMAIN_NAME [--enable | --disable] EVENT_NAME --live
1118 Clone and install the collectd virt plugin:
1125 $ ./configure --enable-syslog --enable-logfile --enable-debug
1129 Where ``$REPO`` is equal to information provided above.
1131 This will install collectd to ``/opt/collectd``. The collectd configuration file
1132 ``collectd.conf`` can be found at ``/opt/collectd/etc``.
1133 To load the virt plugin user needs to modify the configuration file to include:
1139 Additionally, user can specify plugin configuration parameters in this file,
1140 such as connection URL, domain name and much more. By default extended virt plugin
1141 statistics are disabled. They can be enabled with ``ExtraStats`` option.
1147 ExtraStats "cpu_util disk disk_err domain_state fs_info job_stats_background pcpu perf vcpupin"
1150 For more information on the plugin parameters, please see:
1151 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
1153 .. _install-collectd-as-a-service:
1155 Installing collectd as a service
1156 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1158 Collectd service scripts are available in the collectd/contrib directory.
1159 To install collectd as a service:
1163 $ sudo cp contrib/systemd.collectd.service /etc/systemd/system/
1164 $ cd /etc/systemd/system/
1165 $ sudo mv systemd.collectd.service collectd.service
1166 $ sudo chmod +x collectd.service
1168 Modify collectd.service
1173 ExecStart=/opt/collectd/sbin/collectd
1174 EnvironmentFile=-/opt/collectd/etc/
1175 EnvironmentFile=-/opt/collectd/etc/
1176 CapabilityBoundingSet=CAP_SETUID CAP_SETGID
1182 $ sudo systemctl daemon-reload
1183 $ sudo systemctl start collectd.service
1184 $ sudo systemctl status collectd.service should show success
1186 Additional useful plugins
1187 ^^^^^^^^^^^^^^^^^^^^^^^^^
1189 **Exec Plugin** : Can be used to show you when notifications are being
1190 generated by calling a bash script that dumps notifications to file. (handy
1191 for debug). Modify ``/opt/collectd/etc/collectd.conf`` to include the
1192 ``NotificationExec`` config option, taking care to add the right directory path
1193 to the ``write_notification.sh`` script:
1195 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/exec.conf
1196 :start-at: LoadPlugin
1200 ``write_notification.sh`` writes the notification passed from exec through
1201 STDIN to a file (``/tmp/notifications``):
1203 .. literalinclude:: ../../../src/collectd/collectd_sample_configs/write_notification.sh
1207 output to ``/tmp/notifications`` should look like:
1215 PluginInstance:br-ex
1217 TypeInstance:link_status
1218 uuid:f2aafeec-fa98-4e76-aec5-18ae9fc74589
1220 linkstate of "br-ex" interface has been changed to "DOWN"
1222 * **logfile plugin**: Can be used to log collectd activity. Modify
1223 /opt/collectd/etc/collectd.conf to include:
1230 File "/var/log/collectd.log"
1236 Monitoring Interfaces and Openstack Support
1237 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1238 .. Figure:: monitoring_interfaces.png
1240 Monitoring Interfaces and Openstack Support
1242 The figure above shows the DPDK L2 forwarding application running on a compute
1243 node, sending and receiving traffic. Collectd is also running on this compute
1244 node retrieving the stats periodically from DPDK through the dpdkstat plugin
1245 and publishing the retrieved stats to OpenStack through the
1246 collectd-openstack-plugins.
1248 To see this demo in action please checkout: `Barometer OPNFV Summit demo`_
1250 For more information on configuring and installing OpenStack plugins for
1251 collectd, check out the `collectd-openstack-plugins GSG`_.
1255 * AAA – on top of collectd there secure agents like SNMP V3, Openstack agents
1256 etc. with their own AAA methods.
1258 * Collectd runs as a daemon with root permissions.
1260 * The `Exec plugin`_ allows the execution of external programs but counters the security
1263 * Ensuring that only one instance of the program is executed by collectd at any time
1264 * Forcing the plugin to check that custom programs are never executed with superuser
1267 * Protection of Data in flight:
1269 * It's recommend to use a minimum version of 4.7 of the Network plugin which provides
1270 the possibility to cryptographically sign or encrypt the network traffic.
1271 * Write Redis plugin or the Write MongoDB plugin are recommended to store the data.
1272 * For more information, please see: https://collectd.org/wiki/index.php?title=Networking_introduction
1274 * Known vulnerabilities include:
1276 * https://www.cvedetails.com/vulnerability-list/vendor_id-11242/Collectd.html
1278 * `CVE-2017-7401`_ fixed https://github.com/collectd/collectd/issues/2174 in Version 5.7.2.
1279 * `CVE-2016-6254`_ fixed https://mailman.verplant.org/pipermail/collectd/2016-July/006838.html
1281 * `CVE-2010-4336`_ fixed https://mailman.verplant.org/pipermail/collectd/2010-November/004277.html
1284 * https://www.cvedetails.com/product/20310/Collectd-Collectd.html?vendor_id=11242
1286 * It's recommended to only use collectd plugins from signed packages.
1290 .. [1] https://collectd.org/wiki/index.php/Naming_schema
1291 .. [2] https://github.com/collectd/collectd/blob/main/src/daemon/plugin.h
1292 .. [3] https://collectd.org/wiki/index.php/Value_list_t
1293 .. [4] https://collectd.org/wiki/index.php/Data_set
1294 .. [5] https://collectd.org/documentation/manpages/types.db.5.shtml
1295 .. [6] https://collectd.org/wiki/index.php/Data_source
1296 .. [7] https://collectd.org/wiki/index.php/Meta_Data_Interface
1298 .. _Barometer OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/
1299 .. _gnocchi plugin: https://opendev.org/x/collectd-openstack-plugins/src/branch/stable/ocata/
1300 .. _aodh plugin: https://opendev.org/x/collectd-openstack-plugins/src/branch/stable/ocata/
1301 .. _collectd-openstack-plugins GSG: https://opendev.org/x/collectd-openstack-plugins/src/branch/master/doc/source/GSG.rst
1302 .. _grafana guide: https://wiki.anuket.io/display/HOME/Installing+and+configuring+InfluxDB+and+Grafana+to+display+metrics+with+collectd
1303 .. _CVE-2017-7401: https://www.cvedetails.com/cve/CVE-2017-7401/
1304 .. _CVE-2016-6254: https://www.cvedetails.com/cve/CVE-2016-6254/
1305 .. _CVE-2010-4336: https://www.cvedetails.com/cve/CVE-2010-4336/
1306 .. _Exec plugin: https://collectd.org/wiki/index.php/Plugin:Exec