X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=f2a971f611820bfad40af0f67dca7ffa774ad656;hb=1115921a0d8f73c08fd505344af4266105e1155d;hp=b66c4350305a8a217b2ebbdfbd78aa6341d54302;hpb=e4fcf03ee7504cc679b5463700966519fb85f065;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index b66c4350..f2a971f6 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -1,3 +1,5 @@ +=encoding UTF-8 + =head1 NAME collectd.conf - Configuration for the system statistics collection daemon B @@ -148,15 +150,29 @@ use statements like the following: Include "/etc/collectd.d/*.conf" +Starting with version 5.3, this may also be a block in which further options +affecting the behavior of B may be specified. The following option is +currently allowed: + + + Filter "*.conf" + + +=over 4 + +=item B I + If the C function is available on your system, a shell-like wildcard I may be specified to filter which files to include. This may be used in combination with recursively including a directory to easily be able to arbitrarily mix configuration files and other documents (e.g. README files). -The following statement is similar to the example above but includes all files +The given example is similar to the first example above but includes all files matching C<*.conf> in any subdirectory of C: Include "/etc/collectd.d" "*.conf" +=back + If more than one files are included by a single B option, the files will be included in lexicographical order (as defined by the C function). Thus, you can e.Eg. use numbered prefixes to specify the @@ -219,6 +235,23 @@ Number of threads to start for dispatching value lists to write plugins. The default value is B<5>, but you may want to increase this if you have more than five plugins that may take relatively long to write to. +=item B I +=item B I + +Default value for high limit is 0 (no limit). +Default value for low limit is 50% of high limit. + +When the write queue size becomes bigger than the high limit, values I be dropped. +When the write queue size is between low and high, values I be dropped (depending +on the queue size) + +If high limit is set to 0, there is no limit. This is the default. +If high limit is set, but not low limit, low will be computed as 50% of high. + +If you do not want to randomly drop values when the queue size is between low +and high value, set the same value for low and high. When low=high and when the +queue size is bigger, values are just dropped until the queue size becomes smaller. + =item B I Sets the hostname that identifies a host. If you omit this setting, the @@ -1511,14 +1544,19 @@ Enable this option if inodes are a scarce resource for you, usually because many small files are stored on the disk. This is a usual scenario for mail transfer agents and web caches. -=item B B|B +=item B B|B -Enables or disables reporting of disk space and inodes as a percentage. -Defaults to B. +Enables or disables reporting of free, used and used disk space in 1K-blocks. +Defaults to true. + +=item B B|B -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. +Enables or disables reporting of free, used and used disk space in percentage. +Defaults to 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. =back @@ -5696,7 +5734,33 @@ Take the UUID from the given file (default I). =head2 Plugin C -The Varnish plugin collects information about Varnish, an HTTP accelerator. +The I collects information about Varnish, an HTTP accelerator. + +Synopsis: + + + + CollectCache true + CollectConnections true + CollectBackend true + CollectSHM true + CollectESI false + CollectFetch false + CollectHCB false + CollectSMA false + CollectSMS false + CollectSM false + CollectTotals false + CollectWorkers false + + + +The configuration consists of one or more EBEIE +blocks. I is the parameter passed to "varnishd -n". If left empty, it +will collectd statistics from the default "varnishd" instance (this should work +fine in most cases). + +Inside each EBE blocks, the following options are recognized: =over 4 @@ -5837,9 +5901,9 @@ iptables to feed data for the guest IPs into the iptables plugin. The C plugin writes data to I, an open-source metrics storage and graphing project. The plugin connects to I, the data layer -of I, and sends data via the "line based" protocol (per default using -portE2003). The data will be sent in blocks of at most 1428 bytes to -minimize the number of network packets. +of I, via I or I and sends data via the "line based" +protocol (per default using portE2003). The data will be sent in blocks +of at most 1428 bytes to minimize the number of network packets. Synopsis: @@ -5847,6 +5911,8 @@ Synopsis: Host "localhost" Port "2003" + Protocol "udp" + LogSendErrors true Prefix "collectd" @@ -5864,6 +5930,17 @@ Hostname or address to connect to. Defaults to C. Service name or port number to connect to. Defaults to C<2003>. +=item B I + +Protocol to use when connecting to I. Defaults to C. + +=item B B|B + +If set to B (the default), logs errors when sending data to I. +If set to B, it will not log the errors. This is especially useful when +using Protocol UDP since many times we want to use the "fire-and-forget" +approach and logging errors fills syslog with unneeded messages. + =item B I When set, I is added in front of the host name. Dots and whitespace are @@ -6034,7 +6111,7 @@ Synopsis: Protocol UDP StoreRates true AlwaysAppendDS false - Delay 10 + TTLFactor 2.0 Tag "foobar" @@ -6081,6 +6158,15 @@ If set the B, append the name of the I (DS) to the identifies a metric in I. If set to B (the default), this is only done when there is more than one DS. +=item B I + +I events have a I