Merge branch 'udev-disk'

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 83ca201..6df6fae 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -9,14 +9,14 @@ collectd.conf - Configuration for the system statistics collection daemon B<coll
   BaseDir "/path/to/data/"
   PIDFile "/path/to/pidfile/collectd.pid"
   Server  "123.123.123.123" 12345
   BaseDir "/path/to/data/"
   PIDFile "/path/to/pidfile/collectd.pid"
   Server  "123.123.123.123" 12345

-  
+

   LoadPlugin cpu
   LoadPlugin load
   LoadPlugin cpu
   LoadPlugin load

-  
+

   <LoadPlugin df>
     Interval 3600
   </LoadPlugin>
   <LoadPlugin df>
     Interval 3600
   </LoadPlugin>

-  
+

   LoadPlugin ping
   <Plugin ping>
     Host "example.org"
   LoadPlugin ping
   <Plugin ping>
     Host "example.org"


@@ -341,10 +341,10 @@ The full example configuration looks like this:
    <Aggregation>
      Plugin "cpu"
      Type "cpu"
    <Aggregation>
      Plugin "cpu"
      Type "cpu"

-     
+

      GroupBy "Host"
      GroupBy "TypeInstance"
      GroupBy "Host"
      GroupBy "TypeInstance"

-     
+

      CalculateSum true
      CalculateAverage true
    </Aggregation>
      CalculateSum true
      CalculateAverage true
    </Aggregation>


@@ -420,13 +420,13 @@ The following example calculates the average usage of all "even" CPUs:
      Plugin "cpu"
      PluginInstance "/[0,2,4,6,8]$/"
      Type "cpu"
      Plugin "cpu"
      PluginInstance "/[0,2,4,6,8]$/"
      Type "cpu"

-     
+

      SetPlugin "cpu"
      SetPluginInstance "even-%{aggregation}"
      SetPlugin "cpu"
      SetPluginInstance "even-%{aggregation}"

-     
+

      GroupBy "Host"
      GroupBy "TypeInstance"
      GroupBy "Host"
      GroupBy "TypeInstance"

-     
+

      CalculateAverage true
    </Aggregation>
  </Plugin>
      CalculateAverage true
    </Aggregation>
  </Plugin>


@@ -495,7 +495,7 @@ possibly filtering or messages.
  #   GraphitePrefix "collectd."
  #   GraphiteEscapeChar "_"
    </Publish>
  #   GraphitePrefix "collectd."
  #   GraphiteEscapeChar "_"
    </Publish>

-   
+

    # Receive values from an AMQP broker
    <Subscribe "some_name">
      Host "localhost"
    # Receive values from an AMQP broker
    <Subscribe "some_name">
      Host "localhost"


@@ -822,17 +822,17 @@ Synopsis:
    ParseTime       false
    OpCodes         true
    QTypes          true
    ParseTime       false
    OpCodes         true
    QTypes          true

- 
+

    ServerStats     true
    ZoneMaintStats  true
    ResolverStats   false
    MemoryStats     true
    ServerStats     true
    ZoneMaintStats  true
    ResolverStats   false
    MemoryStats     true

- 
+

    <View "_default">
      QTypes        true
      ResolverStats true
      CacheRRSets   true
    <View "_default">
      QTypes        true
      ResolverStats true
      CacheRRSets   true

- 
+

      Zone "127.in-addr.arpa/IN"
    </View>
  </Plugin>
      Zone "127.in-addr.arpa/IN"
    </View>
  </Plugin>


@@ -973,6 +973,31 @@ at all, B<all> cgroups are selected.
 
 =back
 
 
 =back
 

+=head2 Plugin C<cpu>
+
+The I<CPU plugin> collects CPU usage metrics.
+
+The following configuration options are available:
+
+=over 4
+
+=item B<ReportActive> B<false>|B<true>
+
+Reports non-idle CPU usage as the "active" value. Defaults to false.
+
+=item B<ReportByCpu> B<false>|B<true>
+
+When true reports usage for all cores. When false, reports cpu usage
+aggregated over all cores. Implies ValuesPercentage when false.
+Defaults to true.
+
+=item B<ValuesPercentage> B<false>|B<true>
+
+When true report percentage usage instead of tick values. Defaults to false.
+
+=back
+
+

 =head2 Plugin C<cpufreq>
 
 This plugin doesn't have any options. It reads
 =head2 Plugin C<cpufreq>
 
 This plugin doesn't have any options. It reads


@@ -1046,6 +1071,10 @@ Username to use if authorization is required to read the page.
 
 Password to use if authorization is required to read the page.
 
 
 Password to use if authorization is required to read the page.
 

+=item B<Digest> B<true>|B<false>
+
+Enable HTTP digest authentication.
+

 =item B<VerifyPeer> B<true>|B<false>
 
 Enable or disable peer SSL certificate verification. See
 =item B<VerifyPeer> B<true>|B<false>
 
 Enable or disable peer SSL certificate verification. See


@@ -1157,11 +1186,19 @@ The following options are valid within B<URL> blocks:
 Sets the plugin instance to I<Instance>.
 
 =item B<User> I<Name>
 Sets the plugin instance to I<Instance>.
 
 =item B<User> I<Name>

+

 =item B<Password> I<Password>
 =item B<Password> I<Password>

+
+=item B<Digest> B<true>|B<false>
+

 =item B<VerifyPeer> B<true>|B<false>
 =item B<VerifyPeer> B<true>|B<false>

+

 =item B<VerifyHost> B<true>|B<false>
 =item B<VerifyHost> B<true>|B<false>

+

 =item B<CACert> I<file>
 =item B<CACert> I<file>

+

 =item B<Header> I<Header>
 =item B<Header> I<Header>

+

 =item B<Post> I<Body>
 
 These options behave exactly equivalent to the appropriate options of the
 =item B<Post> I<Body>
 
 These options behave exactly equivalent to the appropriate options of the


@@ -1250,6 +1287,8 @@ Examples:
 
 =item B<Password> I<Password>
 
 
 =item B<Password> I<Password>
 

+=item B<Digest> B<true>|B<false>
+

 =item B<VerifyPeer> B<true>|B<false>
 
 =item B<VerifyHost> B<true>|B<false>
 =item B<VerifyPeer> B<true>|B<false>
 
 =item B<VerifyHost> B<true>|B<false>


@@ -1603,17 +1642,17 @@ transfer agents and web caches.
 
 =item B<ValuesAbsolute> B<true>|B<false>
 
 
 =item B<ValuesAbsolute> B<true>|B<false>
 

-Enables or disables reporting of free, used and used disk space in 1K-blocks. 
-Defaults to true.
+Enables or disables reporting of free and used disk space in 1K-blocks.
+Defaults to B<true>.

 
 

-=item B<ValuesPercentage> B<true>|B<false>
+=item B<ValuesPercentage> B<false>|B<true>

 
 

-Enables or disables reporting of free, used and used disk space in percentage.
-Defaults to false.
+Enables or disables reporting of free and used disk space in percentage.
+Defaults to B<false>.

 
 

-This is useful for deploying collectd on the cloud, where machines with
-different disk size may exist. Then it is more practical to configure thresholds
-based on relative disk size.
+This is useful for deploying I<collectd> on the cloud, where machines with
+different disk size may exist. Then it is more practical to configure
+thresholds based on relative disk size.

 
 =back
 
 
 =back
 


@@ -2213,6 +2252,25 @@ interface path might change between reboots of a guest or across migrations.
 
 =back
 
 
 =back
 

++=head2 Plugin C<load>
+
+The I<Load plugin> collects the system load. These numbers give a rough overview
+over the utilization of a machine. The system load is defined as the number of
+runnable tasks in the run-queue and is provided by many operating systems as a
+one, five or fifteen minute average.
+
+The following configuration options are available:
+
+=over 4
+
+=item B<ReportRelative> B<false>|B<true>
+
+When enabled, system load divided by number of available CPU cores is reported
+for intervals 1 min, 5 min and 15 min. Defaults to false.
+
+=back
+
+

 =head2 Plugin C<logfile>
 
 =over 4
 =head2 Plugin C<logfile>
 
 =over 4


@@ -2420,7 +2478,7 @@ B<Synopsis:>
    ShowCPU true
    ShowCPUCores true
    ShowMemory true
    ShowCPU true
    ShowCPUCores true
    ShowMemory true

-   
+

    ShowTemperatures true
    Temperature vddg
    Temperature vddq
    ShowTemperatures true
    Temperature vddg
    Temperature vddq


@@ -2429,7 +2487,7 @@ B<Synopsis:>
    ShowPower true
    Power total0
    Power total1
    ShowPower true
    Power total0
    Power total1

-   IgnoreSelectedPower true   
+   IgnoreSelectedPower true

  </Plugin>
 
 The following options are valid inside the B<PluginE<nbsp>mic> block:
  </Plugin>
 
 The following options are valid inside the B<PluginE<nbsp>mic> block:


@@ -2486,7 +2544,7 @@ Fan In
 
 =item fout
 
 
 =item fout
 

-Fan Out 
+Fan Out

 
 =item vccp
 
 
 =item vccp
 


@@ -2527,11 +2585,11 @@ Known power names are:
 
 =item total0
 
 
 =item total0
 

-Total power utilization averaged over Time Window 0 (uWatts). 
+Total power utilization averaged over Time Window 0 (uWatts).

 
 =item total1
 
 
 =item total1
 

-Total power utilization averaged over Time Window 0 (uWatts). 
+Total power utilization averaged over Time Window 0 (uWatts).

 
 =item inst
 
 
 =item inst
 


@@ -2539,34 +2597,55 @@ Instantaneous power (uWatts).
 
 =item imax
 
 
 =item imax
 

-Max instantaneous power (uWatts). 
+Max instantaneous power (uWatts).

 
 =item pcie
 
 
 =item pcie
 

-PCI-E connector power (uWatts). 
+PCI-E connector power (uWatts).

 
 =item c2x3
 
 
 =item c2x3
 

-2x3 connector power (uWatts). 
+2x3 connector power (uWatts).

 
 =item c2x4
 
 
 =item c2x4
 

-2x4 connector power (uWatts). 
+2x4 connector power (uWatts).

 
 =item vccp
 
 
 =item vccp
 

-Core rail (uVolts). 
+Core rail (uVolts).

 
 =item vddg
 
 
 =item vddg
 

-Uncore rail (uVolts). 
+Uncore rail (uVolts).

 
 =item vddq
 
 
 =item vddq
 

-Memory subsystem rail (uVolts). 
+Memory subsystem rail (uVolts).
+
+=back

 
 =back
 
 
 =back
 

+=head2 Plugin C<memory>
+
+The I<memory plugin> provides the following configuration options:
+
+=over 4
+
+=item B<ValuesAbsolute> B<true>|B<false>
+
+Enables or disables reporting of physical memory usage in absolute numbers,
+i.e. bytes. Defaults to B<true>.
+
+=item B<ValuesPercentage> B<false>|B<true>
+
+Enables or disables reporting of physical memory usage in percentages, e.g.
+percent of physical memory used. Defaults to B<false>.
+
+This is useful for deploying I<collectd> in a heterogeneous environment in
+which the sizes of physical memory vary.
+

 =back
 
 =head2 Plugin C<modbus>
 =back
 
 =head2 Plugin C<modbus>


@@ -2584,19 +2663,19 @@ B<Synopsis:>
    Type voltage
    Instance "input-1"
  </Data>
    Type voltage
    Instance "input-1"
  </Data>

- 
+

  <Data "voltage-input-2">
    RegisterBase 2
    RegisterType float
    Type voltage
    Instance "input-2"
  </Data>
  <Data "voltage-input-2">
    RegisterBase 2
    RegisterType float
    Type voltage
    Instance "input-2"
  </Data>

- 
+

  <Host "modbus.example.com">
    Address "192.168.0.42"
    Port    "502"
    Interval 60
  <Host "modbus.example.com">
    Address "192.168.0.42"
    Port    "502"
    Interval 60

-   
+

    <Slave 1>
      Instance "power-supply"
      Collect  "voltage-input-1"
    <Slave 1>
      Instance "power-supply"
      Collect  "voltage-input-1"


@@ -2829,7 +2908,7 @@ Required capabilities are documented below.
     User          "username"
     Password      "aef4Aebe"
     Interval      30
     User          "username"
     Password      "aef4Aebe"
     Interval      30

-    
+

     <WAFL>
       Interval 30
       GetNameCache   true
     <WAFL>
       Interval 30
       GetNameCache   true


@@ -2837,12 +2916,12 @@ Required capabilities are documented below.
       GetBufferCache true
       GetInodeCache  true
     </WAFL>
       GetBufferCache true
       GetInodeCache  true
     </WAFL>

-    
+

     <Disks>
       Interval 30
       GetBusy true
     </Disks>
     <Disks>
       Interval 30
       GetBusy true
     </Disks>

-    
+

     <VolumePerf>
       Interval 30
       GetIO      "volume0"
     <VolumePerf>
       Interval 30
       GetIO      "volume0"


@@ -2852,7 +2931,7 @@ Required capabilities are documented below.
       GetLatency "volume0"
       IgnoreSelectedLatency false
     </VolumePerf>
       GetLatency "volume0"
       IgnoreSelectedLatency false
     </VolumePerf>

-    
+

     <VolumeUsage>
       Interval 30
       GetCapacity "vol0"
     <VolumeUsage>
       Interval 30
       GetCapacity "vol0"


@@ -2862,15 +2941,15 @@ Required capabilities are documented below.
       GetSnapshot "vol3"
       IgnoreSelectedSnapshot false
     </VolumeUsage>
       GetSnapshot "vol3"
       IgnoreSelectedSnapshot false
     </VolumeUsage>

-    
+

     <Quota>
       Interval 60
     </Quota>
     <Quota>
       Interval 60
     </Quota>

-    
+

     <Snapvault>
       Interval 30
     </Snapvault>
     <Snapvault>
       Interval 30
     </Snapvault>

-    
+

     <System>
       Interval 30
       GetCPULoad     true
     <System>
       Interval 30
       GetCPULoad     true


@@ -3431,7 +3510,7 @@ signature):
    # Export to an internal server
    # (demonstrates usage without additional options)
    Server "collectd.internal.tld"
    # Export to an internal server
    # (demonstrates usage without additional options)
    Server "collectd.internal.tld"

-   
+

    # Export to an external server
    # (demonstrates usage with signature options)
    <Server "collectd.external.tld">
    # Export to an external server
    # (demonstrates usage with signature options)
    <Server "collectd.external.tld">


@@ -5351,6 +5430,19 @@ This option is only available if the I<Swap plugin> can read C</proc/swaps>
 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
 I<swap I/O> is reported in pages. This option is available under Linux only.
 
 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
 I<swap I/O> is reported in pages. This option is available under Linux only.
 

+=item B<ValuesAbsolute> B<true>|B<false>
+
+Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
+available and used. Defaults to B<true>.
+
+=item B<ValuesPercentage> B<false>|B<true>
+
+Enables or disables reporting of relative swap metrics, i.e. I<percent>
+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.
+

 =back
 
 =head2 Plugin C<syslog>
 =back
 
 =head2 Plugin C<syslog>


@@ -5486,6 +5578,7 @@ user using (extended) regular expressions, as described in L<regex(7)>.
   <Plugin "tail">
     <File "/var/log/exim4/mainlog">
       Instance "exim"
   <Plugin "tail">
     <File "/var/log/exim4/mainlog">
       Instance "exim"

+      Interval 60

       <Match>
         Regex "S=([1-9][0-9]*)"
         DSType "CounterAdd"
       <Match>
         Regex "S=([1-9][0-9]*)"
         DSType "CounterAdd"


@@ -5512,6 +5605,9 @@ This plugin instance is for all B<Match> blocks that B<follow> it, until the
 next B<Instance> option. This way you can extract several plugin instances from
 one logfile, handy when parsing syslog and the like.
 
 next B<Instance> option. This way you can extract several plugin instances from
 one logfile, handy when parsing syslog and the like.
 

+The B<Interval> option allows you to define the length of time between reads. If
+this is not set, the default Interval will be used.
+

 Each B<Match> block has the following options to describe how the match should
 be performed:
 
 Each B<Match> block has the following options to describe how the match should
 be performed:
 


@@ -6302,6 +6398,7 @@ Synopsis:
      TTLFactor 2.0
    </Node>
    Tag "foobar"
      TTLFactor 2.0
    </Node>
    Tag "foobar"

+   Attribute "foo" "bar"

  </Plugin>
 
 The following options are understood by the I<write_riemann plugin>:
  </Plugin>
 
 The following options are understood by the I<write_riemann plugin>:


@@ -6362,6 +6459,11 @@ default value.
 Add the given string as an additional tag to the metric being sent to
 I<Riemann>.
 
 Add the given string as an additional tag to the metric being sent to
 I<Riemann>.
 

+=item B<Attribute> I<String> I<String>
+
+Consider the two given strings to be the key and value of an additional
+attribute for each metric being sent out to I<Riemann>.
+

 =back
 
 =head1 THRESHOLD CONFIGURATION
 =back
 
 =head1 THRESHOLD CONFIGURATION


@@ -7016,7 +7118,7 @@ Example:
    Max 100
    Satisfy "All"
  </Match>
    Max 100
    Satisfy "All"
  </Match>

- 
+

  # Match if the value of any data source is outside the range of 0 - 100.
  <Match "value">
    Min   0
  # Match if the value of any data source is outside the range of 0 - 100.
  <Match "value">
    Min   0


@@ -7198,7 +7300,7 @@ Example:
  <Target "replace">
    # Replace "example.net" with "example.com"
    Host "\\<example.net\\>" "example.com"
  <Target "replace">
    # Replace "example.net" with "example.com"
    Host "\\<example.net\\>" "example.com"

- 
+

    # Strip "www." from hostnames
    Host "\\<www\\." ""
  </Target>
    # Strip "www." from hostnames
    Host "\\<www\\." ""
  </Target>