virt plugin: Add physical cpu reporting

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 210e107..e1c7567 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -2391,18 +2391,23 @@ extended NIC stats API in DPDK.
 B<Synopsis:>
 
  <Plugin "dpdkstat">
 B<Synopsis:>
 
  <Plugin "dpdkstat">

-    Coremask "0x4"
-    MemoryChannels "4"
-    ProcessType "secondary"
-    FilePrefix "rte"
-    EnabledPortMask 0xffff
-    PortName "interface1"
-    PortName "interface2"
+   <EAL>
+     Coremask "0x4"
+     MemoryChannels "4"
+     ProcessType "secondary"
+     FilePrefix "rte"
+     SocketMemory "1024"
+   </EAL>
+   EnabledPortMask 0xffff
+   PortName "interface1"
+   PortName "interface2"

  </Plugin>
 
 B<Options:>
 
  </Plugin>
 
 B<Options:>
 

-=over 4
+=head3 The EAL block
+
+=over 5

 
 =item B<Coremask> I<Mask>
 
 
 =item B<Coremask> I<Mask>
 


@@ -2425,7 +2430,11 @@ The prefix text used for hugepage filenames. The filename will be set to
 =item B<SocketMemory> I<MB>
 
 A string containing amount of Memory to allocate from hugepages on specific
 =item B<SocketMemory> I<MB>
 
 A string containing amount of Memory to allocate from hugepages on specific

-sockets in MB
+sockets in MB. This is an optional value.
+
+=back
+
+=over 4

 
 =item B<EnabledPortMask> I<Mask>
 
 
 =item B<EnabledPortMask> I<Mask>
 


@@ -2949,6 +2958,10 @@ allows to monitor instructions per clock (IPC).
 Monitor events are hardware dependant. Monitoring capabilities are detected on
 plugin initialization and only supported events are monitored.
 
 Monitor events are hardware dependant. Monitoring capabilities are detected on
 plugin initialization and only supported events are monitored.
 

+B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
+require an additional capability to be enabled if collectd is run as a service.
+Please refer to I<contrib/systemd.collectd.service> file for more details.
+

 B<Synopsis:>
 
   <Plugin "intel_rdt">
 B<Synopsis:>
 
   <Plugin "intel_rdt">


@@ -5455,15 +5468,15 @@ refer to them from.
 
 =head2 Plugin C<ovs_events>
 
 
 =head2 Plugin C<ovs_events>
 

-The I<ovs_events> plugin monitors the link status of OVS connected interfaces,
-dispatches the values to collectd and send the notification whenever the link
-state change occurs. This plugin uses OVS DB to get a link state change
-notification.
+The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
+connected interfaces, dispatches the values to collectd and sends the
+notification whenever the link state change occurs. This plugin uses OVS
+database to get a link state change notification.

 
 B<Synopsis:>
 
  <Plugin "ovs_events">
 
 B<Synopsis:>
 
  <Plugin "ovs_events">

-   Port "6640"
+   Port 6640

    Address "127.0.0.1"
    Socket "/var/run/openvswitch/db.sock"
    Interfaces "br0" "veth0"
    Address "127.0.0.1"
    Socket "/var/run/openvswitch/db.sock"
    Interfaces "br0" "veth0"


@@ -5476,29 +5489,29 @@ The plugin provides the following configuration options:
 
 =item B<Address> I<node>
 
 
 =item B<Address> I<node>
 

-The address of OVS DB server JSON-RPC interface used by the plugin. To enable
-the interface, OVS DB daemon should be running with '--remote=ptcp:' option.
-See L<ovsdb-server(1)> for more details. The option may be either network
-hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string format.
-Defaults to 'localhost'.
+The address of the OVS DB server JSON-RPC interface used by the plugin. To
+enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
+option. See L<ovsdb-server(1)> for more details. The option may be either
+network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
+format. Defaults to B<'localhost'>.

 
 =item B<Port> I<service>
 
 TCP-port to connect to. Either a service name or a port number may be given.
 
 =item B<Port> I<service>
 
 TCP-port to connect to. Either a service name or a port number may be given.

-Please note that numerical port numbers must be given as a string. Defaults
-to "6640".
+Defaults to B<6640>.

 
 =item B<Socket> I<path>
 
 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
 plugin. To enable the interface, the OVS DB daemon should be running with
 
 =item B<Socket> I<path>
 
 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
 plugin. To enable the interface, the OVS DB daemon should be running with

-'--remote=punix:' option. See L<ovsdb-server(1)> for more details. If this
+C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this

 option is set, B<Address> and B<Port> options are ignored.
 
 =item B<Interfaces> [I<ifname> ...]
 
 option is set, B<Address> and B<Port> options are ignored.
 
 =item B<Interfaces> [I<ifname> ...]
 

-List of interface names to be monitored by this plugin. If this option is missed
-or it's empty then all OVS connected interfaces on all bridges are monitored.
+List of interface names to be monitored by this plugin. If this option is not
+specified or is empty then all OVS connected interfaces on all bridges are
+monitored.

 
 Default: empty (all interfaces on all bridges are monitored)
 
 
 Default: empty (all interfaces on all bridges are monitored)
 


@@ -8063,6 +8076,17 @@ How many read instances you want to use for this plugin. The default is one,
 and the sensible setting is a multiple of the B<ReadThreads> value.
 If you are not sure, just use the default setting.
 
 and the sensible setting is a multiple of the B<ReadThreads> value.
 If you are not sure, just use the default setting.
 

+=item B<ExtraStats> B<string>
+
+Report additional extra statistics. The default is no extra statistics, preserving
+the previous behaviour of the plugin. If unsure, leave the default. If enabled,
+allows the plugin to reported more detailed statistics about the behaviour of
+Virtual Machines. The argument is a space-separated list of selectors.
+Currently supported selectors are:
+B<disk> report extra statistics like number of flush operations and total
+service time for read, write and flush operations.
+B<pcpu> report the physical user/system cpu time consumed by the hypervisor, per-vm.
+

 =back
 
 =head2 Plugin C<vmem>
 =back
 
 =head2 Plugin C<vmem>