X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=f5130307b124069024e0ffceff67e5f1e1a74099;hb=b61a03b05c1f4040a6599334b65141aa3bd134f5;hp=7626a4637589b9614ae23b446bd839c61456beba;hpb=b48fe5c7fc811271d0a3a1f86ec21054191c0878;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 7626a463..f5130307 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 @@ -76,7 +78,6 @@ affecting the behavior of B may be specified. The following options are allowed inside a B block: - Globals true Interval 10 @@ -109,7 +110,7 @@ interval, that setting will take precedence. =back -=item B I [I] +=item B I If I points to a file, includes that file. If I points to a directory, recursively includes all files within that directory and its @@ -119,15 +120,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 @@ -419,6 +434,8 @@ possibly filtering or messages. # StoreRates false # GraphitePrefix "collectd." # GraphiteEscapeChar "_" + # GraphiteSeparateInstances false + # GraphiteAlwaysAppendDS false # Receive values from an AMQP broker @@ -556,6 +573,19 @@ In I metric name, dots are used as separators between different metric parts (host, plugin, type). Default is "_" (I). +=item B B|B + +If set to B, the plugin instance and type instance will be in their own +path component, for example C. If set to B (the +default), the plugin and plugin instance (and likewise the type and type +instance) are put into one component, for example C. + +=item B B|B + +If set to B, append the name of the I (DS) to the "metric" +identifier. If set to B (the default), this is only done when there is +more than one DS. + =back =head2 Plugin C @@ -944,6 +974,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 +1045,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 +1122,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 @@ -2441,12 +2488,12 @@ C function for details. Enable the collection of master / slave statistics in a replication setup. In order to be able to get access to these statistics, the user needs special -privileges. See the B documentation above. +privileges. See the B documentation above. Defaults to B. =item B I If enabled, the plugin sends a notification if the replication slave I/O and / -or SQL threads are not running. +or SQL threads are not running. Defaults to B. =back @@ -4161,6 +4208,13 @@ activating this option. The draw-back is, that data covering the specified amount of time will be lost, for example, if a single statement within the transaction fails or if the database server crashes. +=item B I + +Specify the plugin instance name that should be used instead of the database +name (which is the default, if this option has not been specified). This +allows to query multiple databases of the same name on the same host (e.g. +when running multiple database server versions in parallel). + =item B I Specify the hostname or IP of the PostgreSQL server to connect to. If the @@ -4191,13 +4245,6 @@ Specify the password to be used when connecting to the server. Specify whether to use an SSL connection when contacting the server. The following modes are supported: -=item B I - -Specify the plugin instance name that should be used instead of the database -name (which is the default, if this option has not been specified). This -allows to query multiple databases of the same name on the same host (e.g. -when running multiple database server versions in parallel). - =over 4 =item I @@ -4698,6 +4745,14 @@ Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option. I must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and one (exclusive). +=item B B|B + +When set to B, various statistics about the I daemon will be +collected, with "rrdcached" as the I. Defaults to B. + +Statistics are read via Is socket using the STATS command. +See L for details. + =back =head2 Plugin C @@ -5139,6 +5194,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 @@ -5367,7 +5513,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 @@ -5524,7 +5696,7 @@ instance) are put into one component, for example C. =item B B|B -If set the B, append the name of the I (DS) to the "metric" +If set to B, append the name of the I (DS) to the "metric" identifier. If set to B (the default), this is only done when there is more than one DS. @@ -5571,6 +5743,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 @@ -5637,6 +5819,61 @@ number. =back +=head2 Plugin C + +The I submits values to I, a data structure server. + +Synopsis: + + + + Host "localhost" + Port "6379" + Timeout 1000 + + + +Values are submitted to I, using the metric name as the key, and +the timestamp as the score. Retrieving a date range can then be done using the +C I command. Additionnally, all the identifiers of these +I are kept in a I called C and can be +retrieved using the C I command. See +L and L for +details. + +The information shown in the synopsis above is the I +which is used by the plugin if no configuration is present. + +The plugin can send values to multiple instances of I by specifying +one B block for each instance. Within the B blocks, the following +options are available: + +=over 4 + +=item B I + +The B block identifies a new I node, that is a new I +instance running in an specified host and port. The name for node is a +canonical identifier which is used as I. It is limited to +64Echaracters in length. + +=item B I + +The B option is the hostname or IP-address where the I instance is +running on. + +=item B I + +The B option is the TCP port on which the Redis instance accepts +connections. Either a service name of a port number may be given. Please note +that numerical port numbers must be given as a string, too. + +=item B I + +The B option sets the socket connection timeout, in milliseconds. + +=back + =head2 Plugin C The I will send values to I, a powerfull stream @@ -5740,7 +5977,7 @@ When a value comes within range again or is received after it was missing, an Here is a configuration example to get you started. Read below for more information. - + WarningMin 0.00 WarningMax 1000.00 @@ -5771,7 +6008,7 @@ information. - + There are basically two types of configuration statements: The C, C, and C blocks select the value for which a threshold should be @@ -6178,19 +6415,36 @@ Available options: =item B I Name of the write plugin to which the data should be sent. This option may be -given multiple times to send the data to more than one write plugin. +given multiple times to send the data to more than one write plugin. If the +plugin supports multiple instances, the plugin's instance(s) must also be +specified. =back If no plugin is explicitly specified, the values will be sent to all available write plugins. -Example: +Single-instance plugin example: Plugin "rrdtool" +Multi-instance plugin example: + + + + ... + + + ... + + + ... + + Plugin "write_graphite/foo" + + =item B Starts processing the rules of another chain, see L<"Flow control"> above. If