X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=7a4eb9383718d746d6c259ffcd2a2f3c6f6e1bec;hb=51a4e62d7d0e73d8d5822efaef1e3218b5ad0373;hp=62ecad447819835567977d47e161c08ac0b11d8f;hpb=2f8cbc2fc2eeb59aaf8afd9cabacd5f66e825aa4;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 62ecad44..7a4eb938 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 @@ -109,7 +111,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 +121,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 +435,8 @@ possibly filtering or messages. # StoreRates false # GraphitePrefix "collectd." # GraphiteEscapeChar "_" + # GraphiteSeparateInstances false + # GraphiteAlwaysAppendDS false # Receive values from an AMQP broker @@ -556,6 +574,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 +975,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 +1046,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 +1123,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 @@ -2516,6 +2564,14 @@ Required capabilities are documented below. IgnoreSelectedSnapshot false + + Interval 60 + + + + Interval 30 + + Interval 30 GetCPULoad true @@ -2523,6 +2579,13 @@ Required capabilities are documented below. GetDiskOps true GetDiskIO true + + + Interval 60 + + SnapVault true + # ... + @@ -2533,7 +2596,27 @@ The netapp plugin accepts the following configuration options: =item B I A host block defines one NetApp filer. It will appear in collectd with the name -you specify here which does not have to be its real name nor its hostname. +you specify here which does not have to be its real name nor its hostname (see +the B
option below). + +=item B I + +A B block may only be used inside a host block. It accepts all the +same options as the B block (except for cascaded B blocks) and +will execute all NetApp API commands in the context of the specified +VFiler(R). It will appear in collectd with the name you specify here which +does not have to be its real name. The VFiler name may be specified using the +B option. If this is not specified, it will default to the name +you specify here. + +The VFiler block inherits all connection related settings from the surrounding +B block (which appear before the B block) but they may be +overwritten inside the B block. + +This feature is useful, for example, when using a VFiler as SnapVault target +(supported since OnTap 8.1). In that case, the SnapVault statistics are not +available in the host filer (vfiler0) but only in the respective VFiler +context. =item B B|B @@ -2577,6 +2660,19 @@ Mandatory Type: string +=item B I + +The name of the VFiler in which context to execute API commands. If not +specified, the name provided to the B block will be used instead. + +Optional + +Type: string + +Default: name of the B block + +B This option may only be used inside B blocks. + =item B I B @@ -2907,6 +3003,38 @@ capacities will be selected anyway. =back +=head3 The Quota block + +This will collect (tree) quota statistics (used disk space and number of used +files). This mechanism is useful to get usage information for single qtrees. +In case the quotas are not used for any other purpose, an entry similar to the +following in C would be sufficient: + + /vol/volA/some_qtree tree - - - - - + +After adding the entry, issue C on the NetApp filer. + +=over 4 + +=item B I + +Collect SnapVault(R) statistics every I seconds. + +=back + +=head3 The SnapVault block + +This will collect statistics about the time and traffic of SnapVault(R) +transfers. + +=over 4 + +=item B I + +Collect SnapVault(R) statistics every I seconds. + +=back + =head2 Plugin C The C plugin uses a netlink socket to query the Linux kernel about @@ -4564,6 +4692,16 @@ Enables or disables the creation of RRD files. If the daemon is not running locally, or B is set to a relative path, this will not work as expected. Default is B. +=item B B|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, +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 B the stepsize of newly created RRD-files. Ideally (and per default) @@ -4621,8 +4759,18 @@ can safely ignore these settings. =item B I -Set the directory to store RRD-files under. Per default RRD-files are generated -beneath the daemon's working directory, i.Ee. the B. +Set the directory to store RRD files under. By default RRD files are generated +beneath the daemon's working directory, i.e. the B. + +=item B B|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, +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 @@ -4643,7 +4791,7 @@ a very good reason to do so. The C calculates the number of PDPs per CDP based on the B, this setting and a timespan. This plugin creates RRD-files with -three times five RRAs, i. e. five RRAs with the CFs B, B, and +three times five RRAs, i.e. five RRAs with the CFs B, B, and B. The five RRAs are optimized for graphs covering one hour, one day, one week, one month, and one year. @@ -5039,6 +5187,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 @@ -5267,7 +5506,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 @@ -5424,7 +5689,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. @@ -5471,6 +5736,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 @@ -5537,6 +5812,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 @@ -5640,7 +5970,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 @@ -5671,7 +6001,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 @@ -6078,19 +6408,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