X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=29a1d1457ca3367587fb80293ec92c06dac54101;hb=4a9d11514a7e95d89dafc3f7f5f4610e707ae9e3;hp=f4f3f1c5524968cc81561fd3ac60843f633febca;hpb=908956b8c46180d0905478e9c1e110d5213f2808;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index f4f3f1c5..29a1d145 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -72,15 +72,19 @@ options are allowed inside a B block: If enabled, collectd will export all global symbols of the plugin (and of all libraries loaded as dependencies of the plugin) and, thus, makes those symbols available for resolving unresolved symbols in subsequently loaded plugins if -that is supported by your system. By default, this is disabled. +that is supported by your system. -This is useful (or possibly even required), e.Eg., when loading a plugin -that embeds some scripting language into the daemon (e.Eg. the C -or C plugins). Scripting languages usually provide means to load +This is useful (or possibly even required), e.g., when loading a plugin that +embeds some scripting language into the daemon (e.g. the I and +I). Scripting languages usually provide means to load extensions written in C. Those extensions require symbols provided by the -interpreter, which is loaded as a dependency of the respective collectd -plugin. See the documentation of those plugins (e.Eg., -L or L) for details. +interpreter, which is loaded as a dependency of the respective collectd plugin. +See the documentation of those plugins (e.g., L or +L) for details. + +By default, this is disabled. As a special exception, if the plugin name is +either C or C, the default is changed to enabled in order to keep +the average user from ever having to deal with this low level linking stuff. =back @@ -129,6 +133,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 +145,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 @@ -475,6 +483,7 @@ Synopsis: URL "http://localhost:8053/" + ParseTime false OpCodes true QTypes true @@ -501,35 +510,44 @@ The bind plugin accepts the following configuration options: URL from which to retrieve the XML data. If not specified, C will be used. -=item B I|I +=item B B|B + +When set to B, the time provided by BIND will be parsed and used to +dispatch the values. When set to B, the local time source is queried. + +This setting is set to B by default for backwards compatibility; setting +this to B is I to avoid problems with timezones and +localization. + +=item B B|B When enabled, statistics about the I<"OpCodes">, for example the number of C packets, are collected. Default: Enabled. -=item B I|I +=item B B|B When enabled, the number of I queries by query types (for example C, C, C) is collected. Default: Enabled. -=item B I|I +=item B B|B Collect global server statistics, such as requests received over IPv4 and IPv6, successful queries, and failed updates. Default: Enabled. -=item B I|I +=item B B|B Collect zone maintenance statistics, mostly information about notifications (zone updates) and zone transfers. Default: Enabled. -=item B I|I +=item B B|B Collect resolver statistics, i.Ee. statistics about outgoing requests (e.Eg. queries over IPv4, lame servers). Since the global resolver @@ -558,21 +576,21 @@ configured, no detailed view statistics will be collected. =over 4 -=item B I|I +=item B B|B If enabled, the number of I queries by query type (e.Eg. C, C) is collected. Default: Enabled. -=item B I|I +=item B B|B Collect resolver statistics, i.Ee. statistics about outgoing requests (e.Eg. queries over IPv4, lame servers). Default: Enabled. -=item B I|I +=item B B|B If enabled, the number of entries (I<"RR sets">) in the view's cache by query type is collected. Negative entries (queries which resulted in an error, for @@ -731,22 +749,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 @@ -831,7 +833,7 @@ The B uses B (L) and B In the B block, there may be one or more B blocks, each defining a -URL to be fetched via HTTP (using libcurl). Within each B block there are +URL to be fetched using libcurl. Within each B block there are options which specify the connection parameters, for example authentication information, and one or more B blocks. @@ -1270,6 +1272,41 @@ at most B<16384> to prevent typos and dumb mistakes. =back +=head2 Plugin C + +The I collects information about network interface cards (NICs) +by talking directly with the underlying kernel driver using L. + +B + + + Interface "eth0" + Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload" + Map "multicast" "if_multicast" + + +B + +=over 4 + +=item B I + +Collect statistical information about interface I. + +=item B I I [I] + +By default, the plugin will submit values as type C and I set to I, the name of the metric as reported by the driver. If +an appropriate B option exists, the given I and, optionally, +I will be used. + +=item B B|B + +When set to B, only metrics that can be mapped to to a I will be +collected, all other metrics will be ignored. Defaults to B. + +=back + =head2 Plugin C Please make sure to read L before using this plugin. It @@ -1820,6 +1857,31 @@ TCP-Port to connect to. Defaults to B<411>. =back +=head2 Plugin C + +The C collects information from Linux Software-RAID devices (md). + +All reported values are of the type C. Reported type instances are +I, I (present but not operational), I (hot stand-by) and +I (physically absent) disks. + +=over 4 + +=item B I + +Select md devices based on device name. The I is the basename of +the device, i.e. the name of the block device without the leading C. +See B for more details. + +=item B B|B + +Invert device selection: If set to B, all md devices B those +listed using B are collected. If B (the default), only those +listed are collected. If no configuration is given, the B plugin will +collect data from all md devices. + +=back + =head2 Plugin C The C connects to a memcached server, queries one or more @@ -1941,11 +2003,11 @@ Configures the base register to read from the device. If the option B has been set to B or B, this and the next register will be read (the register number is increased by one). -=item B B|B|B +=item B B|B|B|B|B -Specifies what kind of data is returned by the device. If the type is B -or B, two 16Ebit registers will be read and the data is combined -into one value. Defaults to B. +Specifies what kind of data is returned by the device. If the type is B, +B or B, two 16Ebit registers will be read and the data is +combined into one value. Defaults to B. =item B I @@ -2071,8 +2133,10 @@ Hostname of the database server. Defaults to B. =item B I Username to use when connecting to the database. The user does not have to be -granted any privileges (which is synonym to granting the C privilege). -Any existing MySQL user will do. +granted any privileges (which is synonym to granting the C privilege), +unless you want to collectd replication statistics (see B and +B below). In this case, the user needs the C +(or C) privileges. Else, any existing MySQL user will do. =item B I @@ -2104,7 +2168,9 @@ C function for details. =item B I -Enable the collection of master / slave statistics in a replication setup. +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. =item B I @@ -2658,10 +2724,18 @@ The default IPv6 multicast group is C. The default IPv4 multicast group is C<239.192.74.66>. The default I port is B<25826>. Both, B and B can be used as single option or as block. When -used as block, given options are valid for this socket only. For example: +used as block, given options are valid for this socket only. The following +example will export the metrics twice: Once to an "internal" server (without +encryption and signing) and one to an external server (with cryptographic +signature): + # Export to an internal server + # (demonstrates usage without additional options) Server "collectd.internal.tld" + + # Export to an external server + # (demonstrates usage with signature options) SecurityLevel "sign" Username "myhostname" @@ -2790,7 +2864,18 @@ operating systems. =item B I<1024-65535> Set the maximum size for datagrams received over the network. Packets larger -than this will be truncated. Defaults to 1452Ebytes. +than this will be truncated. Defaults to 1452Ebytes, which is the maximum +payload size that can be transmitted in one Ethernet frame using IPv6E/ +UDP. + +On the server side, this limit should be set to the largest value used on +I client. Likewise, the value on the client must not be larger than the +value on the server, or data will be lost. + +B Versions prior to I4.8> used a fixed sized +buffer of 1024Ebytes. Versions I<4.8>, I<4.9> and I<4.10> used a default +value of 1024Ebytes to avoid problems when sending data to an older +server. =item B I @@ -2862,7 +2947,8 @@ and are checked by default depends on the distribution you use. This plugin sends a desktop notification to a notification daemon, as defined in the Desktop Notification Specification. To actually display the notifications, B is required and B has to be -able to access the X server. +able to access the X server (i.Ee., the C and C +environment variables have to be set correctly) and the D-Bus message bus. The Desktop Notification Specification can be found at L. @@ -3182,6 +3268,11 @@ values submitted to the daemon. Other than that, that name is not used. Defines the "database alias" or "service name" to connect to. Usually, these names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>. +=item B I + +Hostname to use when dispatching values for this database. Defaults to using +the global hostname of the I instance. + =item B I Username used for authentication. @@ -3359,6 +3450,13 @@ which are available in a PostgreSQL database or use future or special statistics provided by PostgreSQL without the need to upgrade your collectd installation. +Starting with version 5.2, the C plugin supports writing data to +PostgreSQL databases as well. This has been implemented in a generic way. You +need to specify an SQL statement which will then be executed by collectd in +order to write the data (see below for details). The benefit of that approach +is that there is no fixed database layout. Rather, the layout may be optimized +for the current setup. + The B manual can be found at L. @@ -3388,6 +3486,11 @@ L. + + Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);" + StoreRates true + + Host "hostname" Port "5432" @@ -3404,6 +3507,12 @@ L. Query backend # predefined Query rt36_tickets + + + # ... + Writer sqlstore + CommitInterval 10 + The B block defines one database query which may later be used by a @@ -3565,6 +3674,84 @@ This query collects the on-disk size of the database in bytes. =back +The B block defines a PostgreSQL writer backend. It accepts a single +mandatory argument specifying the name of the writer. This will then be used +in the B specification in order to activate the writer instance. The +names of all writers have to be unique. The following options may be +specified: + +=over 4 + +=item B I + +This mandatory option specifies the SQL statement that will be executed for +each submitted value. A single SQL statement is allowed only. Anything after +the first semicolon will be ignored. + +Nine parameters will be passed to the statement and should be specified as +tokens B<$1>, B<$2>, through B<$9> in the statement string. The following +values are made available through those parameters: + +=over 4 + +=item B<$1> + +The timestamp of the queried value as a floating point number. + +=item B<$2> + +The hostname of the queried value. + +=item B<$3> + +The plugin name of the queried value. + +=item B<$4> + +The plugin instance of the queried value. This value may be B if there +is no plugin instance. + +=item B<$5> + +The type of the queried value (cf. L). + +=item B<$6> + +The type instance of the queried value. This value may be B if there is +no type instance. + +=item B<$7> + +An array of names for the submitted values (i.Ee., the name of the data +sources of the submitted value-list). + +=item B<$8> + +An array of types for the submitted values (i.Ee., the type of the data +sources of the submitted value-list; C, C, ...). Note, that if +B is enabled (which is the default, see below), all types will be +C. + +=item B<$9> + +An array of the submitted values. The dimensions of the value name and value +arrays match. + +=back + +In general, it is advisable to create and call a custom function in the +PostgreSQL database for this purpose. Any procedural language supported by +PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual +for details). + +=item B B|B + +If set to B (the default), convert counter values to rates. If set to +B counter values are stored as is, i.Ee. as an increasing integer +number. + +=back + The B block defines one PostgreSQL database for which to collect statistics. It accepts a single mandatory argument which specifies the database name. None of the other options are required. PostgreSQL will use @@ -3580,6 +3767,17 @@ for details. Specify the interval with which the database should be queried. The default is to use the global B setting. +=item B I + +This option may be used for database connections which have "writers" assigned +(see above). If specified, it causes a writer to put several updates into a +single transaction. This transaction will last for the specified amount of +time. By default, each update will be executed in a separate transaction. Each +transaction generates a fair amount of overhead which can, thus, be reduced by +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 hostname or IP of the PostgreSQL server to connect to. If the @@ -4142,7 +4340,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. @@ -4152,6 +4350,11 @@ L. =over 4 +=item B I + +Read the I configuration from I. When unset (recommended), +the library's default will be used. + =item B I Selects the name of the sensor which you want to collect or ignore, depending @@ -4177,6 +4380,25 @@ 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 +I and I, the following options are available: + +=over 4 + +=item B B|B + +Configures how to report physical swap devices. If set to B (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. + +This option is only available if the I can read C +(under Linux) or use the L mechanism (under I). + +=back + =head2 Plugin C =over 4 @@ -4190,6 +4412,15 @@ syslog-daemon. Please note that B is only available if collectd has been compiled with debugging support. +=item B B|B|B + +Controls which notifications should be sent to syslog. The default behaviour is +not to send any. Less severe notifications always imply logging more severe +notifications: Setting this to B means all notifications will be sent to +syslog, setting this to B will send B and B +notifications but will dismiss B notifications. Setting this option to +B will only send failures to syslog. + =back =head2 Plugin C @@ -4526,7 +4757,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. @@ -4546,9 +4777,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 @@ -4731,6 +4971,115 @@ traffic (e.Eg. due to headers and retransmission). If you want to collect on-wire traffic you could, for example, use the logging facilities of iptables to feed data for the guest IPs into the iptables plugin. +=head2 Plugin C + +The C plugin writes data to I, an open-source metrics +storage and graphing project. The plugin connects to I, the data layer +of I, and sends data via the "line based" protocol (per default using +portE2003). The data will be sent in blocks of at most 1428 bytes to +minimize the number of network packets. + +Synopsis: + + + + Host "localhost" + Port "2003" + Prefix "collectd" + + + +=over 4 + +=item B I
+ +Hostname or address to connect to. Defaults to C. + +=item B I + +Service name or port number to connect to. Defaults to C<2003>. + +=item B I + +When set, I is added in front of the host name. Dots and whitespace are +I escaped in this string (see B below). + +=item B I + +When set, I is appended to the host name. Dots and whitespace are +I escaped in this string (see B below). + +=item B I + +I uses the dot (C<.>) as escape character and doesn't allow whitespace +in the identifier. The B option determines which character +dots, whitespace and control characters are replaced with. Defaults to +underscore (C<_>). + +=item B B|B + +If set to B (the default), convert counter values to rates. If set to +B counter values are stored as is, i.Ee. as an increasing integer +number. + +=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 once component, for example C. + +=item B B|B + +If set the 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 + +The I will send values to I, a schema-less +NoSQL database. + +B + + + + Host "localhost" + Port "27017" + Timeout 1000 + StoreRates true + + + +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
+ +Hostname or address to connect to. Defaults to C. + +=item B I + +Service name or port number to connect to. Defaults to C<27017>. + +=item B I + +Set the timeout for each operation on I to I milliseconds. +Setting this option to zero means no timeout, which is the default. + +=item B B|B + +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. + +=back + =head2 Plugin C This output plugin submits values to an http server by POST them using the @@ -4857,13 +5206,6 @@ information. WarningMin 100000000 - - - DataSource "midterm" - FailureMax 4 - Hits 3 - Hysteresis 3 - @@ -4936,26 +5278,33 @@ 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 +=item B I + +Delay creating the notification until the threshold has been passed I +times. When a notification has been generated, or when a subsequent value is +inside the threshold, the counter is reset. If, for example, a value is +collected once every 10Eseconds and B is set to 3, a notification +will be dispatched at most once every 30Eseconds. + +This is useful when short bursts are not a problem. If, for example, 100% CPU +usage for up to a minute is normal (and data is collected every +10Eseconds), you could set B to B<6> to account for this. -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 -=item B I +When set to non-zero, a hysteresis value is applied when checking minimum and +maximum bounds. This is useful for values that increase slowly and fluctuate a +bit while doing so. When these values come close to the threshold, they may +"flap", i.e. switch between failure / warning case and okay case repeatedly. -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. +If, for example, the threshold is configures as -=item B B|B + WarningMax 100.0 + Hysteresis 1.0 -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. +then a I notification is created when the value exceeds I<101> and the +corresponding I notification is only created once the value falls below +I<99>, thus avoiding the "flapping". =back @@ -5584,7 +5933,7 @@ convert counter values to rates. Please note that these placeholders are B! -=item B B<"FATAL">|B<"WARNING">|B<"OKAY"> +=item B B<"FAILURE">|B<"WARNING">|B<"OKAY"> Sets the severity of the message. If omitted, the severity B<"WARNING"> is used.