X-Git-Url: https://git.octo.it/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcollectd.conf.pod;h=6df6fae999026b19b551d413086bd771c300d6b7;hb=575e601fb46732bc0538ef92ea6ac3b00ef3aafd;hp=83ca201689506aa6242655587d126fa2eb7d12be;hpb=8a9e2bf87d6eccd39e9ec780062f44d3299be36a;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 83ca2016..6df6fae9 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -9,14 +9,14 @@ collectd.conf - Configuration for the system statistics collection daemon B Interval 3600 - + LoadPlugin ping Host "example.org" @@ -341,10 +341,10 @@ The full example configuration looks like this: Plugin "cpu" Type "cpu" - + GroupBy "Host" GroupBy "TypeInstance" - + CalculateSum true CalculateAverage true @@ -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" - + SetPlugin "cpu" SetPluginInstance "even-%{aggregation}" - + GroupBy "Host" GroupBy "TypeInstance" - + CalculateAverage true @@ -495,7 +495,7 @@ possibly filtering or messages. # GraphitePrefix "collectd." # GraphiteEscapeChar "_" - + # Receive values from an AMQP broker Host "localhost" @@ -822,17 +822,17 @@ Synopsis: ParseTime false OpCodes true QTypes true - + ServerStats true ZoneMaintStats true ResolverStats false MemoryStats true - + QTypes true ResolverStats true CacheRRSets true - + Zone "127.in-addr.arpa/IN" @@ -973,6 +973,31 @@ at all, B cgroups are selected. =back +=head2 Plugin C + +The I collects CPU usage metrics. + +The following configuration options are available: + +=over 4 + +=item B B|B + +Reports non-idle CPU usage as the "active" value. Defaults to false. + +=item B B|B + +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 B|B + +When true report percentage usage instead of tick values. Defaults to false. + +=back + + =head2 Plugin C 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. +=item B B|B + +Enable HTTP digest authentication. + =item B B|B Enable or disable peer SSL certificate verification. See @@ -1157,11 +1186,19 @@ The following options are valid within B blocks: Sets the plugin instance to I. =item B I + =item B I + +=item B B|B + =item B B|B + =item B B|B + =item B I + =item B
I
+ =item B I These options behave exactly equivalent to the appropriate options of the @@ -1250,6 +1287,8 @@ Examples: =item B I +=item B B|B + =item B B|B =item B B|B @@ -1603,17 +1642,17 @@ transfer agents and web caches. =item B B|B -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. -=item B B|B +=item B B|B -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. -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 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 @@ -2213,6 +2252,25 @@ interface path might change between reboots of a guest or across migrations. =back ++=head2 Plugin C + +The I 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 B|B + +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 =over 4 @@ -2420,7 +2478,7 @@ B ShowCPU true ShowCPUCores true ShowMemory true - + ShowTemperatures true Temperature vddg Temperature vddq @@ -2429,7 +2487,7 @@ B ShowPower true Power total0 Power total1 - IgnoreSelectedPower true + IgnoreSelectedPower true The following options are valid inside the Bmic> block: @@ -2486,7 +2544,7 @@ Fan In =item fout -Fan Out +Fan Out =item vccp @@ -2527,11 +2585,11 @@ Known power names are: =item total0 -Total power utilization averaged over Time Window 0 (uWatts). +Total power utilization averaged over Time Window 0 (uWatts). =item total1 -Total power utilization averaged over Time Window 0 (uWatts). +Total power utilization averaged over Time Window 0 (uWatts). =item inst @@ -2539,34 +2597,55 @@ Instantaneous power (uWatts). =item imax -Max instantaneous power (uWatts). +Max instantaneous power (uWatts). =item pcie -PCI-E connector power (uWatts). +PCI-E connector power (uWatts). =item c2x3 -2x3 connector power (uWatts). +2x3 connector power (uWatts). =item c2x4 -2x4 connector power (uWatts). +2x4 connector power (uWatts). =item vccp -Core rail (uVolts). +Core rail (uVolts). =item vddg -Uncore rail (uVolts). +Uncore rail (uVolts). =item vddq -Memory subsystem rail (uVolts). +Memory subsystem rail (uVolts). + +=back =back +=head2 Plugin C + +The I provides the following configuration options: + +=over 4 + +=item B B|B + +Enables or disables reporting of physical memory usage in absolute numbers, +i.e. bytes. Defaults to B. + +=item B B|B + +Enables or disables reporting of physical memory usage in percentages, e.g. +percent of physical memory used. Defaults to B. + +This is useful for deploying I in a heterogeneous environment in +which the sizes of physical memory vary. + =back =head2 Plugin C @@ -2584,19 +2663,19 @@ B Type voltage Instance "input-1" - + RegisterBase 2 RegisterType float Type voltage Instance "input-2" - + Address "192.168.0.42" Port "502" Interval 60 - + Instance "power-supply" Collect "voltage-input-1" @@ -2829,7 +2908,7 @@ Required capabilities are documented below. User "username" Password "aef4Aebe" Interval 30 - + Interval 30 GetNameCache true @@ -2837,12 +2916,12 @@ Required capabilities are documented below. GetBufferCache true GetInodeCache true - + Interval 30 GetBusy true - + Interval 30 GetIO "volume0" @@ -2852,7 +2931,7 @@ Required capabilities are documented below. GetLatency "volume0" IgnoreSelectedLatency false - + Interval 30 GetCapacity "vol0" @@ -2862,15 +2941,15 @@ Required capabilities are documented below. GetSnapshot "vol3" IgnoreSelectedSnapshot false - + Interval 60 - + Interval 30 - + 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 external server # (demonstrates usage with signature options) @@ -5351,6 +5430,19 @@ This option is only available if the I can read C When enabled, the I is reported in bytes. When disabled, the default, I is reported in pages. This option is available under Linux only. +=item B B|B + +Enables or disables reporting of absolute swap metrics, i.e. number of I +available and used. Defaults to B. + +=item B B|B + +Enables or disables reporting of relative swap metrics, i.e. I +available and free. Defaults to B. + +This is useful for deploying I in a heterogeneous environment, where +swap sizes differ and you want to specify generic thresholds or similar. + =back =head2 Plugin C @@ -5486,6 +5578,7 @@ user using (extended) regular expressions, as described in L. Instance "exim" + Interval 60 Regex "S=([1-9][0-9]*)" DSType "CounterAdd" @@ -5512,6 +5605,9 @@ This plugin instance is for all B blocks that B it, until the next B option. This way you can extract several plugin instances from one logfile, handy when parsing syslog and the like. +The B option allows you to define the length of time between reads. If +this is not set, the default Interval will be used. + Each B block has the following options to describe how the match should be performed: @@ -6302,6 +6398,7 @@ Synopsis: TTLFactor 2.0 Tag "foobar" + Attribute "foo" "bar" The following options are understood by the I: @@ -6362,6 +6459,11 @@ default value. Add the given string as an additional tag to the metric being sent to I. +=item B I I + +Consider the two given strings to be the key and value of an additional +attribute for each metric being sent out to I. + =back =head1 THRESHOLD CONFIGURATION @@ -7016,7 +7118,7 @@ Example: Max 100 Satisfy "All" - + # Match if the value of any data source is outside the range of 0 - 100. Min 0 @@ -7198,7 +7300,7 @@ Example: # Replace "example.net" with "example.com" Host "\\" "example.com" - + # Strip "www." from hostnames Host "\\