X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=a16f29a1fd83b1982fbaa3791ee03d1a421dbebd;hb=2dd0f9076e04a3d28793f8f45d098ea0a743ab3b;hp=ec527d7a433d1fe7933ff427dc0487bc116948f4;hpb=115ac52ece1897146dfb145d31cb0fdb6b0dbf8f;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index ec527d7a..a16f29a1 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -68,17 +68,33 @@ directory for the daemon. =item B I -Loads the plugin I. There must be at least one such line or B -will be mostly useless. +Loads the plugin I. This is required to load plugins, unless the +B option is enabled (see below). Without any loaded plugins, +I will be mostly useless. -Starting with collectd 4.9, this may also be a block in which further options -affecting the behavior of B may be specified. The following -options are allowed inside a B block: +Only the first B statement or block for a given plugin name has any +effect. This is useful when you want to split up the configuration into smaller +files and want each file to be "self contained", i.e. it contains a B +block I then appropriate B statement. The downside is that if +you have multiple conflicting B blocks, e.g. when they specify +different intervals, only one of them (the first one encountered) will take +effect and all others will be silently ignored. - - Globals true - Interval 10 - +B may either be a simple configuration I or a I +with additional options, affecting the behavior of B. A simple +statement looks like this: + + LoadPlugin "cpu" + +Options inside a B block can override default settings and +influence the way plugins are loaded, e.g.: + + + Globals true + Interval 60 + + +The following options are valid inside B blocks: =over 4 @@ -109,6 +125,19 @@ interval, that setting will take precedence. =back +=item B B|B + +When set to B (the default), each plugin needs to be loaded explicitly, +using the B statement documented above. If a +BPluginE...E> block is encountered and no configuration +handling callback for this plugin has been registered, a warning is logged and +the block is ignored. + +When set to B, explicit B statements are not required. Each +BPluginE...E> block acts as if it was immediately preceded by a +B statement. B statements are still required for +plugins that don't provide any configuration, e.g. the I. + =item B I [I] If I points to a file, includes that file. If I points to a @@ -852,6 +881,29 @@ By default no detailed zone information is collected. =back +=head2 Plugin C + +This plugin collects the CPU user/system time for each I by reading the +F files in the first cpuacct-mountpoint (typically +F on machines using systemd). + +=over 4 + +=item B I + +Select I based on the name. Whether only matching I are +collected or if they are ignored is controlled by the B option; +see below. + +=item B B|B + +Invert the selection: If set to true, all cgroups I the ones that +match any one of the criteria are collected. By default only selected +cgroups are collected if a selection is made. If no selection is configured +at all, B cgroups are selected. + +=back + =head2 Plugin C This plugin doesn't have any options. It reads @@ -944,6 +996,19 @@ File that holds one or more SSL certificates. If you want to use HTTPS you will possibly need this option. What CA certificates come bundled with C and are checked by default depends on the distribution you use. +=item B
I
+ +A HTTP header to add to the request. Multiple headers are added if this option +is specified more than once. + +=item B I + +Specifies that the HTTP operation should be a POST instead of a GET. The +complete data to be posted is given as the argument. This option will usually +need to be accompanied by a B
option to set an appropriate +C for the post body (e.g. to +C). + =item B B|B Measure response time for the request. If this setting is enabled, B @@ -1002,31 +1067,15 @@ The following options are valid within B blocks: Sets the plugin instance to I. =item B I - -Username to use if authorization is required to read the page. - =item B I - -Password to use if authorization is required to read the page. - =item B B|B - -Enable or disable peer SSL certificate verification. See -L for details. Enabled by default. - =item B B|B - -Enable or disable peer host name verification. If enabled, the plugin checks if -the C or a C field of the SSL certificate -matches the host name provided by the B option. If this identity check -fails, the connection is aborted. Obviously, only works when connecting to a -SSL enabled server. Enabled by default. - =item B I +=item B
I
+=item B I -File that holds one or more SSL certificates. If you want to use HTTPS you will -possibly need this option. What CA certificates come bundled with C -and are checked by default depends on the distribution you use. +These options behave exactly equivalent to the appropriate options of the +I plugin. Please see there for a detailed description. =back @@ -1095,14 +1144,34 @@ host name setting. Use I as the plugin instance when submitting values. Defaults to an empty string (no plugin instance). +=item B I I + +If an XPath expression references namespaces, they must be specified +with this option. I is the "namespace prefix" used in the XML document. +I is the "namespace name", an URI reference uniquely identifying the +namespace. The option can be repeated to register multiple namespaces. + +Examples: + + Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/" + Namespace "m" "http://www.w3.org/1998/Math/MathML" + =item B I + =item B I + =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 -I and I plugins. Please see there for a detailed description. +I. Please see there for a detailed description. =item EB IE @@ -1442,6 +1511,15 @@ 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 + +Enables or disables reporting of disk space and inodes as a percentage. +Defaults to 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. + =back =head2 Plugin C @@ -2190,7 +2268,7 @@ interpreted. For a description of match blocks, please see L<"Plugin tail">. =head2 Plugin C -The C connects to a memcached server and queries statistics +The B connects to a memcached server and queries statistics about cache utilization, memory and bandwidth used. L @@ -2222,6 +2300,166 @@ setting is given, the B and B settings are ignored. =back +=head2 Plugin C + +The B gathers CPU statistics, memory usage and temperatures from +Intel's Many Integrated Core (MIC) systems. + +B + + + ShowCPU true + ShowCPUCores true + ShowMemory true + + ShowTemperatures true + Temperature vddg + Temperature vddq + IgnoreSelectedTemperature true + + ShowPower true + Power total0 + Power total1 + IgnoreSelectedPower true + + +The following options are valid inside the Bmic> block: + +=over 4 + +=item B B|B + +If enabled (the default) a sum of the CPU usage accross all cores is reported. + +=item B B|B + +If enabled (the default) per-core CPU usage is reported. + +=item B B|B + +If enabled (the default) the physical memory usage of the MIC system is +reported. + +=item B B|B + +If enabled (the default) various temperatures of the MIC system are reported. + +=item B I + +This option controls which temperatures are being reported. Whether matching +temperatures are being ignored or I matching temperatures are reported +depends on the B setting below. By default I +temperatures are reported. + +=item B B|B + +Controls the behavior of the B setting above. If set to B +(the default) only temperatures matching a B option are reported +or, if no B option is specified, all temperatures are reported. If +set to B, matching temperatures are I and all other temperatures +are reported. + +Known temperature names are: + +=over 4 + +=item die + +Die of the CPU + +=item devmem + +Device Memory + +=item fin + +Fan In + +=item fout + +Fan Out + +=item vccp + +Voltage ccp + +=item vddg + +Voltage ddg + +=item vddq + +Voltage ddq + +=back + +=item B B|B + +If enabled (the default) various temperatures of the MIC system are reported. + +=item B I + +This option controls which power readings are being reported. Whether matching +power readings are being ignored or I matching power readings are reported +depends on the B setting below. By default I +power readings are reported. + +=item B B|B + +Controls the behavior of the B setting above. If set to B +(the default) only power readings matching a B option are reported +or, if no B option is specified, all power readings are reported. If +set to B, matching power readings are I and all other power readings +are reported. + +Known power names are: + +=over 4 + +=item total0 + +Total power utilization averaged over Time Window 0 (uWatts). + +=item total1 + +Total power utilization averaged over Time Window 0 (uWatts). + +=item inst + +Instantaneous power (uWatts). + +=item imax + +Max instantaneous power (uWatts). + +=item pcie + +PCI-E connector power (uWatts). + +=item c2x3 + +2x3 connector power (uWatts). + +=item c2x4 + +2x4 connector power (uWatts). + +=item vccp + +Core rail (uVolts). + +=item vddg + +Uncore rail (uVolts). + +=item vddq + +Memory subsystem rail (uVolts). + +=back + +=back + =head2 Plugin C The B connects to a Modbus "slave" via Modbus/TCP and reads @@ -2229,7 +2467,7 @@ register values. It supports reading single registers (unsigned 16Ebit values), large integer values (unsigned 32Ebit values) and floating point values (two registers interpreted as IEEE floats in big endian notation). -Synopsis: +B RegisterBase 0 @@ -4649,9 +4887,10 @@ expected. Default is B. When enabled, new RRD files are enabled asynchronously, using a separate thread that runs in the background. This prevents writes to block, which is a problem especially when many hundreds of files need to be created at once. However, -this may lead to transient errors reported by code that assumes that the files -are already existing. When disabled (the default) files are created -synchronously, blocking for a short while, while the file is being written. +since the purpose of creating the files asynchronously is I to block until +the file is available, values before the file is available will be discarded. +When disabled (the default) files are created synchronously, blocking for a +short while, while the file is being written. =item B I @@ -4718,9 +4957,10 @@ beneath the daemon's working directory, i.e. the B. When enabled, new RRD files are enabled asynchronously, using a separate thread that runs in the background. This prevents writes to block, which is a problem especially when many hundreds of files need to be created at once. However, -this may lead to transient errors reported by code that assumes that the files -are already existing. When disabled (the default) files are created -synchronously, blocking for a short while, while the file is being written. +since the purpose of creating the files asynchronously is I to block until +the file is available, values before the file is available will be discarded. +When disabled (the default) files are created synchronously, blocking for a +short while, while the file is being written. =item B I @@ -4863,6 +5103,43 @@ 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 and I types which are +dispatched as 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 + +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 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. + +=back + =head2 Plugin C The I collects information about used and available swap space. On @@ -5137,6 +5414,97 @@ This optional setting sets the type instance to use. =back +=head2 Plugin C + +The I reads files in the CSV format, e.g. the statistics file +written by I. + +B + + + + Type "percent" + Instance "dropped" + Index 1 + + + Instance "snort-eth0" + Interval 600 + Collect "snort-dropped" + + + +The configuration consists of one or more B blocks that define an index +into the line of the CSV file and how this value is mapped to I +internal representation. These are followed by one or more B blocks +which configure which file to read, in which interval and which metrics to +extract. + +=over 4 + +=item EB IE + +The B block configures a new metric to be extracted from the statistics +file and how it is mapped on I data model. The string I is +only used inside the B blocks to refer to this block, so you can use +one B block for multiple CSV files. + +=over 4 + +=item B I + +Configures which I to use when dispatching this metric. Types are defined +in the L file, see the appropriate manual page for more +information on specifying types. Only types with a single I are +supported by the I. The information whether the value is an +absolute value (i.e. a C) or a rate (i.e. a C) is taken from the +I definition. + +=item B I + +If set, I is used to populate the type instance field of the +created value lists. Otherwise, no type instance is used. + +=item B I + +Configure to read the value from the field with the zero-based index I. +If the value is parsed as signed integer, unsigned integer or double depends on +the B setting, see above. + +=back + +=item EB IE + +Each B block represents one CSV file to read. There must be at least one +I block but there can be multiple if you have multiple CSV files. + +=over 4 + +=item B I + +Sets the I used when dispatching the values. + +=item B I + +Specifies which I to collect. This option must be specified at least +once, and you can use this option multiple times to specify more than one +metric to be extracted from this statistic file. + +=item B I + +Configures the interval in which to read values from this instance / file. +Defaults to the plugin's default interval. + +=item B I + +Rather than using the local time when dispatching a value, read the timestamp +from the field with the zero-based index I. The value is interpreted as +seconds since epoch. The value is parsed as a double and may be factional. + +=back + +=back + =head2 Plugin C The C connects to the query port of a teamspeak2 server and @@ -5387,6 +5755,17 @@ and closed connections. True by default. Statistics about the shared memory log, a memory region to store log messages which is flushed to disk when full. True by default. +=item B B|B + +Statistics about ban operations, such as number of bans added, retired, and +number of objects tested against ban operations. Only available with Varnish +3.x. False by default. + +=item B B|B + +DNS director lookup cache statistics. Only available with Varnish 3.x. False by +default. + =item B B|B Edge Side Includes (ESI) parse statistics. False by default. @@ -5400,10 +5779,27 @@ Statistics about fetches (HTTP requests sent to the backend). False by default. Inserts and look-ups in the crit bit tree based hash. Look-ups are divided into locked and unlocked look-ups. False by default. +=item B B|B + +Statistics on cached objects: number of objects expired, nuked (prematurely +expired), saved, moved, etc. False by default. + +=item B B|B + +Statistics about purge operations, such as number of purges added, retired, and +number of objects tested against purge operations. Only available with Varnish +2.x. False by default. + +=item B B|B + +Client session statistics. Number of past and current sessions, session herd and +linger counters, etc. False by default. + =item B B|B -malloc or umem (umem_alloc(3MALLOC) based) storage statistics. -The umem storage component is Solaris specific. False by default. +malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage +component is Solaris specific. Only available with Varnish 2.x. False by +default. =item B B|B @@ -5412,13 +5808,28 @@ component is used internally only. False by default. =item B B|B -file (memory mapped file) storage statistics. False by default. +file (memory mapped file) storage statistics. Only available with Varnish 2.x. +False by default. + +=item B B|B + +Current varnish internal state statistics. Number of current sessions, objects +in cache store, open connections to backends (with Varnish 2.x), etc. False by +default. =item B B|B Collects overview counters, such as the number of sessions created, the number of requests and bytes transferred. False by default. +=item B B|B + +Varnish uptime. False by default. + +=item B B|B + +Number of total (available + discarded) VCL (config files). False by default. + =item B B|B Collect statistics about worker threads. False by default. @@ -5569,6 +5980,16 @@ If set to B (the default), convert counter values to rates. If set to B counter values are stored as is, i.e. as an increasing integer number. +=item B I + +=item B I + +=item B I + +Sets the information used when authenticating to a I database. The +fields are optional (in which case no authentication is attempted), but if you +want to use authentication all three fields must be set. + =back =head2 Plugin C @@ -5650,7 +6071,7 @@ Synopsis: Protocol UDP StoreRates true AlwaysAppendDS false - Delay 10 + TTLFactor 2.0 Tag "foobar" @@ -5697,6 +6118,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