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 ===================================
13 Barometer collectd plugins description
14 ---------------------------------------
15 .. Describe the specific features and how it is realised in the scenario in a brief manner
16 .. to ensure the user understand the context for the user guide instructions to follow.
18 collectd is a daemon which collects system performance statistics periodically
19 and provides a variety of mechanisms to publish the collected metrics. It
20 supports more than 90 different input and output plugins. Input plugins
21 retrieve metrics and publish them to the collectd deamon, while output plugins
22 publish the data they receive to an end point. collectd also has infrastructure
23 to support thresholding and notification.
25 Barometer has enabled the following collectd plugins:
27 * *dpdkstat plugin*: A read plugin that retrieve stats from the DPDK extended
30 * *dpdkevents plugin*: A read plugin that retrieves DPDK link status and DPDK
31 forwarding cores liveliness status (DPDK Keep Alive).
33 * `gnocchi plugin`_: A write plugin that pushes the retrieved stats to
34 Gnocchi. It's capable of pushing any stats read through collectd to
35 Gnocchi, not just the DPDK stats.
37 * `aodh plugin`_: A notification plugin that pushes events to Aodh, and
38 creates/updates alarms appropriately.
40 * *hugepages plugin*: A read plugin that retrieves the number of available
41 and free hugepages on a platform as well as what is available in terms of
44 * *Open vSwitch events Plugin*: A read plugin that retrieves events from OVS.
46 * *Open vSwitch stats Plugin*: A read plugin that retrieves flow and interface
49 * *mcelog plugin*: A read plugin that uses mcelog client protocol to check for
50 memory Machine Check Exceptions and sends the stats for reported exceptions
52 * *RDT plugin*: A read plugin that provides the last level cache utilization and
53 memory bandwidth utilization
55 All the plugins above are available on the collectd master, except for the
56 Gnocchi and Aodh plugins as they are Python-based plugins and only C plugins
57 are accepted by the collectd community. The Gnocchi and Aodh plugins live in
58 the OpenStack repositories.
60 Other plugins existing as a pull request into collectd master:
62 * *SNMP Agent*: A write plugin that will act as a AgentX subagent that receives
63 and handles queries from SNMP master agent and returns the data collected
64 by read plugins. The SNMP Agent plugin handles requests only for OIDs
65 specified in configuration file. To handle SNMP queries the plugin gets data
66 from collectd and translates requested values from collectd's internal format
67 to SNMP format. Supports SNMP: get, getnext and walk requests.
69 * *Legacy/IPMI*: A read plugin that reports platform thermals, voltages,
70 fanspeed, current, flow, power etc. Also, the plugin monitors Intelligent
71 Platform Management Interface (IPMI) System Event Log (SEL) and sends the
73 * *virt*: A read plugin that uses virtualization API *libvirt* to gather
74 statistics about virtualized guests on a system directly from the hypervisor,
75 without a need to install collectd instance on the guest.
77 **Plugins included in the Danube release:**
84 collectd capabilities and usage
85 ------------------------------------
86 .. Describe the specific capabilities and usage for <XYZ> feature.
87 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
89 .. note:: Plugins included in the OPNFV D release will be built-in to the fuel
90 plugin and available in the /opt/opnfv directory on the fuel master. You don't
91 need to clone the barometer/collectd repos to use these, but you can configure
92 them as shown in the examples below.
94 The collectd plugins in OPNFV are configured with reasonable defaults, but can
97 Building all Barometer upstreamed plugins from scratch
98 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99 The plugins that have been merged to the collectd master branch can all be
100 built and configured through the barometer repository.
103 * sudo permissions are required to install collectd.
104 * These are instructions for Ubuntu 16.04
106 To build all the upstream plugins, clone the barometer repo:
110 $ git clone https://gerrit.opnfv.org/gerrit/barometer
112 To install collectd as a service and install all it's dependencies:
116 $ cd barometer/systems && ./build_base_machine.sh
118 This will install collectd as a service and the base install directory
119 will be /opt/collectd.
121 Sample configuration files can be found in '/opt/collectd/etc/collectd.conf.d'
124 - If you plan on using the Exec plugin, the plugin requires non-root
125 user to execute scripts. By default, `collectd_exec` user is used. Barometer
126 scripts do *not* create this user. It needs to be manually added or exec plugin
127 configuration has to be changed to use other, existing user before starting
130 - If you don't want to use one of the Barometer plugins, simply remove the
131 sample config file from '/opt/collectd/etc/collectd.conf.d'
133 - If you are using any Open vSwitch plugins you need to run:
137 $ sudo ovs-vsctl set-manager ptcp:6640
140 Below is the per plugin installation and configuration guide, if you only want
141 to install some/particular plugins.
145 Repo: https://github.com/collectd/collectd
149 Dependencies: DPDK (http://dpdk.org/)
151 .. note:: DPDK statistics plugin requires DPDK version 16.04 or later
153 To build and install DPDK to /usr please see:
154 https://github.com/collectd/collectd/blob/master/docs/BUILD.dpdkstat.md
156 Building and installing collectd:
160 $ git clone https://github.com/collectd/collectd.git
163 $ ./configure --enable-syslog --enable-logfile --enable-debug
167 .. note:: If DPDK was installed in a non standard location you will need to
168 specify paths to the header files and libraries using *LIBDPDK_CPPFLAGS* and
169 *LIBDPDK_LDFLAGS*. You will also need to add the DPDK library symbols to the
170 shared library path using *ldconfig*. Note that this update to the shared
171 library path is not persistant (i.e. it will not survive a reboot).
173 Example of specifying custom paths to DPDK headers and libraries:
177 $ ./configure LIBDPDK_CPPFLAGS="path to DPDK header files" LIBDPDK_LDFLAGS="path to DPDK libraries"
179 This will install collectd to /opt/collectd
180 The collectd configuration file can be found at /opt/collectd/etc
182 To configure the dpdkstats plugin you need to modify the configuration file to
192 ProcessType "secondary"
195 EnabledPortMask 0xffff
196 PortName "interface1"
197 PortName "interface2"
201 To configure the dpdkevents plugin you need to modify the configuration file to
206 LoadPlugin dpdkevents
207 <Plugin "dpdkevents">
212 ProcessType "secondary"
215 <Event "link_status">
216 SendEventsOnUpdate true
217 EnabledPortMask 0xffff
218 PortName "interface1"
219 PortName "interface2"
220 SendNotification false
223 SendEventsOnUpdate true
225 KeepAliveShmName "/dpdk_keepalive_shm_name"
226 SendNotification false
230 .. note:: Currently, the DPDK library doesn’t support API to de-initialize
231 the DPDK resources allocated on the initialization. It means, the collectd
232 plugin will not be able to release the allocated DPDK resources
233 (locks/memory/pci bindings etc.) correctly on collectd shutdown or reinitialize
234 the DPDK library if primary DPDK process is restarted. The only way to release
235 those resources is to terminate the process itself. For this reason, the plugin
236 forks off a separate collectd process. This child process becomes a secondary
237 DPDK process which can be run on specific CPU cores configured by user through
238 collectd configuration file (“Coremask” EAL configuration option, the
239 hexadecimal bitmask of the cores to run on).
241 For more information on the plugin parameters, please see:
242 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
244 .. note:: dpdkstat plugin initialization time depends on read interval. It
245 requires 5 read cycles to set up internal buffers and states. During that time
246 no statistics are submitted. Also if plugin is running and the number of DPDK
247 ports is increased, internal buffers are resized. That requires 3 read cycles
248 and no port statistics are submitted in that time.
250 The Address-Space Layout Randomization (ASLR) security feature in Linux should be
251 disabled, in order for the same hugepage memory mappings to be present in all
252 DPDK multi-process applications.
258 $ sudo echo 0 > /proc/sys/kernel/randomize_va_space
260 To fully enable ASLR:
264 $ sudo echo 2 > /proc/sys/kernel/randomize_va_space
266 .. warning:: Disabling Address-Space Layout Randomization (ASLR) may have security
267 implications. It is recommended to be disabled only when absolutely necessary,
268 and only when all implications of this change have been understood.
270 For more information on multi-process support, please see:
271 http://dpdk.org/doc/guides/prog_guide/multi_proc_support.html
273 **DPDK stats plugin limitations:**
275 1. The DPDK primary process application should use the same version of DPDK
276 that collectd DPDK plugin is using;
278 2. L2 statistics are only supported;
280 3. The plugin has been tested on Intel NIC’s only.
282 **DPDK stats known issues:**
284 * DPDK port visibility
286 When network port controlled by Linux is bound to DPDK driver, the port
287 will not be available in the OS. It affects the SNMP write plugin as those
288 ports will not be present in standard IF-MIB. Thus addition work is
289 required to be done to support DPDK ports and statistics.
293 Repo: https://github.com/collectd/collectd
297 Dependencies: None, but assumes hugepages are configured.
299 To configure some hugepages:
303 sudo mkdir -p /mnt/huge
304 sudo mount -t hugetlbfs nodev /mnt/huge
305 sudo echo 14336 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
307 Building and installing collectd:
311 $ git clone https://github.com/collectd/collectd.git
314 $ ./configure --enable-syslog --enable-logfile --enable-hugepages --enable-debug
318 This will install collectd to /opt/collectd
319 The collectd configuration file can be found at /opt/collectd/etc
320 To configure the hugepages plugin you need to modify the configuration file to
331 ValuesPercentage false
334 For more information on the plugin parameters, please see:
335 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
339 Repo: https://github.com/collectd/collectd
345 * PQoS/Intel RDT library https://github.com/01org/intel-cmt-cat.git
348 Building and installing PQoS/Intel RDT library:
352 $ git clone https://github.com/01org/intel-cmt-cat.git
355 $ make install PREFIX=/usr
357 You will need to insert the msr kernel module:
363 Building and installing collectd:
367 $ git clone https://github.com/collectd/collectd.git
370 $ ./configure --enable-syslog --enable-logfile --with-libpqos=/usr/ --enable-debug
374 This will install collectd to /opt/collectd
375 The collectd configuration file can be found at /opt/collectd/etc
376 To configure the RDT plugin you need to modify the configuration file to
381 <LoadPlugin intel_rdt>
388 For more information on the plugin parameters, please see:
389 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
393 Repo: https://github.com/maryamtahhan/collectd
395 Branch: feat_ipmi_events, feat_ipmi_analog
397 Dependencies: OpenIPMI library (http://openipmi.sourceforge.net/)
399 The IPMI plugin is already implemented in the latest collectd and sensors
400 like temperature, voltage, fanspeed, current are already supported there.
401 The list of supported IPMI sensors has been extended and sensors like flow,
402 power are supported now. Also, a System Event Log (SEL) notification feature
405 * The feat_ipmi_events branch includes new SEL feature support in collectd
406 IPMI plugin. If this feature is enabled, the collectd IPMI plugin will
407 dispatch notifications about new events in System Event Log.
409 * The feat_ipmi_analog branch includes the support of extended IPMI sensors in
410 collectd IPMI plugin.
412 **Install dependencies**
414 On Ubuntu, the OpenIPMI library can be installed via apt package manager:
418 $ sudo apt-get install libopenipmi-dev
420 Anyway, it's recommended to use the latest version of the OpenIPMI library as
421 it includes fixes of known issues which aren't included in standard OpenIPMI
422 library package. The latest version of the library can be found at
423 https://sourceforge.net/p/openipmi/code/ci/master/tree/. Steps to install the
424 library from sources are described below.
426 Remove old version of OpenIPMI library:
430 $ sudo apt-get remove libopenipmi-dev
432 Download OpenIPMI library sources:
436 $ git clone https://git.code.sf.net/p/openipmi/code openipmi-code
439 Patch the OpenIPMI pkg-config file to provide correct compilation flags
440 for collectd IPMI plugin:
444 diff --git a/OpenIPMIpthread.pc.in b/OpenIPMIpthread.pc.in
445 index 59b52e5..fffa0d0 100644
446 --- a/OpenIPMIpthread.pc.in
447 +++ b/OpenIPMIpthread.pc.in
448 @@ -6,6 +6,6 @@ includedir=@includedir@
449 Name: OpenIPMIpthread
450 Description: Pthread OS handler for OpenIPMI
452 -Requires: OpenIPMI pthread
454 Libs: -L${libdir} -lOpenIPMIutils -lOpenIPMIpthread
455 -Cflags: -I${includedir}
456 +Cflags: -I${includedir} -pthread
458 Build and install OpenIPMI library:
462 $ autoreconf --install
463 $ ./configure --prefix=/usr
467 Enable IPMI support in the kernel:
471 $ sudo modprobe ipmi_devintf
472 $ sudo modprobe ipmi_si
474 **Note**: If HW supports IPMI, the ``/dev/ipmi0`` character device will be
477 Clone and install the collectd IPMI plugin:
481 $ git clone https://github.com/maryamtahhan/collectd
483 $ git checkout $BRANCH
485 $ ./configure --enable-syslog --enable-logfile --enable-debug
489 Where $BRANCH is feat_ipmi_events or feat_ipmi_analog.
491 This will install collectd to default folder ``/opt/collectd``. The collectd
492 configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``. To
493 configure the IPMI plugin you need to modify the file to include:
499 SELEnabled true # only feat_ipmi_events branch supports this
502 **Note**: By default, IPMI plugin will read all available analog sensor values,
503 dispatch the values to collectd and send SEL notifications.
505 For more information on the IPMI plugin parameters and SEL feature configuration,
507 https://github.com/maryamtahhan/collectd/blob/feat_ipmi_events/src/collectd.conf.pod
509 Extended analog sensors support doesn't require additional configuration. The usual
510 collectd IPMI documentation can be used:
512 - https://collectd.org/wiki/index.php/Plugin:IPMI
513 - https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ipmi
517 - https://www.kernel.org/doc/Documentation/IPMI.txt
518 - http://www.intel.com/content/www/us/en/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
522 Repo: https://github.com/collectd/collectd
528 Start by installing mcelog. Note: The kernel has to have CONFIG_X86_MCE
529 enabled. For 32bit kernels you need at least a 2.6,30 kernel.
535 $ apt-get update && apt-get install mcelog
541 $ git clone git://git.kernel.org/pub/scm/utils/cpu/mce/mcelog.git
546 $ cp mcelog.service /etc/systemd/system/
547 $ systemctl enable mcelog.service
548 $ systemctl start mcelog.service
551 Verify you got a /dev/mcelog. You can verify the daemon is running completely
558 This should query the information in the running daemon. If it prints nothing
559 that is fine (no errors logged yet). More info @
560 http://www.mcelog.org/installation.html
562 Modify the mcelog configuration file "/etc/mcelog/mcelog.conf" to include or
567 socket-path = /var/run/mcelog-client
569 Clone and install the collectd mcelog plugin:
573 $ git clone https://github.com/maryamtahhan/collectd
575 $ git checkout feat_ras
577 $ ./configure --enable-syslog --enable-logfile --enable-debug
581 This will install collectd to /opt/collectd
582 The collectd configuration file can be found at /opt/collectd/etc
583 To configure the mcelog plugin you need to modify the configuration file to
592 McelogClientSocket "/var/run/mcelog-client"
595 For more information on the plugin parameters, please see:
596 https://github.com/maryamtahhan/collectd/blob/feat_ras/src/collectd.conf.pod
598 Simulating a Machine Check Exception can be done in one of 3 ways:
600 * Running $make test in the mcelog cloned directory - mcelog test suite
604 **mcelog test suite:**
606 It is always a good idea to test an error handling mechanism before it is
607 really needed. mcelog includes a test suite. The test suite relies on
608 mce-inject which needs to be installed and in $PATH.
610 You also need the mce-inject kernel module configured (with
611 CONFIG_X86_MCE_INJECT=y), compiled, installed and loaded:
615 $ modprobe mce-inject
617 Then you can run the mcelog test suite with
623 This will inject different classes of errors and check that the mcelog triggers
624 runs. There will be some kernel messages about page offlining attempts. The
625 test will also lose a few pages of memory in your system (not significant)
626 **Note this test will kill any running mcelog, which needs to be restarted
627 manually afterwards**.
630 A utility to inject corrected, uncorrected and fatal machine check exceptions
634 $ git clone https://git.kernel.org/pub/scm/utils/cpu/mce/mce-inject.git
637 $ modprobe mce-inject
639 Modify the test/corrected script to include the following:
644 STATUS 0xcc00008000010090
650 $ ./mce-inject < test/corrected
652 **Note: the uncorrected and fatal scripts under test will cause a platform reset.
653 Only the fatal script generates the memory errors**. In order to quickly
654 emulate uncorrected memory errors and avoid host reboot following test errors
655 from mce-test suite can be injected:
659 $ mce-inject mce-test/cases/coverage/soft-inj/recoverable_ucr/data/srao_mem_scrub
663 In addition an more in-depth test of the Linux kernel machine check facilities
664 can be done with the mce-test test suite. mce-test supports testing uncorrected
665 error handling, real error injection, handling of different soft offlining
666 cases, and other tests.
668 **Corrected memory error injection:**
670 To inject corrected memory errors:
672 * Remove sb_edac and edac_core kernel modules: rmmod sb_edac rmmod edac_core
673 * Insert einj module: modprobe einj param_extension=1
674 * Inject an error by specifying details (last command should be repeated at least two times):
678 $ APEI_IF=/sys/kernel/debug/apei/einj
679 $ echo 0x8 > $APEI_IF/error_type
680 $ echo 0x01f5591000 > $APEI_IF/param1
681 $ echo 0xfffffffffffff000 > $APEI_IF/param2
682 $ echo 1 > $APEI_IF/notrigger
683 $ echo 1 > $APEI_IF/error_inject
685 * Check the MCE statistic: mcelog --client. Check the mcelog log for injected error details: less /var/log/mcelog.
688 ^^^^^^^^^^^^^^^^^^^^^
689 OvS Plugins Repo: https://github.com/collectd/collectd
691 OvS Plugins Branch: master
693 OvS Events MIBs: The SNMP OVS interface link status is provided by standard
694 IF-MIB (http://www.net-snmp.org/docs/mibs/IF-MIB.txt)
696 Dependencies: Open vSwitch, Yet Another JSON Library (https://github.com/lloyd/yajl)
698 On Ubuntu, install the dependencies:
702 $ sudo apt-get install libyajl-dev openvswitch-switch
704 Start the Open vSwitch service:
708 $ sudo service openvswitch-switch start
710 configure the ovsdb-server manager:
714 $ sudo ovs-vsctl set-manager ptcp:6640
716 Clone and install the collectd ovs plugin:
722 $ git checkout master
724 $ ./configure --enable-syslog --enable-logfile --enable-debug
728 This will install collectd to /opt/collectd. The collectd configuration file
729 can be found at /opt/collectd/etc. To configure the OVS events plugin you
730 need to modify the configuration file to include:
734 <LoadPlugin ovs_events>
737 <Plugin "ovs_events">
739 Socket "/var/run/openvswitch/db.sock"
740 Interfaces "br0" "veth0"
741 SendNotification false
745 To configure the OVS stats plugin you need to modify the configuration file
750 <LoadPlugin ovs_stats>
756 Socket "/var/run/openvswitch/db.sock"
757 Bridges "br0" "br_ext"
760 For more information on the plugin parameters, please see:
761 https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
765 Repo: https://github.com/maryamtahhan/collectd/
769 Dependencies: NET-SNMP library
771 Start by installing net-snmp and dependencies.
777 $ apt-get install snmp snmp-mibs-downloader snmpd libsnmp-dev
778 $ systemctl start snmpd.service
782 Become root to install net-snmp dependencies
786 $ apt-get install libperl-dev
788 Clone and build net-snmp
792 $ git clone https://github.com/haad/net-snmp.git
794 $ ./configure --with-persistent-directory="/var/net-snmp" --with-systemd --enable-shared --prefix=/usr
803 Copy default configuration to persistent folder
807 $ cp EXAMPLE.conf /usr/share/snmp/snmpd.conf
809 Set library path and default MIB configuration
814 $ echo export LD_LIBRARY_PATH=/usr/lib >> .bashrc
815 $ net-snmp-config --default-mibdirs
816 $ net-snmp-config --snmpconfpath
818 Configure snmpd as a service
823 $ cp ./dist/snmpd.service /etc/systemd/system/
824 $ systemctl enable snmpd.service
825 $ systemctl start snmpd.service
827 Add the following line to snmpd.conf configuration file
828 "/usr/share/snmp/snmpd.conf" to make all OID tree visible for SNMP clients:
832 view systemonly included .1
834 To verify that SNMP is working you can get IF-MIB table using SNMP client
835 to view the list of Linux interfaces:
839 $ snmpwalk -v 2c -c public localhost IF-MIB::interfaces
841 Clone and install the collectd snmp_agent plugin:
845 $ git clone https://github.com/maryamtahhan/collectd
847 $ git checkout feat_snmp
849 $ ./configure --enable-syslog --enable-logfile --enable-debug --enable-snmp --with-libnetsnmp
853 This will install collectd to /opt/collectd
854 The collectd configuration file can be found at /opt/collectd/etc
855 **SNMP Agent plugin is a generic plugin and cannot work without configuration**.
856 To configure the snmp_agent plugin you need to modify the configuration file to
857 include OIDs mapped to collectd types. The following example maps scalar
858 memAvailReal OID to value represented as free memory type of memory plugin:
862 LoadPlugin snmp_agent
863 <Plugin "snmp_agent">
864 <Data "memAvailReal">
868 OIDs "1.3.6.1.4.1.2021.4.6.0"
874 * Object instance with Counter64 type is not supported in SNMPv1. When GetNext
875 request is received, Counter64 type objects will be skipped. When Get
876 request is received for Counter64 type object, the error will be returned.
877 * Interfaces that are not visible to Linux like DPDK interfaces cannot be
878 retreived using standard IF-MIB tables.
880 For more information on the plugin parameters, please see:
881 https://github.com/maryamtahhan/collectd/blob/feat_snmp/src/collectd.conf.pod
883 For more details on AgentX subagent, please see:
884 http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/
888 Repo: https://github.com/maryamtahhan/collectd
890 Branch: feat_libvirt_upstream
892 Dependencies: libvirt (https://libvirt.org/), libxml2
894 On Ubuntu, install the dependencies:
898 $ sudo apt-get install libxml2-dev
902 libvirt version in package manager might be quite old and offer only limited
903 functionality. Hence, building and installing libvirt from sources is recommended.
904 Detailed instructions can bet found at:
905 https://libvirt.org/compiling.html
907 Certain metrics provided by the plugin have a requirement on a minimal version of
908 the libvirt API. *File system information* statistics require a *Guest Agent (GA)*
909 to be installed and configured in a VM. User must make sure that installed GA
910 version supports retrieving file system information. Number of *Performance monitoring events*
911 metrics depends on running libvirt daemon version.
913 .. note:: Please keep in mind that RDT metrics (part of *Performance monitoring
914 events*) have to be supported by hardware. For more details on hardware support,
916 https://github.com/01org/intel-cmt-cat
918 Additionally perf metrics **cannot** be collected if *Intel RDT* plugin is enabled.
920 libvirt version can be checked with following commands:
927 .. table:: Extended statistics requirements
929 +-------------------------------+--------------------------+-------------+
930 | Statistic | Min. libvirt API version | Requires GA |
931 +===============================+==========================+=============+
932 | Domain reason | 0.9.2 | No |
933 +-------------------------------+--------------------------+-------------+
934 | Disk errors | 0.9.10 | No |
935 +-------------------------------+--------------------------+-------------+
936 | Job statistics | 1.2.9 | No |
937 +-------------------------------+--------------------------+-------------+
938 | File system information | 1.2.11 | Yes |
939 +-------------------------------+--------------------------+-------------+
940 | Performance monitoring events | 1.3.3 | No |
941 +-------------------------------+--------------------------+-------------+
943 Start libvirt daemon:
947 $ systemctl start libvirtd
949 Create domain (VM) XML configuration file. For more information on domain XML
950 format and examples, please see:
951 https://libvirt.org/formatdomain.html
953 .. note:: Installing additional hypervisor dependencies might be required before
954 deploying virtual machine.
956 Create domain, based on created XML file:
960 $ virsh define DOMAIN_CFG_FILE.xml
966 $ virsh start DOMAIN_NAME
968 Check if domain is running:
974 Check list of available *Performance monitoring events* and their settings:
978 $ virsh perf DOMAIN_NAME
980 Enable or disable *Performance monitoring events* for domain:
984 $ virsh perf DOMAIN_NAME [--enable | --disable] EVENT_NAME --live
986 Clone and install the collectd virt plugin:
992 $ git checkout $BRANCH
994 $ ./configure --enable-syslog --enable-logfile --enable-debug
998 Where ``$REPO`` and ``$BRANCH`` are equal to information provided above.
1000 This will install collectd to ``/opt/collectd``. The collectd configuration file
1001 ``collectd.conf`` can be found at ``/opt/collectd/etc``. To load the virt plugin
1002 user needs to modify the configuration file to include:
1008 Additionally, user can specify plugin configuration parameters in this file,
1009 such as connection URI, domain name and much more. By default extended virt plugin
1010 statistics are disabled. They can be enabled with ``ExtraStats`` option.
1016 ExtraStats "cpu_util disk disk_err domain_state fs_info job_stats_background pcpu perf vcpupin"
1019 For more information on the plugin parameters, please see:
1020 https://github.com/maryamtahhan/collectd/blob/feat_libvirt_upstream/src/collectd.conf.pod
1022 Installing collectd as a service
1023 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1024 **NOTE**: In an OPNFV installation, collectd is installed and configured as a
1027 Collectd service scripts are available in the collectd/contrib directory.
1028 To install collectd as a service:
1032 $ sudo cp contrib/systemd.collectd.service /etc/systemd/system/
1033 $ cd /etc/systemd/system/
1034 $ sudo mv systemd.collectd.service collectd.service
1035 $ sudo chmod +x collectd.service
1037 Modify collectd.service
1042 ExecStart=/opt/collectd/sbin/collectd
1043 EnvironmentFile=-/opt/collectd/etc/
1044 EnvironmentFile=-/opt/collectd/etc/
1045 CapabilityBoundingSet=CAP_SETUID CAP_SETGID
1051 $ sudo systemctl daemon-reload
1052 $ sudo systemctl start collectd.service
1053 $ sudo systemctl status collectd.service should show success
1055 Additional useful plugins
1056 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1058 * **Exec Plugin** : Can be used to show you when notifications are being
1059 generated by calling a bash script that dumps notifications to file. (handy
1060 for debug). Modify /opt/collectd/etc/collectd.conf:
1066 # Exec "user:group" "/path/to/exec"
1067 NotificationExec "user" "<path to barometer>/barometer/src/collectd/collectd_sample_configs/write_notification.sh"
1070 write_notification.sh (just writes the notification passed from exec through
1071 STDIN to a file (/tmp/notifications)):
1076 rm -f /tmp/notifications
1079 echo $x$y >> /tmp/notifications
1082 output to /tmp/notifications should look like:
1090 PluginInstance:br-ex
1092 TypeInstance:link_status
1093 uuid:f2aafeec-fa98-4e76-aec5-18ae9fc74589
1095 linkstate of "br-ex" interface has been changed to "DOWN"
1097 * **logfile plugin**: Can be used to log collectd activity. Modify
1098 /opt/collectd/etc/collectd.conf to include:
1105 File "/var/log/collectd.log"
1111 Monitoring Interfaces and Openstack Support
1112 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1113 .. Figure:: monitoring_interfaces.png
1115 Monitoring Interfaces and Openstack Support
1117 The figure above shows the DPDK L2 forwarding application running on a compute
1118 node, sending and receiving traffic. collectd is also running on this compute
1119 node retrieving the stats periodically from DPDK through the dpdkstat plugin
1120 and publishing the retrieved stats to OpenStack through the
1121 collectd-ceilometer-plugin.
1123 To see this demo in action please checkout: `Barometer OPNFV Summit demo`_
1125 For more information on configuring and installing OpenStack plugins for
1126 collectd, check out the `collectd-ceilometer-plugin GSG`_.
1130 .. [1] https://collectd.org/wiki/index.php/Naming_schema
1131 .. [2] https://github.com/collectd/collectd/blob/master/src/daemon/plugin.h
1132 .. [3] https://collectd.org/wiki/index.php/Value_list_t
1133 .. [4] https://collectd.org/wiki/index.php/Data_set
1134 .. [5] https://collectd.org/documentation/manpages/types.db.5.shtml
1135 .. [6] https://collectd.org/wiki/index.php/Data_source
1136 .. [7] https://collectd.org/wiki/index.php/Meta_Data_Interface
1138 .. _Barometer OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/
1139 .. _gnocchi plugin: https://github.com/openstack/collectd-ceilometer-plugin/tree/stable/ocata/
1140 .. _aodh plugin: https://github.com/openstack/collectd-ceilometer-plugin/tree/stable/ocata/
1141 .. _collectd-ceilometer-plugin GSG: https://github.com/openstack/collectd-ceilometer-plugin/blob/master/doc/source/GSG.rst