collectd.conf(5): Add documentation for the "netcmd" plugin.
[collectd.git] / src / collectd.conf.pod
index a7a5816..e8e1f3e 100644 (file)
@@ -802,12 +802,22 @@ B<apcupsd> can handle it.
 
 TCP-Port to connect to. Defaults to B<3551>.
 
-=item B<ReportSeconds> B<true|false>
+=item B<ReportSeconds> B<true>|B<false>
 
 If set to B<true>, the time reported in the C<timeleft> metric will be
 converted to seconds. This is the recommended setting. If set to B<false>, the
 default for backwards compatibility, the time will be reported in minutes.
 
+=item B<PersistentConnection> B<true>|B<false>
+
+By default, the plugin will try to keep the connection to UPS open between
+reads. Since this appears to be somewhat brittle (I<apcupsd> appears to close
+the connection due to inactivity quite quickly), the plugin will try to detect
+this problem and switch to an open-read-close mode in such cases.
+
+You can instruct the plugin to close the connection after each read by setting
+this option to B<false>.
+
 =back
 
 =head2 Plugin C<aquaero>
@@ -2264,6 +2274,27 @@ expected from them. This is documented in great detail in L<collectd-exec(5)>.
 
 =back
 
+=head2 Plugin C<fhcount>
+
+The C<fhcount> plugin provides statistics about used, unused and total number of
+file handles.
+
+The I<fhcount plugin> provides the following configuration options:
+
+=over 4
+
+=item B<ValuesAbsolute> B<true>|B<false>
+
+Enables or disables reporting of file handles usage in absolute numbers,
+e.g. file handles used. Defaults to B<true>.
+
+=item B<ValuesPercentage> B<false>|B<true>
+
+Enables or disables reporting of file handles usage in percentages, e.g.
+percent of file handles used. Defaults to B<false>.
+
+=back
+
 =head2 Plugin C<filecount>
 
 The C<filecount> plugin counts the number of files in a certain directory (and
@@ -3848,6 +3879,69 @@ Collect SnapVault(R) statistics every I<Seconds> seconds.
 
 =back
 
+=head2 Plugin C<netcmd>
+
+The C<netcmd> plugin provides a management interface for I<collectd> much like
+the C<unixsock> plugin. Please see L<collectd-unixsock(5)> for a description of
+the commands understood on the socket. Optionally, network traffic is encrypted
+and authenticated using I<Transport Layer Security> (TLS).
+
+The configuration of the C<netcmd> plugin consists of one or more B<Listen>
+block, each defining a socket to bind to and listen on. Example:
+
+  <Plugin netcmd>
+    <Listen>
+      Address "::1"
+      Port "25826"
+      TLSCertFile "/path/to/cert"
+      TLSKeyFile  "/path/to/key"
+      TLSCAFile   "/path/to/ca"
+      TLSCRLFile  "/path/to/crl"
+      TLSVerifyPeer true
+    </Listen>
+  </Plugin>
+
+Valid options inside a B<Listen> block are:
+
+=over 4
+
+=item B<Address> I<Address>|I<Hostname>
+
+Address or hostname to bind to. If not specified, bind to the I<any> address.
+
+=item B<Port> I<Port>|I<Service>
+
+Port number or service name to bind to. Defaults to C<"25826">. Please note
+that even numeric ports must be specified as a string.
+
+=item B<TLSCertFile> I<Path>
+
+Path to the TLS certificate file.
+
+=item B<TLSKeyFile> I<Path>
+
+Path to the TLS key file.
+
+=item B<TLSCAFile> I<Path>
+
+Path to the TLS I<Certificate Authority> (CA) file.
+
+=item B<TLSCRLFile> I<Path>
+
+Path to the TLS I<Certificate Revokation List> (CRL) file.
+
+=item B<TLSVerifyPeer> B<true>|B<false>
+
+Controlls whether or not to verify the client certificate of connecting peers.
+The plugin will I<request> a client certificate either way, but it will only
+I<require> a valid certificate when this option is set to B<true>. Defaults to
+B<false>.
+
+If set to B<true>, the options B<TLSCertFile>, B<TLSKeyFile> and B<TLSCAFile>
+are I<required>.
+
+=back
+
 =head2 Plugin C<netlink>
 
 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
@@ -5401,6 +5495,10 @@ dispatched to the daemon using the specified I<name> as an identifier. This
 allows to "group" several processes together. I<name> must not contain
 slashes.
 
+=item B<CollectContextSwitch> I<Boolean>
+
+Collect context switch of the process.
+
 =back
 
 =head2 Plugin C<protocols>
@@ -6587,6 +6685,79 @@ Default: B<1978>
 
 =back
 
+=head2 Plugin C<turbostat>
+
+The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
+Intel processors by using the new Model Specific Registers.
+
+=over 4
+
+=item B<CoreCstates> I<Bitmask(Integer)>
+
+Bitmask of the list of core C states supported by the processor.
+This option should only be used if the automated detection fails.
+Default value extracted from the cpu model and family.
+
+Currently supported C-states (by this plugin): 3, 6, 7
+
+Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
+
+=item B<PackageCstates> I<Bitmask(Integer)>
+
+Bitmask of the list of pacages C states supported by the processor.
+This option should only be used if the automated detection fails.
+Default value extracted from the cpu model and family.
+
+Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
+
+Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
+
+=item B<SystemManagementInterrupt> I<true>|I<false>
+
+Boolean enabling the collection of the I/O System-Management Interrupt
+counter'. This option should only be used if the automated detection
+fails or if you want to disable this feature.
+
+=item B<DigitalTemperatureSensor> I<true>|I<false>
+
+Boolean enabling the collection of the temperature of each core.
+This option should only be used if the automated detectionfails or 
+if you want to disable this feature.
+
+=item B<DigitalTemperatureSensor> I<true>|I<false>
+
+Boolean enabling the collection of the temperature of each package.
+This option should only be used if the automated detectionfails or 
+if you want to disable this feature.
+
+=item B<TCCActivationTemp> I<Temperature>
+
+Thermal Control Circuit Activation Temperature of the installed
+CPU. This temperature is used when collecting the temperature of
+cores or packages. This option should only be used if the automated
+detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
+
+=item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
+
+Bitmask of the list of elements to be thermally monitored. This option
+should only be used if the automated detection fails or if you want to
+disable some collections. The different bits of this bitmask accepted
+by this plugin are:
+
+=over 4
+
+=item 0 ('1'): Package
+
+=item 1 ('2'): DRAM
+
+=item 2 ('4'): Cores
+
+=item 3 ('8'): Embedded graphic device
+
+=back
+
+=back
+
 =head2 Plugin C<unixsock>
 
 =over 4