X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=1b73c417d9ebfc54211eefc252116d733a0b9c96;hb=HEAD;hp=6ef2822ec68669d61cb4cebe05d4ae45e4deb975;hpb=d56026568932858d8eb3ad6e8588086eac0dbf5e;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 6ef2822e..1b73c417 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,36 @@ 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 + +Metrics are read by the I and then put into a queue to be handled +by the I. If one of the I is slow (e.g. network +timeouts, I/O saturation of the disk) this queue will grow. In order to avoid +running into memory issues in such a case, you can limit the size of this +queue. + +By default, there is no limit and memory may grow indefinitely. This is most +likely not an issue for clients, i.e. instances that only handle the local +metrics. For servers it is recommended to set this to a non-zero value, though. + +You can set the limits using B and B. +Each of them takes a numerical argument which is the number of metrics in the +queue. If there are I metrics in the queue, any new metrics I be +dropped. If there are less than I metrics in the queue, all new metrics +I be enqueued. If the number of metrics currently in the queue is between +I and I, the metric is dropped with a probability that is +proportional to the number of metrics in the queue (i.e. it increases linearly +until it reaches 100%.) + +If B is set to non-zero and B is +unset, the latter will default to half of B. + +If you do not want to randomly drop values when the queue size is between +I and I, set If B and +B to same value. + =item B I Sets the hostname that identifies a host. If you omit this setting, the @@ -5102,12 +5148,129 @@ and all other sensors are collected. =back +=head2 Plugin C + +The I uses I to retrieve measurements from any device +supported by the L project. + +B + + + LogLevel 3 + + Driver "fluke-dmm" + MinimumInterval 10 + Conn "/dev/ttyUSB2" + + + Driver "cem-dt-885x" + Conn "/dev/ttyUSB1" + + + +=over 4 + +=item B B<0-5> + +The I logging level to pass on to the I log, as a number +between B<0> and B<5> (inclusive). These levels correspond to C, +C, C, C, Cand C, respectively. +The default is B<2> (C). The I log messages, regardless of +their level, are always submitted to I at its INFO log level. + +=item EB IE + +A sigrok-supported device, uniquely identified by this section's options. The +I is passed to I as the I. + +=item B I + +The sigrok driver to use for this device. + +=item B I + +If the device cannot be auto-discovered, or more than one might be discovered +by the driver, I specifies the connection string to the device. +It can be of the form of a device path (e.g.EC), or, in +case of a non-serial USB-connected device, the USB IB<.>I +separated by a period (e.g.EC<0403.6001>). A USB device can also be +specified as IB<.>I
(e.g.EC<1.41>). + +=item B I + +For serial devices with non-standard port settings, this option can be used +to specify them in a form understood by I, e.g.EC<9600/8n1>. +This should not be necessary; drivers know how to communicate with devices they +support. + +=item B I + +Specifies the minimum time between measurement dispatches to I, in +seconds. Since some I supported devices can acquire measurements many +times per second, it may be necessary to throttle these. For example, the +I cannot process writes more than once per second. + +The default B is B<0>, meaning measurements received from the +device are always dispatched to I. When throttled, unused +measurements are discarded. + +=back + =head2 Plugin C Since the configuration of the C is a little more complicated than other plugins, its documentation has been moved to an own manpage, L. Please see there for details. +=head2 Plugin C + +The I listens to a UDP socket, reads "events" in the statsd +protocol and dispatches rates or other aggregates of these numbers +periodically. + +The plugin implements the I, I, I and I types which +are dispatched as the I types C, C, C and +C respectively. + +The following configuration options are valid: + +=over 4 + +=item B I + +Bind to the hostname / address I. By default, the plugin will bind to the +"any" address, i.e. accept packets sent to any of the hosts addresses. + +=item B I + +UDP port to listen to. This can be either a service name or a port number. +Defaults to C<8125>. + +=item B B|B + +=item B B|B + +=item B B|B + +=item B B|B + +These options control what happens if metrics are not updated in an interval. +If set to B, the default, metrics are dispatched unchanged, i.e. the +rate of counters and size of sets will be zero, timers report C and gauges +are unchanged. If set to B, the such metrics are not dispatched and +removed from the internal cache. + +=item B I + +Calculate and dispatch the configured percentile, i.e. compute the latency, so +that I of all reported timers are smaller than or equal to the +computed latency. This is useful for cutting off the long tail latency, as it's +often done in I (SLAs). + +If not specified, no percentile is calculated / dispatched. + +=back + =head2 Plugin C The I collects information about used and available swap space. On @@ -5701,7 +5864,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