X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=7579664ba1b146112722d6023dc074c35e8f2236;hb=2f2744072ab144b8130b2296327fc3382e5f7f80;hp=af07cdf23017a2afbf6881ebe16563d86e6ff290;hpb=b53110ef99e3d6a5e2f8e79b8f068cfe96a1accb;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index af07cdf2..7579664b 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -129,6 +129,10 @@ Configures the interval in which to query the read plugins. Obviously smaller values lead to a higher system load produced by collectd, while higher values lead to more coarse statistics. +B You should set this once and then never touch it again. If you do, +I or know some serious RRDtool +magic! (Assuming you're using the I or I plugin.) + =item B I Consider a value list "missing" when no update has been read or received for @@ -137,7 +141,7 @@ missing when no update has been received for twice the update interval. Since this setting uses iterations, the maximum allowed time without update depends on the I information contained in each value list. This is used in the I configuration to dispatch notifications about missing values, -see L<"THRESHOLD CONFIGURATION"> below. +see L for details. =item B I @@ -181,6 +185,143 @@ A list of all plugins and a short summary for each plugin can be found in the F file shipped with the sourcecode and hopefully binary packets as well. +=head2 Plugin C + +The I can be used to communicate with other instances of +I or third party applications using an AMQP message broker. Values +are sent to or received from the broker, which handles routing, queueing and +possibly filtering or messages. + + + # Send values to an AMQP broker + + Host "localhost" + Port "5672" + VHost "/" + User "guest" + Password "guest" + Exchange "amq.fanout" + # ExchangeType "fanout" + # RoutingKey "collectd" + # Persistent false + # Format "command" + # StoreRates false + + + # Receive values from an AMQP broker + + Host "localhost" + Port "5672" + VHost "/" + User "guest" + Password "guest" + Exchange "amq.fanout" + # ExchangeType "fanout" + # Queue "queue_name" + # RoutingKey "collectd.#" + + + +The plugin's configuration consists of a number of I and I +blocks, which configure sending and receiving of values respectively. The two +blocks are very similar, so unless otherwise noted, an option can be used in +either block. The name given in the blocks starting tag is only used for +reporting messages, but may be used to support I of certain +I blocks in the future. + +=over 4 + +=item B I + +Hostname or IP-address of the AMQP broker. Defaults to the default behavior of +the underlying communications library, I, which is "localhost". + +=item B I + +Service name or port number on which the AMQP broker accepts connections. This +argument must be a string, even if the numeric form is used. Defaults to +"5672". + +=item B I + +Name of the I on the AMQP broker to use. Defaults to "/". + +=item B I + +=item B I + +Credentials used to authenticate to the AMQP broker. By default "guest"/"guest" +is used. + +=item B I + +In I blocks, this option specifies the I to send values to. +By default, "amq.fanout" will be used. + +In I blocks this option is optional. If given, a I between +the given exchange and the I is created, using the I if +configured. See the B and B options below. + +=item B I + +If given, the plugin will try to create the configured I with this +I after connecting. When in a I block, the I will then +be bound to this exchange. + +=item B I (Subscribe only) + +Configures the I name to subscribe to. If no queue name was configures +explicitly, a unique queue name will be created by the broker. + +=item B I + +In I blocks, this configures the routing key to set on all outgoing +messages. If not given, the routing key will be computed from the I +of the value. The host, plugin, type and the two instances are concatenated +together using dots as the separator and all containing dots replaced with +slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it +possible to receive only specific values using a "topic" exchange. + +In I blocks, configures the I used when creating a +I between an I and the I. The usual wildcards can be +used to filter messages when using a "topic" exchange. If you're only +interested in CPU statistics, you could use the routing key "collectd.*.cpu.#" +for example. + +=item B B|B (Publish only) + +Selects the I to use. If set to B, the I +mode will be used, i.e. delivery is guaranteed. If set to B (the +default), the I delivery mode will be used, i.e. messages may be +lost due to high load, overflowing queues or similar issues. + +=item B B|B (Publish only) + +Selects the format in which messages are sent to the broker. If set to +B (the default), values are sent as C commands which are +identical to the syntax used by the I and I. In this +case, the C header field will be set to C. + +If set to B, the values are encoded in the I, +an easy and straight forward exchange format. The C header field +will be set to C. + +A subscribing client I use the C header field to +determine how to decode the values. Currently, the I itself can +only decode the B format. + +=item B B|B (Publish only) + +Determines whether or not C, C and C data sources +are converted to a I (i.e. a C value). If set to B (the +default), no conversion is performed. Otherwise the conversion is performed +using the internal value cache. + +Please note that currently this option is only used if the B option has +been set to B. + +=back + =head2 Plugin C To configure the C-plugin you first need to configure the Apache @@ -199,7 +340,25 @@ Since its C module is very similar to Apache's, B is also supported. It introduces a new field, called C, to count the number of currently connected clients. This field is also supported. -The following options are accepted by the C-plugin: +The configuration of the I plugin consists of one or more +CInstanceE/E> blocks. Each block requires one string argument +as the instance name. For example: + + + + URL "http://www1.example.com/mod_status?auto" + + + URL "http://www2.example.com/mod_status?auto" + + + +The instance name will be used as the I. To emulate the old +(versionE4) behavior, you can use an empty string (""). In order for the +plugin to work correctly, each instance name must be unique. This is not +enforced by the plugin and it is your responsibility to ensure it. + +The following options are accepted within each I block: =over 4 @@ -207,7 +366,7 @@ The following options are accepted by the C-plugin: Sets the URL of the C output. This needs to be the output generated by C and it needs to be the machine readable output -generated by appending the C argument. +generated by appending the C argument. This option is I. =item B I @@ -576,22 +735,6 @@ runtime statistics module of CouchDB -Another CouchDB example: -The following example will collect the status values from each database: - - - Instance "dbs" - - Type "gauge" - - - Type "counter" - - - Type "bytes" - - - In the B block, there may be one or more B blocks, each defining a URL to be fetched via HTTP (using libcurl) and one or more B blocks. The B string argument must be in a path format, which is used to collect a @@ -1595,8 +1738,8 @@ debugging support. Sets the file to write log messages to. The special strings B and B can be used to write to the standard output and standard error -channels, respectively. This, of course, only makes much sense when collectd is -running in foreground- or non-daemon-mode. +channels, respectively. This, of course, only makes much sense when I +is running in foreground- or non-daemon-mode. =item B B|B @@ -1613,6 +1756,33 @@ B: There is no need to notify the daemon after moving or removing the log file (e.Eg. when rotating the logs). The plugin reopens the file for each line it writes. +=head2 Plugin C + +The I reads CPU statistics of I, a +virtualization technique for IBM POWER processors. It takes into account CPU +time stolen from or donated to a partition, in addition to the usual user, +system, I/O statistics. + +The following configuration options are available: + +=over 4 + +=item B B|B + +When enabled, statistics about the processor pool are read, too. The partition +needs to have pool authority in order to be able to acquire this information. +Defaults to false. + +=item B B|B + +If enabled, the serial of the physical machine the partition is currently +running on is reported as I and the logical hostname of the machine +is reported in the I. Otherwise, the logical hostname will be +used (just like other plugins) and the I will be empty. +Defaults to false. + +=back + =head2 Plugin C The C uses mbmon to retrieve temperature, voltage, etc. @@ -2608,7 +2778,7 @@ operating systems. =item B I<1024-65535> Set the maximum size for datagrams received over the network. Packets larger -than this will be truncated. +than this will be truncated. Defaults to 1452Ebytes. =item B I @@ -3960,7 +4130,7 @@ because all values were added to the internal cache at roughly the same time. =head2 Plugin C -The C uses B to retrieve sensor-values. This means +The I uses B to retrieve sensor-values. This means that all the needed modules have to be loaded and lm_sensors has to be configured (most likely by editing F. Read L for details. @@ -3995,6 +4165,39 @@ 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 collects information about used and available swap space. On +Solaris, it is possible to collect information on physical swap devices and the +view of the virtual memory subsystem on the matter. On I, the +following options are available: + +=over 4 + +=item B B|B|B + +Configures how to report physical swap devices. If B is used (the +default), the summary over all swap devices is reported only, i.e. the globally +used and available space over all devices. If B is configured, the +used and available space of each device will be reported separately. B +deactivates collection of physical swap information (only valid if collection +via L is available). + +This option is only available if the I can use the L +mechanism under I. + +=item B B|B + +Configures whether or not to report the view of the virtual memory subsystem on +swap space. This information is used under Solaris if L is not +available and was the default behavior under I in I4>. + +This option is only available if the I can use L and +L to collect swap statistics under I. It defaults to +B. + +=back + =head2 Plugin C =over 4 @@ -4344,7 +4547,7 @@ port in numeric form. =item B I|I -By default, the C plugin tries to read the statistics from the Linux +By default, the I tries to read the statistics from the Linux C interface. If that is not available, the plugin falls back to the C interface. By setting this option to I, you can force the plugin to use the latter. This option defaults to I. @@ -4364,9 +4567,18 @@ selection is configured at all, B devices are selected. =back +=head2 Plugin C + +The I checks values collected or received by I +against a configurable I and issues I if values are +out of bounds. + +Documentation for this plugin is available in the L +manual page. + =head2 Plugin C -The C connects to a TokyoTyrant server and collects a +The I connects to a TokyoTyrant server and collects a couple metrics: number of records, and database size on disk. =over 4 @@ -4403,6 +4615,13 @@ Change the file permissions of the UNIX-socket after it has been created. The permissions must be given as a numeric, octal value as you would pass to L. Defaults to B<0770>. +=item B B|B + +If set to B, delete the socket file before calling L, if a file +with the given name already exists. If I crashes a socket file may be +left over, preventing the daemon from opening a new socket when restarted. +Since this is potentially dangerous, this defaults to B. + =back =head2 Plugin C @@ -4606,170 +4825,6 @@ number. =back -=head1 THRESHOLD CONFIGURATION - -Starting with version C<4.3.0> collectd has support for B. By that -we mean that the values are not only stored or sent somewhere, but that they -are judged and, if a problem is recognized, acted upon. The only action -collectd takes itself is to generate and dispatch a "notification". Plugins can -register to receive notifications and perform appropriate further actions. - -Since systems and what you expect them to do differ a lot, you can configure -B for your values freely. This gives you a lot of flexibility but -also a lot of responsibility. - -Every time a value is out of range a notification is dispatched. This means -that the idle percentage of your CPU needs to be less then the configured -threshold only once for a notification to be generated. There's no such thing -as a moving average or similar - at least not now. - -Also, all values that match a threshold are considered to be relevant or -"interesting". As a consequence collectd will issue a notification if they are -not received for B iterations. The B configuration option is -explained in section L<"GLOBAL OPTIONS">. If, for example, B is set to -"2" (the default) and some hosts sends it's CPU statistics to the server every -60 seconds, a notification will be dispatched after about 120 seconds. It may -take a little longer because the timeout is checked only once each B -on the server. - -When a value comes within range again or is received after it was missing, an -"OKAY-notification" is dispatched. - -Here is a configuration example to get you started. Read below for more -information. - - - - WarningMin 0.00 - WarningMax 1000.00 - FailureMin 0.00 - FailureMax 1200.00 - Invert false - Instance "bar" - - - - Instance "eth0" - - FailureMax 10000000 - DataSource "rx" - - - - - - Instance "idle" - FailureMin 10 - - - - - Instance "cached" - WarningMin 100000000 - - - - - DataSource "midterm" - FailureMax 4 - Hits 3 - Hysteresis 3 - - - - -There are basically two types of configuration statements: The C, -C, and C blocks select the value for which a threshold should be -configured. The C and C blocks may be specified further using the -C option. You can combine the block by nesting the blocks, though -they must be nested in the above order, i.Ee. C may contain either -C and C blocks, C may only contain C blocks and -C may not contain other blocks. If multiple blocks apply to the same -value the most specific block is used. - -The other statements specify the threshold to configure. They B be -included in a C block. Currently the following statements are recognized: - -=over 4 - -=item B I - -=item B I - -Sets the upper bound of acceptable values. If unset defaults to positive -infinity. If a value is greater than B a B notification -will be created. If the value is greater than B but less than (or -equal to) B a B notification will be created. - -=item B I - -=item B I - -Sets the lower bound of acceptable values. If unset defaults to negative -infinity. If a value is less than B a B notification will -be created. If the value is less than B but greater than (or equal -to) B a B notification will be created. - -=item B I - -Some data sets have more than one "data source". Interesting examples are the -C data set, which has received (C) and sent (C) bytes and -the C data set, which holds C and C operations. The -system load data set, C, even has three data sources: C, -C, and C. - -Normally, all data sources are checked against a configured threshold. If this -is undesirable, or if you want to specify different limits for each data -source, you can use the B option to have a threshold apply only to -one data source. - -=item B B|B - -If set to B the range of acceptable values is inverted, i.Ee. -values between B and B (B and -B) are not okay. Defaults to B. - -=item B B|B - -Sets how often notifications are generated. If set to B one notification -will be generated for each value that is out of the acceptable range. If set to -B (the default) then a notification is only generated if a value is out -of range but the previous value was okay. - -This applies to missing values, too: If set to B a notification about a -missing value is generated once every B seconds. If set to B -only one such notification is generated until the value appears again. - -=item B B|B - -If set to B, the minimum and maximum values given are interpreted as -percentage value, relative to the other data sources. This is helpful for -example for the "df" type, where you may want to issue a warning when less than -5E% of the total space is available. Defaults to B. - -=item B I - -Sets the number of occurrences which the threshold must be arised before to -dispatch any notification or, in other words, the number of Bs -than the threshold must be match before dispatch any notification. - -=item B I - -Sets the hysteresis value for threshold. The hysteresis is a method to -prevent flapping between states, until a new received value for -a previously matched threshold down below the threshold condition -(B, B or everthing else) minus the hysteresis value, -the failure (respectively warning) state will be keep. - -=item B B|B - -If set to B (the default), the threshold must be treated as -interesting and, when a number of B values will lost, then -a missing notification will be dispatched. On the other hand, if set to -B, the missing notification will never dispatched for this threshold. - -=back - =head1 FILTER CONFIGURATION Starting with collectd 4.6 there is a powerful filtering infrastructure