Merge remote-tracking branch 'github/pr/2439'
authorFlorian Forster <octo@collectd.org>
Sat, 23 Sep 2017 20:14:18 +0000 (22:14 +0200)
committerFlorian Forster <octo@collectd.org>
Sat, 23 Sep 2017 20:14:18 +0000 (22:14 +0200)
1  2 
src/collectd.conf.in
src/collectd.conf.pod

diff --combined src/collectd.conf.in
  #  ReportByCpu true
  #  ReportByState true
  #  ValuesPercentage false
+ #  ReportNumCpu false
+ #  ReportGuestState false
+ #  SubtractGuestState true
  #</Plugin>
  #
  #<Plugin csv>
  #             QoS 2
  #             Topic "collectd/#"
  #             CleanSession true
 +#             CACert "/etc/ssl/ca.crt"
 +#             CertificateFile "/etc/ssl/client.crt"
 +#             CertificateKeyFile "/etc/ssl/client.pem"
 +#             TLSProtocol "tlsv1.2"
 +#             CipherSuite "ciphers"
  #     </Subscribe>
  #</Plugin>
  
  #     ReportBytes true
  #     ValuesAbsolute true
  #     ValuesPercentage false
 +#     ReportIO true
  #</Plugin>
  
  #<Plugin table>
  #     <Table "/proc/slabinfo">
 +#             #Plugin "table"
  #             Instance "slabinfo"
  #             Separator " "
  #             <Result>
  #     SystemManagementInterrupt true
  #     DigitalTemperatureSensor true
  #     PackageThermalManagement true
 -#     RunningAveragePowerLimit "7"    
 +#     RunningAveragePowerLimit "7"
  #</Plugin>
  
  #<Plugin unixsock>
diff --combined src/collectd.conf.pod
@@@ -1474,6 -1474,19 +1474,19 @@@ in the un-aggregated (per-CPU, per-stat
  When set to B<true>, reports the number of available CPUs.
  Defaults to B<false>.
  
+ =item B<ReportGuestState> B<false>|B<true>
+ When set to B<true>, reports the "guest" and "guest_nice" CPU states.
+ Defaults to B<false>.
+ =item B<SubtractGuestState> B<false>|B<true>
+ This option is only considered when B<ReportGuestState> is set to B<true>.
+ "guest" and "guest_nice" are included in respectively "user" and "nice".
+ If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
+ will be subtracted from "nice".
+ Defaults to B<true>.
  =back
  
  =head2 Plugin C<cpufreq>
@@@ -4173,18 -4186,18 +4186,18 @@@ the B<collectd> branch
  Path to the PEM-encoded CA certificate file. Setting this option enables TLS
  communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
  port of the MQTT broker.
 -A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
 +This option enables the use of TLS.
  
  =item B<CertificateFile> I<file>
  
  Path to the PEM-encoded certificate file to use as client certificate when
  connecting to the MQTT broker.
 -A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
 +Only valid if B<CACert> and B<CertificateKeyFile> are also set.
  
  =item B<CertificateKeyFile> I<file>
  
  Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
 -A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
 +Only valid if B<CACert> and B<CertificateFile> are also set.
  
  =item B<TLSProtocol> I<protocol>
  
@@@ -4192,14 -4205,13 +4205,14 @@@ If configured, this specifies the strin
  C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
  version is used which depends on the version of OpenSSL the Mosquitto library
  was linked against.
 +Only valid if B<CACert> is set.
  
  =item B<CipherSuite> I<ciphersuite>
  
  A string describing the ciphers available for use. See L<ciphers(1)> and the
  C<openssl ciphers> utility for more information. If unset, the default ciphers
  will be used.
 -
 +Only valid if B<CACert> is set.
  
  =back
  
@@@ -4329,11 -4341,11 +4342,11 @@@ If enabled, the plugin sends a notifica
  or SQL threads are not running. Defaults to B<false>.
  
  =item B<WsrepStats> I<true|false>
 - 
 +
   Enable the collection of wsrep plugin statistics, used in Master-Master
   replication setups like in MySQL Galera/Percona XtraDB Cluster.
   User needs only privileges to execute 'SHOW GLOBAL STATUS'
 - 
 +
  =item B<ConnectTimeout> I<Seconds>
  
  Sets the connect timeout for the MySQL client.
@@@ -5174,7 -5186,7 +5187,7 @@@ System (NFS). It counts the number of p
  grouped by version and whether the system runs as server or client.
  
  It is possibly to omit metrics for a specific NFS version by setting one or
 -more of the following options to B<false> (all of them default to B<true>). 
 +more of the following options to B<false> (all of them default to B<true>).
  
  =over 4
  
@@@ -5656,12 -5668,15 +5669,12 @@@ The OpenVPN plugin reads a status file 
  traffic statistics about connected clients.
  
  To set up OpenVPN to write to the status file periodically, use the
 -B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
 -you need to set the required format, too. This is done by setting
 -B<--status-version> to B<2>.
 +B<--status> option of OpenVPN.
  
  So, in a nutshell you need:
  
    openvpn $OTHER_OPTIONS \
 -    --status "/var/run/openvpn-status" 10 \
 -    --status-version 2
 +    --status "/var/run/openvpn-status" 10
  
  Available options:
  
@@@ -7525,13 -7540,6 +7538,13 @@@ available and free. Defaults to B<false
  This is useful for deploying I<collectd> in a heterogeneous environment, where
  swap sizes differ and you want to specify generic thresholds or similar.
  
 +=item B<ReportIO> B<true>|B<false>
 +
 +Enables or disables reporting swap IO. Defaults to B<true>.
 +
 +This is useful for the cases when swap IO is not neccessary, is not available,
 +or is not reliable.
 +
  =back
  
  =head2 Plugin C<syslog>
@@@ -7567,7 -7575,6 +7580,7 @@@ filesystem or CSV (comma separated valu
  
    <Plugin table>
      <Table "/proc/slabinfo">
 +      #Plugin "slab"
        Instance "slabinfo"
        Separator " "
        <Result>
@@@ -7594,14 -7601,10 +7607,14 @@@ The following options are available ins
  
  =over 4
  
 +=item B<Plugin> I<Plugin>
 +
 +If specified, I<Plugin> is used as the plugin name when submitting values.
 +Defaults to B<table>.
 +
  =item B<Instance> I<instance>
  
 -If specified, I<instance> is used as the plugin instance. So, in the above
 -example, the plugin name C<table-slabinfo> would be used. If omitted, the
 +If specified, I<instance> is used as the plugin instance. If omitted, the
  filename of the table is used instead, with all special characters replaced
  with an underscore (C<_>).
  
@@@ -8490,7 -8493,7 +8503,7 @@@ will be collected
  =item B<BlockDeviceFormat> B<target>|B<source>
  
  If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
 -seen by the guest will be used for reporting metrics. 
 +seen by the guest will be used for reporting metrics.
  This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
  domain.