=head1 NAME collectd.conf - Configuration for the system statistics collection daemon B =head1 SYNOPSIS BaseDir "/path/to/data/" PIDFile "/path/to/pidfile/collectd.pid" Server "123.123.123.123" 12345 LoadPlugin cpu LoadPlugin load LoadPlugin ping Host "example.org" Host "provider.net" =head1 DESCRIPTION This config file controls how the system statistics collection daemon B behaves. The most significant option is B, which controls which plugins to load. These plugins ultimately define collectd's behavior. The syntax of this config file is similar to the config file of the famous B. Each line contains either a key-value-pair or a section-start or -end. Empty lines and everything after the hash-symbol `#' is ignored. Values are either string, enclosed in double-quotes, (floating-point-)numbers or a boolean expression, i.Ee. either B or B. String containing of only alphanumeric characters and underscores do not need to be quoted. Lines may be wrapped by using `\' as the last character before the newline. This allows long lines to be split into multiple lines. Quoted strings may be wrapped as well. However, those are treated special in that whitespace at the beginning of the following lines will be ignored, which allows for nicely indenting the wrapped lines. The configuration is read and processed in order, i.Ee. from top to bottom. So the plugins are loaded in the order listed in this config file. It is a good idea to load any logging plugins first in order to catch messages from plugins during configuration. Also, the C option B occur B the CPlugin ...E> block. =head1 GLOBAL OPTIONS =over 4 =item B I Sets the base directory. This is the directory beneath all RRD-files are created. Possibly more subdirectories are created. This is also the working 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. 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: Globals true =over 4 =item B B 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. 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 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. =back =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 subdirectories. If the C function is available on your system, shell-like wildcards are expanded before files are included. This means you can use statements like the following: Include "/etc/collectd.d/*.conf" 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 order in which the files are loaded. To prevent loops and shooting yourself in the foot in interesting ways the nesting is limited to a depth of 8Elevels, which should be sufficient for most uses. Since symlinks are followed it is still possible to crash the daemon by looping symlinks. In our opinion significant stupidity should result in an appropriate amount of pain. It is no problem to have a block like CPlugin fooE> in more than one file, but you cannot include files from within blocks. =item B I Sets where to write the PID file to. This file is overwritten when it exists and deleted when the program is stopped. Some init-scripts might override this setting using the B<-P> command-line option. =item B I Path to the plugins (shared objects) of collectd. =item B I [I ...] Set one or more files that contain the data-set descriptions. See L for a description of the format of this file. =item B I 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 I iterations. By default, I considers a value list 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 for details. =item B I Number of threads to start for reading plugins. The default value is B<5>, but you may want to increase this if you have more than five plugins that take a long time to read. Mostly those are plugin that do network-IO. Setting this to a value higher than the number of plugins you've loaded is totally useless. =item B I Sets the hostname that identifies a host. If you omit this setting, the hostname will be determined using the L system call. =item B B If B is determined automatically this setting controls whether or not the daemon should try to figure out the "fully qualified domain name", FQDN. This is done using a lookup of the name returned by C. This option is enabled by default. =item B I =item B I Configure the name of the "pre-cache chain" and the "post-cache chain". Please see L below on information on chains and how these setting change the daemon's behavior. =back =head1 PLUGIN OPTIONS Some plugins may register own options. These options must be enclosed in a C-Section. Which options exist depends on the plugin used. Some plugins require external configuration, too. The C, for example, required C to be configured in the webserver you're going to collect data from. These plugins are listed below as well, even if they don't require any configuration within collectd's configfile. 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 webserver correctly. The Apache-plugin C needs to be loaded and working and the C directive needs to be B. You can use the following snipped to base your Apache config upon: ExtendedStatus on SetHandler server-status 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 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 =item B I 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. This option is I. =item B I Optional user name needed for authentication. =item B I Optional password needed for authentication. =item B B Enable or disable peer SSL certificate verification. See L for details. Enabled by default. =item 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 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. =back =head2 Plugin C =over 4 =item B I Hostname of the host running B. Defaults to B. Please note that IPv6 support has been disabled unless someone can confirm or decline that B can handle it. =item B I TCP-Port to connect to. Defaults to B<3551>. =back =head2 Plugin C This plugin collects information about an Ascent server, a free server for the "World of Warcraft" game. This plugin gathers the information by fetching the XML status page using C and parses it using C. The configuration options are the same as for the C plugin above: =over 4 =item B I Sets the URL of the XML status output. =item B I Optional user name needed for authentication. =item B I Optional password needed for authentication. =item B B Enable or disable peer SSL certificate verification. See L for details. Enabled by default. =item 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 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. =back =head2 Plugin C Starting with BIND 9.5.0, the most widely used DNS server software provides extensive statistics about queries, responses and lots of other information. The bind plugin retrieves this information that's encoded in XML and provided via HTTP and submits the values to collectd. To use this plugin, you first need to tell BIND to make this information available. This is done with the C configuration option: statistics-channels { inet localhost port 8053; }; The configuration follows the grouping that can be seen when looking at the data with an XSLT compatible viewer, such as a modern web browser. It's probably a good idea to make yourself familiar with the provided values, so you can understand what the collected statistics actually mean. Synopsis: URL "http://localhost:8053/" OpCodes true QTypes true ServerStats true ZoneMaintStats true ResolverStats false MemoryStats true QTypes true ResolverStats true CacheRRSets true Zone "127.in-addr.arpa/IN" The bind plugin accepts the following configuration options: =over 4 =item B I URL from which to retrieve the XML data. If not specified, C will be used. =item B I|I When enabled, statistics about the I<"OpCodes">, for example the number of C packets, are collected. Default: Enabled. =item B I|I When enabled, the number of I queries by query types (for example C, C, C) is collected. Default: Enabled. =item B I|I Collect global server statistics, such as requests received over IPv4 and IPv6, successful queries, and failed updates. Default: Enabled. =item B I|I Collect zone maintenance statistics, mostly information about notifications (zone updates) and zone transfers. Default: Enabled. =item B I|I Collect resolver statistics, i.Ee. statistics about outgoing requests (e.Eg. queries over IPv4, lame servers). Since the global resolver counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by default. Use the B option within a B block instead for the same functionality. Default: Disabled. =item B Collect global memory statistics. Default: Enabled. =item B I Collect statistics about a specific I<"view">. BIND can behave different, mostly depending on the source IP-address of the request. These different configurations are called "views". If you don't use this feature, you most likely are only interested in the C<_default> view. Within a EBEIE block, you can specify which information you want to collect about a view. If no B block is configured, no detailed view statistics will be collected. =over 4 =item B I|I If enabled, the number of I queries by query type (e.Eg. C, C) is collected. Default: Enabled. =item B I|I Collect resolver statistics, i.Ee. statistics about outgoing requests (e.Eg. queries over IPv4, lame servers). Default: Enabled. =item B I|I 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 example names that do not exist) are reported with a leading exclamation mark, e.Eg. "!A". Default: Enabled. =item B I When given, collect detailed information about the given zone in the view. The information collected if very similar to the global B information (see above). You can repeat this option to collect detailed information about multiple zones. By default no detailed zone information is collected. =back =back =head2 Plugin C This plugin doesn't have any options. It reads F (for the first CPU installed) to get the current CPU frequency. If this file does not exist make sure B (L) or a similar tool is installed and an "cpu governor" (that's a kernel module) is loaded. =head2 Plugin C =over 4 =item B I Set the directory to store CSV-files under. Per default CSV-files are generated beneath the daemon's working directory, i.Ee. the B. 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. =item B B If set to B, convert counter values to rates. If set to B (the default) counter values are stored as is, i.Ee. as an increasing integer number. =back =head2 Plugin C The curl plugin uses the B (L) to read web pages and the match infrastructure (the same code used by the tail plugin) to use regular expressions with the received data. The following example will read the current value of AMD stock from Google's finance page and dispatch the value to collectd. URL "http://finance.google.com/finance?q=NYSE%3AAMD" User "foo" Password "bar" Regex "]*> *([0-9]*\\.[0-9]+) *" DSType "GaugeAverage" # Note: `stock_value' is not a standard type. Type "stock_value" Instance "AMD" In the B block, there may be one or more B blocks, each defining a web page and one or more "matches" to be performed on the returned data. The string argument to the B block is used as plugin instance. The following options are valid within B blocks: =over 4 =item B I URL of the web site to retrieve. Since a regular expression will be used to extract information from this data, non-binary data is a big plus here ;) =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 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 B|B Measure response time for the request. If this setting is enabled, B blocks (see below) are optional. Disabled by default. =item BMatchE> One or more B blocks that define how to match information in the data returned by C. The C plugin uses the same infrastructure that's used by the C plugin, so please see the documentation of the C plugin below on how matches are defined. If the B option is set to B, B blocks are optional. =back =head2 Plugin C The B uses B (L) and B (L) to retrieve JSON data via cURL. This can be used to collect values from CouchDB documents (which are stored JSON notation), for example. The following example will collect several values from the built-in `_stats' runtime statistics module of CouchDB (L). Instance "httpd" Type "http_requests" Type "http_request_methods" Type "http_response_codes" 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 value from a JSON map object. If a path element of B is the I<*>Ewildcard, the values for all keys will be collectd. The following options are valid within B blocks: =over 4 =item B I 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 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. =back The following options are valid within B blocks: =over 4 =item B I Sets the type used to dispatch the values to the daemon. Detailed information about types and their configuration can be found in L. This option is mandatory. =item B I Type-instance to use. Defaults to the current map key or current string array element value. =back =head2 Plugin C The B uses B (L) and B (L) to retrieve XML data via cURL. Host "my_host" Instance "some_instance" User "collectd" Password "thaiNg0I" VerifyPeer true VerifyHost true CACert "/path/to/ca.crt" Type "magic_level" #InstancePrefix "prefix-" InstanceFrom "td[1]" ValuesFrom "td[2]/span[@class=\"level\"]" 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 options which specify the connection parameters, for example authentication information, and one or more B blocks. Each B block specifies how to get one type of information. The string argument must be a valid XPath expression which returns a list of "base elements". One value is dispatched for each "base element". The I and values are looked up using further I expressions that should be relative to the base element. Within the B block the following options are accepted: =over 4 =item B I Use I as the host name when submitting values. Defaults to the global host name setting. =item B I Use I as the plugin instance when submitting values. Defaults to an empty string (no plugin instance). =item B I =item B I =item B B|B =item B B|B =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. =item EB IE Within each B block, there must be one or more B blocks. Each B block specifies how to get one type of information. The string argument must be a valid XPath expression which returns a list of "base elements". One value is dispatched for each "base element". Within the B block the following options are accepted: =over 4 =item B I Specifies the I used for submitting patches. This determines the number of values that are required / expected and whether the strings are parsed as signed or unsigned integer or as double values. See L for details. This option is required. =item B I Prefix the I with I. The values are simply concatenated together without any separator. This option is optional. =item B I Specifies a XPath expression to use for determining the I. The XPath expression must return exactly one element. The element's value is then used as I, possibly prefixed with I (see above). This value is required. As a special exception, if the "base XPath expression" (the argument to the B block) returns exactly one argument, then this option may be omitted. =item B I [I ...] Specifies one or more XPath expression to use for reading the values. The number of XPath expressions must match the number of data sources in the I specified with B (see above). Each XPath expression must return exactly one element. The element's value is then parsed as a number and used as value for the appropriate value in the value list dispatched to the daemon. =back =back =head2 Plugin C This plugin uses the B library (L) to connect to various databases, execute I statements and read back the results. I is an acronym for "database interface" in case you were wondering about the name. You can configure how each column is to be interpreted and the plugin will generate one or more data sets from each row returned according to these rules. Because the plugin is very generic, the configuration is a little more complex than those of other plugins. It usually looks something like this: Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category" # Use with MySQL 5.0.0 or later MinVersion 50000 Type "gauge" InstancePrefix "out_of_stock" InstancesFrom "category" ValuesFrom "value" Driver "mysql" DriverOption "host" "localhost" DriverOption "username" "collectd" DriverOption "password" "aZo6daiw" DriverOption "dbname" "prod_info" SelectDB "prod_info" Query "out_of_stock" The configuration above defines one query with one result and one database. The query is then linked to the database with the B option I the BDatabaseE> block. You can have any number of queries and databases and you can also use the B statement to split up the configuration file in multiple, smaller files. However, the BQueryE> block I precede the BDatabaseE> blocks, because the file is interpreted from top to bottom! The following is a complete list of options: =head3 B blocks Query blocks define I statements and how the returned data should be interpreted. They are identified by the name that is given in the opening line of the block. Thus the name needs to be unique. Other than that, the name is not used in collectd. In each B block, there is one or more B blocks. B blocks define which column holds which value or instance information. You can use multiple B blocks to create multiple values from one returned row. This is especially useful, when queries take a long time and sending almost the same query again and again is not desirable. Example: Statement "select station, temperature, humidity from environment" Type "temperature" # InstancePrefix "foo" InstancesFrom "station" ValuesFrom "temperature" Type "humidity" InstancesFrom "station" ValuesFrom "humidity" The following options are accepted: =over 4 =item B I Sets the statement that should be executed on the server. This is B interpreted by collectd, but simply passed to the database server. Therefore, the SQL dialect that's used depends on the server collectd is connected to. The query has to return at least two columns, one for the instance and one value. You cannot omit the instance, even if the statement is guaranteed to always return exactly one line. In that case, you can usually specify something like this: Statement "SELECT \"instance\", COUNT(*) AS value FROM table" (That works with MySQL but may not be valid SQL according to the spec. If you use a more strict database server, you may have to select from a dummy table or something.) Please note that some databases, for example B, will fail if you include a semicolon at the end of the statement. =item B I =item B I Only use this query for the specified database version. You can use these options to provide multiple queries with the same name but with a slightly different syntax. The plugin will use only those queries, where the specified minimum and maximum versions fit the version of the database in use. The database version is determined by C, see the L for details. Basically, each part of the version is assumed to be in the range from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes "40102", version "5.0.42" becomes "50042". B The plugin will use B matching queries, so if you specify multiple queries with the same name and B ranges, weird stuff will happen. Don't to it! A valid example would be something along these lines: MinVersion 40000 MaxVersion 49999 ... MinVersion 50000 MaxVersion 50099 ... MinVersion 50100 # No maximum In the above example, there are three ranges that don't overlap. The last one goes from version "5.1.0" to infinity, meaning "all later versions". Versions before "4.0.0" are not specified. =item B I The B that's used for each line returned. See L for more details on how types are defined. In short: A type is a predefined layout of data and the number of values and type of values has to match the type definition. If you specify "temperature" here, you need exactly one gauge column. If you specify "if_octets", you will need two counter columns. See the B setting below. There must be exactly one B option inside each B block. =item B I Prepends I to the type instance. If B (see below) is not given, the string is simply copied. If B is given, I and all strings returned in the appropriate columns are concatenated together, separated by dashes I<("-")>. =item B I [I ...] Specifies the columns whose values will be used to create the "type-instance" for each row. If you specify more than one column, the value of all columns will be joined together with dashes I<("-")> as separation characters. The plugin itself does not check whether or not all built instances are different. It's your responsibility to assure that each is unique. This is especially true, if you do not specify B: B have to make sure that only one row is returned in this case. If neither B nor B is given, the type-instance will be empty. =item B I [I ...] Names the columns whose content is used as the actual data for the data sets that are dispatched to the daemon. How many such columns you need is determined by the B setting above. If you specify too many or not enough columns, the plugin will complain about that and no data will be submitted to the daemon. The actual data type in the columns is not that important. The plugin will automatically cast the values to the right type if it know how to do that. So it should be able to handle integer an floating point types, as well as strings (if they include a number at the beginning). There must be at least one B option inside each B block. =back =head3 B blocks Database blocks define a connection to a database and which queries should be sent to that database. Since the used "dbi" library can handle a wide variety of databases, the configuration is very generic. If in doubt, refer to libdbi's documentationE- we stick as close to the terminology used there. Each database needs a "name" as string argument in the starting tag of the block. This name will be used as "PluginInstance" in the values submitted to the daemon. Other than that, that name is not used. =over 4 =item B I Specifies the driver to use to connect to the database. In many cases those drivers are named after the database they can connect to, but this is not a technical necessity. These drivers are sometimes referred to as "DBD", BataBase Briver, and some distributions ship them in separate packages. Drivers for the "dbi" library are developed by the B project at L. You need to give the driver name as expected by the "dbi" library here. You should be able to find that in the documentation for each driver. If you mistype the driver name, the plugin will dump a list of all known driver names to the log. =item B I I Sets driver-specific options. What option a driver supports can be found in the documentation for each driver, somewhere at L. However, the options "host", "username", "password", and "dbname" seem to be deEfacto standards. Unfortunately, drivers are not too keen to report errors when an unknown option is passed to them, so invalid settings here may go unnoticed. This is not the plugin's fault, it will report errors if it gets them from the libraryE/ the driver. If a driver complains about an option, the plugin will dump a complete list of all options understood by that driver to the log. =item B I In some cases, the database name you connect with is not the database name you want to use for querying data. If this option is set, the plugin will "select" (switch to) that database after the connection is established. =item B I Associates the query named I with this database connection. The query needs to be defined I this statement, i.Ee. all query blocks you want to refer to must be placed above the database block you want to refer to them from. =back =head2 Plugin C =over 4 =item B I Select partitions based on the devicename. =item B I Select partitions based on the mountpoint. =item B I Select partitions based on the filesystem type. =item B B|B Invert the selection: If set to true, all partitions B the ones that match any one of the criteria are collected. By default only selected partitions are collected if a selection is made. If no selection is configured at all, B partitions are selected. =item B B|B Report using the device name rather than the mountpoint. i.e. with this I, (the default), it will report a disk as "root", but with it I, it will be "sda1" (or whichever). =item B B|B Enables or disables reporting of free, reserved and used inodes. Defaults to inode collection being disabled. 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. =back =head2 Plugin C The C plugin collects information about the usage of physical disks and logical disks (partitions). Values collected are the number of octets written to and read from a disk or partition, the number of read/write operations issued to the disk and a rather complex "time" it took for these commands to be issued. Using the following two options you can ignore some disks or configure the collection only of specific disks. =over 4 =item B I Select the disk I. Whether it is collected or ignored depends on the B setting, see below. As with other plugins that use the daemon's ignorelist functionality, a string that starts and ends with a slash is interpreted as a regular expression. Examples: Disk "sdd" Disk "/hda[34]/" =item B B|B Sets whether selected disks, i.Ee. the ones matches by any of the B statements, are ignored or if all other disks are ignored. The behavior (hopefully) is intuitive: If no B option is configured, all disks are collected. If at least one B option is given and no B or set to B, B matching disks will be collected. If B is set to B, all disks are collected B the ones matched. =back =head2 Plugin C =over 4 =item B I The dns plugin uses B to capture dns traffic and analyzes it. This option sets the interface that should be used. If this option is not set, or set to "any", the plugin will try to get packets from B interfaces. This may not work on certain platforms, such as MacEOSEX. =item B I Ignore packets that originate from this address. =item B B|B Enabled by default, collects unknown (and thus presented as numeric only) query types. =back =head2 Plugin C =over 4 =item B I Sets the socket-file which is to be created. =item B I If running as root change the group of the UNIX-socket after it has been created. Defaults to B. =item B I 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 I Sets the maximum number of connections that can be handled in parallel. Since this many threads will be started immediately setting this to a very high value will waste valuable resources. Defaults to B<5> and will be forced to be at most B<16384> to prevent typos and dumb mistakes. =back =head2 Plugin C Please make sure to read L before using this plugin. It contains valuable information on when the executable is executed and the output that is expected from it. =over 4 =item B I[:[I]] I [IargE> [IargE> ...]] =item B I[:[I]] I [IargE> [IargE> ...]] Execute the executable I as user I. If the user name is followed by a colon and a group name, the effective group is set to that group. The real group and saved-set group will be set to the default group of that user. If no group is given the effective group ID will be the same as the real group ID. Please note that in order to change the user and/or group the daemon needs superuser privileges. If the daemon is run as an unprivileged user you must specify the same user/group here. If the daemon is run with superuser privileges, you must supply a non-root user here. The executable may be followed by optional arguments that are passed to the program. Please note that due to the configuration parsing numbers and boolean values may be changed. If you want to be absolutely sure that something is passed as-is please enclose it in quotes. The B and B statements change the semantics of the programs executed, i.Ee. the data passed to them and the response expected from them. This is documented in great detail in L. =back =head2 Plugin C The C plugin counts the number of files in a certain directory (and its subdirectories) and their combined size. The configuration is very straight forward: Instance "qmail-message" Instance "qmail-todo" Instance "php5-sessions" Name "sess_*" The example above counts the number of files in QMail's queue directories and the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that QMail has not yet looked at, the "message" queue holds the messages that were classified into "local" and "remote". As you can see, the configuration consists of one or more C blocks, each of which specifies a directory in which to count the files. Within those blocks, the following options are recognized: =over 4 =item B I Sets the plugin instance to I. That instance name must be unique, but it's your responsibility, the plugin doesn't check for that. If not given, the instance is set to the directory name with all slashes replaced by underscores and all leading underscores removed. =item B I Only count files that match I, where I is a shell-like wildcard as understood by L. Only the B is checked against the pattern, not the entire path. In case this makes it easier for you: This option has been named after the B<-name> parameter to L. =item B I Count only files of a specific age: If I is greater than zero, only files that haven't been touched in the last I seconds are counted. If I is a negative number, this is inversed. For example, if B<-60> is specified, only files that have been modified in the last minute will be counted. The number can also be followed by a "multiplier" to easily specify a larger timespan. When given in this notation, the argument must in quoted, i.Ee. must be passed as string. So the B<-60> could also be written as B<"-1m"> (one minute). Valid multipliers are C (second), C (minute), C (hour), C (day), C (week), and C (year). There is no "month" multiplier. You can also specify fractional numbers, e.Eg. B<"0.5d"> is identical to B<"12h">. =item B I Count only files of a specific size. When I is a positive number, only files that are at least this big are counted. If I is a negative number, this is inversed, i.Ee. only files smaller than the absolute value of I are counted. As with the B option, a "multiplier" may be added. For a detailed description see above. Valid multipliers here are C (byte), C (kilobyte), C (megabyte), C (gigabyte), C (terabyte), and C

(petabyte). Please note that there are 1000 bytes in a kilobyte, not 1024. =item B I|I Controls whether or not to recurse into subdirectories. Enabled by default. =item B I|I Controls whether or not to include "hidden" files and directories in the count. "Hidden" files and directories are those, whose name begins with a dot. Defaults to I, i.e. by default hidden files and directories are ignored. =back =head2 Plugin C The I is written in I and therefore documented in L. =head2 Plugin C The I plugin received the multicast traffic sent by B, the statistics collection daemon of Ganglia. Mappings for the standard "metrics" are built-in, custom mappings may be added via B blocks, see below. Synopsis: MCReceiveFrom "239.2.11.71" "8649" Type "swap" TypeInstance "total" DataSource "value" Type "swap" TypeInstance "free" DataSource "value" The following metrics are built-in: =over 4 =item * load_one, load_five, load_fifteen =item * cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio =item * mem_free, mem_shared, mem_buffers, mem_cached, mem_total =item * bytes_in, bytes_out =item * pkts_in, pkts_out =back Available configuration options: =over 4 =item B I [I] Sets sets the multicast group and UDP port to which to subscribe. Default: B<239.2.11.71>E/EB<8649> =item EB IE These blocks add a new metric conversion to the internal table. I, the string argument to the B block, is the metric name as used by Ganglia. =over 4 =item B I Type to map this metric to. Required. =item B I Type-instance to use. Optional. =item B I Data source to map this metric to. If the configured type has exactly one data source, this is optional. Otherwise the option is required. =back =back =head2 Plugin C To get values from B collectd connects to B (127.0.0.1), port B<7634/tcp>. The B and B options can be used to change these default values, see below. C has to be running to work correctly. If C is not running timeouts may appear which may interfere with other statistics.. The B homepage can be found at L. =over 4 =item B I Hostname to connect to. Defaults to B<127.0.0.1>. =item B I TCP-Port to connect to. Defaults to B<7634>. =back =head2 Plugin C =over 4 =item B I Select this interface. By default these interfaces will then be collected. For a more detailed description see B below. =item B I|I If no configuration if given, the B-plugin will collect data from all interfaces. This may not be practical, especially for loopback- and similar interfaces. Thus, you can use the B-option to pick the interfaces you're interested in. Sometimes, however, it's easier/preferred to collect all interfaces I a few ones. This option enables you to do that: By setting B to I the effect of B is inverted: All selected interfaces are ignored and all other interfaces are collected. =back =head2 Plugin C =over 4 =item B I Selects sensors to collect or to ignore, depending on B. =item B I|I If no configuration if given, the B plugin will collect data from all sensors found of type "temperature", "voltage", "current" and "fanspeed". This option enables you to do that: By setting B to I the effect of B is inverted: All selected sensors are ignored and all other sensors are collected. =item B I|I If a sensor appears after initialization time of a minute a notification is sent. =item B I|I If a sensor disappears a notification is sent. =item B I|I If you have for example dual power supply and one of them is (un)plugged then a notification is sent. =back =head2 Plugin C =over 4 =item B I I [I [I]] Select the rules to count. If only I
and I are given, this plugin will collect the counters of all rules which have a comment-match. The comment is then used as type-instance. If I or I is given, only the rule with the matching comment or the Ith rule will be collected. Again, the comment (or the number) will be used as the type-instance. If I is supplied, it will be used as the type-instance instead of the comment or the number. =back =head2 Plugin C =over 4 =item B I Select this irq. By default these irqs will then be collected. For a more detailed description see B below. =item B I|I If no configuration if given, the B-plugin will collect data from all irqs. This may not be practical, especially if no interrupts happen. Thus, you can use the B-option to pick the interrupt you're interested in. Sometimes, however, it's easier/preferred to collect all interrupts I a few ones. This option enables you to do that: By setting B to I the effect of B is inverted: All selected interrupts are ignored and all other interrupts are collected. =back =head2 Plugin C The I plugin makes it possible to write extensions for collectd in Java. This section only discusses the syntax and semantic of the configuration options. For more in-depth information on the I plugin, please read L. Synopsis: JVMArg "-verbose:jni" JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java" LoadPlugin "org.collectd.java.Foobar" # To be parsed by the plugin Available configuration options: =over 4 =item B I Argument that is to be passed to the I (JVM). This works exactly the way the arguments to the I binary on the command line work. Execute C--help> for details. Please note that B these options must appear B (i.Ee. above) any other options! When another option is found, the JVM will be started and later options will have to be ignored! =item B I Instantiates a new I object. The constructor of this object very likely then registers one or more callback methods with the server. See L for details. When the first such option is found, the virtual machine (JVM) is created. This means that all B options must appear before (i.Ee. above) all B options! =item B I The entire block is passed to the Java plugin as an I object. For this to work, the plugin has to register a configuration callback first, see L. This means, that the B block must appear after the appropriate B block. Also note, that I depends on the (Java) plugin registering the callback and is completely independent from the I argument passed to B. =back =head2 Plugin C This plugin allows CPU, disk and network load to be collected for virtualized guests on the machine. This means that these characteristics can be collected for guest systems without installing any software on them - collectd only runs on the hosting system. The statistics are collected through libvirt (L). Only I is required. =over 4 =item B I Connect to the hypervisor given by I. For example if using Xen use: Connection "xen:///" Details which URIs allowed are given at L. =item B I Refresh the list of domains and devices every I. The default is 60 seconds. Setting this to be the same or smaller than the I will cause the list of domains and devices to be refreshed on every iteration. Refreshing the devices in particular is quite a costly operation, so if your virtualization setup is static you might consider increasing this. If this option is set to 0, refreshing is disabled completely. =item B I =item B I =item B I =item B I|I Select which domains and devices are collected. If I is not given or I then only the listed domains and disk/network devices are collected. If I is I then the test is reversed and the listed domains and disk/network devices are ignored, while the rest are collected. The domain name and device names may use a regular expression, if the name is surrounded by I and collectd was compiled with support for regexps. The default is to collect statistics for all domains and all their devices. Example: BlockDevice "/:hdb/" IgnoreSelected "true" Ignore all I devices on any domain, but other block devices (eg. I) will be collected. =item B B When the libvirt plugin logs data, it sets the hostname of the collected data according to this setting. The default is to use the guest name as provided by the hypervisor, which is equal to setting B. B means use the guest's UUID. This is useful if you want to track the same guest across migrations. B means to use the global B setting, which is probably not useful on its own because all guests will appear to have the same name. You can also specify combinations of these fields. For example B means to concatenate the guest name and UUID (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">). =item B B|B
When the libvirt plugin logs interface data, it sets the name of the collected data according to this setting. The default is to use the path as provided by the hypervisor (the "dev" property of the target node), which is equal to setting B. B
means use the interface's mac address. This is useful since the interface path might change between reboots of a guest or across migrations. =back =head2 Plugin C =over 4 =item B B Sets the log-level. If, for example, set to B, then all events with severity B, B, or B will be written to the logfile. Please note that B is only available if collectd has been compiled with debugging support. =item B I 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 I is running in foreground- or non-daemon-mode. =item B B|B Prefix all lines printed by the current time. Defaults to B. =item B B|B When enabled, all lines are prefixed by the severity of the log message, for example "warning". Defaults to B. =back 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. Be default collectd connects to B (127.0.0.1), port B<411/tcp>. The B and B options can be used to change these values, see below. C has to be running to work correctly. If C is not running timeouts may appear which may interfere with other statistics.. C must be run with the -r option ("print TAG and Value format"); Debian's F script already does this, other people will need to ensure that this is the case. =over 4 =item B I Hostname to connect to. Defaults to B<127.0.0.1>. =item B I TCP-Port to connect to. Defaults to B<411>. =back =head2 Plugin C The C connects to a memcached server, queries one or more given I and parses the returned data according to user specification. The I used are the same as the matches used in the C and C plugins. In order to talk to the memcached server, this plugin uses the I library. Please note that there is another library with a very similar name, libmemcache (notice the missing `d'), which is not applicable. Synopsis of the configuration: Server "localhost" Key "page_key" Regex "(\\d+) bytes sent" DSType CounterAdd Type "ipt_octets" Instance "type_instance" The configuration options are: =over 4 =item EB IE Each B block defines one I to be queried from the memcached server. The block requires one string argument which is used as I. =item B I
Sets the server address to connect to when querying the page. Must be inside a B block. =item B I When connected to the memcached server, asks for the page I. =item EBE Match blocks define which strings to look for and how matches substrings are interpreted. For a description of match blocks, please see L<"Plugin tail">. =back =head2 Plugin C The C connects to a memcached server and queries statistics about cache utilization, memory and bandwidth used. L =over 4 =item B I Hostname to connect to. Defaults to B<127.0.0.1>. =item B I TCP-Port to connect to. Defaults to B<11211>. =back =head2 Plugin C The B connects to a Modbus "slave" via Modbus/TCP and reads 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: RegisterBase 0 RegisterType float Type voltage Instance "input-1" RegisterBase 2 RegisterType float Type voltage Instance "input-2" Address "192.168.0.42" Port "502" Interval 60 Instance "power-supply" Collect "voltage-input-1" Collect "voltage-input-2" =over 4 =item EB IE blocks Data blocks define a mapping between register numbers and the "types" used by I. Within EDataE/E blocks, the following options are allowed: =over 4 =item B I 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 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. =item B I Specifies the "type" (data set) to use when dispatching the value to I. Currently, only data sets with exactly one data source are supported. =item B I Sets the type instance to use when dispatching the value to I. If unset, an empty string (no type instance) is used. =back =item EB IE blocks Host blocks are used to specify to which hosts to connect and what data to read from their "slaves". The string argument I is used as hostname when dispatching the values to I. Within EHostE/E blocks, the following options are allowed: =over 4 =item B
I Specifies the node name (the actual network address) used to connect to the host. This may be an IP address or a hostname. Please note that the used I library only supports IPv4 at the moment. =item B I Specifies the port used to connect to the host. The port can either be given as a number or as a service name. Please note that the I argument must be a string, even if ports are given in their numerical form. Defaults to "502". =item B I Sets the interval (in seconds) in which the values will be collected from this host. By default the global B setting will be used. =item EB IE Over each TCP connection, multiple Modbus devices may be reached. The slave ID is used to specify which device should be addressed. For each device you want to query, one B block must be given. Within ESlaveE/E blocks, the following options are allowed: =over 4 =item B I Specify the plugin instance to use when dispatching the values to I. By default "slave_I" is used. =item B I Specifies which data to retrieve from the device. I must be the same string as the I argument passed to a B block. You can specify this option multiple times to collect more than one value from a slave. At least one B option is mandatory. =back =back =back =head2 Plugin C The C requires B to be installed. It connects to one or more databases when started and keeps the connection up as long as possible. When the connection is interrupted for whatever reason it will try to re-connect. The plugin will complain loudly in case anything goes wrong. This plugin issues the MySQL C / C command and collects information about MySQL network traffic, executed statements, requests, the query cache and threads by evaluating the C, C, C, C and C return values. Please refer to the B, I<5.1.6. Server Status Variables> for an explanation of these values. Optionally, master and slave statistics may be collected in a MySQL replication setup. In that case, information about the synchronization state of the nodes are collected by evaluating the C return value of the C command and the C, C and C return values of the C command. See the B, I<12.5.5.21 SHOW MASTER STATUS Syntax> and I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details. Synopsis: Host "hostname" User "username" Password "password" Port "3306" MasterStats true Host "localhost" Socket "/var/run/mysql/mysqld.sock" SlaveStats true SlaveNotifications true A B block defines one connection to a MySQL database. It accepts a single argument which specifies the name of the database. None of the other options are required. MySQL will use default values as documented in the section "mysql_real_connect()" in the B. =over 4 =item B I 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. =item B I Password needed to log into the database. =item B I Select this database. Defaults to I which is a perfectly reasonable option for what this plugin does. =item B I TCP-port to connect to. The port must be specified in its numeric form, but it must be passed as a string nonetheless. For example: Port "3306" If B is set to B (the default), this setting has no effect. See the documentation for the C function for details. =item B I Specifies the path to the UNIX domain socket of the MySQL server. This option only has any effect, if B is set to B (the default). Otherwise, use the B option above. See the documentation for the C function for details. =item B I =item B I Enable the collection of master / slave statistics in a replication setup. =item B I If enabled, the plugin sends a notification if the replication slave I/O and / or SQL threads are not running. =back =head2 Plugin C The netapp plugin can collect various performance and capacity information from a NetApp filer using the NetApp API. Please note that NetApp has a wide line of products and a lot of different software versions for each of these products. This plugin was developed for a NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1, FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I work for most combinations of model and software version but it is very hard to test this. If you have used this plugin with other models and/or software version, feel free to send us a mail to tell us about the results, even if it's just a short "It works". To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP basic authentication. B Create a special collectd user with just the minimum of capabilities needed. The user only needs the "login-http-admin" capability as well as a few more depending on which data will be collected. Required capabilities are documented below. =head3 Synopsis Protocol "https" Address "10.0.0.1" Port 443 User "username" Password "aef4Aebe" Interval 30 Interval 30 GetNameCache true GetDirCache true GetBufferCache true GetInodeCache true Interval 30 GetBusy true Interval 30 GetIO "volume0" IgnoreSelectedIO false GetOps "volume0" IgnoreSelectedOps false GetLatency "volume0" IgnoreSelectedLatency false Interval 30 GetCapacity "vol0" GetCapacity "vol1" IgnoreSelectedCapacity false GetSnapshot "vol1" GetSnapshot "vol3" IgnoreSelectedSnapshot false Interval 30 GetCPULoad true GetInterfaces true GetDiskOps true GetDiskIO true The netapp plugin accepts the following configuration options: =over 4 =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. =item B B|B The protocol collectd will use to query this host. Optional Type: string Default: https Valid options: http, https =item B
I
The hostname or IP address of the host. Optional Type: string Default: The "host" block's name. =item B I The TCP port to connect to on the host. Optional Type: integer Default: 80 for protocol "http", 443 for protocol "https" =item B I =item B I The username and password to use to login to the NetApp. Mandatory Type: string =item B I B =back The following options decide what kind of data will be collected. You can either use them as a block and fine tune various parameters inside this block, use them as a single statement to just accept all default values, or omit it to not collect any data. The following options are valid inside all blocks: =over 4 =item B I Collect the respective statistics every I seconds. Defaults to the host specific setting. =back =head3 The System block This will collect various performance data about the whole system. B To get this data the collectd user needs the "api-perf-object-get-instances" capability. =over 4 =item B I Collect disk statistics every I seconds. =item B B|B If you set this option to true the current CPU usage will be read. This will be the average usage between all CPUs in your NetApp without any information about individual CPUs. B These are the same values that the NetApp CLI command "sysstat" returns in the "CPU" field. Optional Type: boolean Default: true Result: Two value lists of type "cpu", and type instances "idle" and "system". =item B B|B If you set this option to true the current traffic of the network interfaces will be read. This will be the total traffic over all interfaces of your NetApp without any information about individual interfaces. B This is the same values that the NetApp CLI command "sysstat" returns in the "Net kB/s" field. B Optional Type: boolean Default: true Result: One value list of type "if_octects". =item B B|B If you set this option to true the current IO throughput will be read. This will be the total IO of your NetApp without any information about individual disks, volumes or aggregates. B This is the same values that the NetApp CLI command "sysstat" returns in the "DiskEkB/s" field. Optional Type: boolean Default: true Result: One value list of type "disk_octets". =item B B|B If you set this option to true the current number of HTTP, NFS, CIFS, FCP, iSCSI, etc. operations will be read. This will be the total number of operations on your NetApp without any information about individual volumes or aggregates. B These are the same values that the NetApp CLI command "sysstat" returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields. Optional Type: boolean Default: true Result: A variable number of value lists of type "disk_ops_complex". Each type of operation will result in one value list with the name of the operation as type instance. =back =head3 The WAFL block This will collect various performance data about the WAFL file system. At the moment this just means cache performance. B To get this data the collectd user needs the "api-perf-object-get-instances" capability. B The interface to get these values is classified as "Diagnostics" by NetApp. This means that it is not guaranteed to be stable even between minor releases. =over 4 =item B I Collect disk statistics every I seconds. =item B B|B Optional Type: boolean Default: true Result: One value list of type "cache_ratio" and type instance "name_cache_hit". =item B B|B Optional Type: boolean Default: true Result: One value list of type "cache_ratio" and type instance "find_dir_hit". =item B B|B Optional Type: boolean Default: true Result: One value list of type "cache_ratio" and type instance "inode_cache_hit". =item B B|B B This is the same value that the NetApp CLI command "sysstat" returns in the "Cache hit" field. Optional Type: boolean Default: true Result: One value list of type "cache_ratio" and type instance "buf_hash_hit". =back =head3 The Disks block This will collect performance data about the individual disks in the NetApp. B To get this data the collectd user needs the "api-perf-object-get-instances" capability. =over 4 =item B I Collect disk statistics every I seconds. =item B B|B If you set this option to true the busy time of all disks will be calculated and the value of the busiest disk in the system will be written. B This is the same values that the NetApp CLI command "sysstat" returns in the "Disk util" field. Probably. Optional Type: boolean Default: true Result: One value list of type "percent" and type instance "disk_busy". =back =head3 The VolumePerf block This will collect various performance data about the individual volumes. You can select which data to collect about which volume using the following options. They follow the standard ignorelist semantic. B To get this data the collectd user needs the I capability. =over 4 =item B I Collect volume performance data every I seconds. =item B I =item B I =item B I Select the given volume for IO, operations or latency statistics collection. The argument is the name of the volume without the C prefix. Since the standard ignorelist functionality is used here, you can use a string starting and ending with a slash to specify regular expression matching: To match the volumes "vol0", "vol2" and "vol7", you can use this regular expression: GetIO "/^vol[027]$/" If no regular expression is specified, an exact match is required. Both, regular and exact matching are case sensitive. If no volume was specified at all for either of the three options, that data will be collected for all available volumes. =item B B|B =item B B|B =item B B|B When set to B, the volumes selected for IO, operations or latency statistics collection will be ignored and the data will be collected for all other volumes. When set to B, data will only be collected for the specified volumes and all other volumes will be ignored. If no volumes have been specified with the above B options, all volumes will be collected regardless of the B option. Defaults to B =back =head3 The VolumeUsage block This will collect capacity data about the individual volumes. B To get this data the collectd user needs the I capability. =over 4 =item B I Collect volume usage statistics every I seconds. =item B I The current capacity of the volume will be collected. This will result in two to four value lists, depending on the configuration of the volume. All data sources are of type "df_complex" with the name of the volume as plugin_instance. There will be type_instances "used" and "free" for the number of used and available bytes on the volume. If the volume has some space reserved for snapshots, a type_instance "snap_reserved" will be available. If the volume has SIS enabled, a type_instance "sis_saved" will be available. This is the number of bytes saved by the SIS feature. B The current NetApp API has a bug that results in this value being reported as a 32Ebit number. This plugin tries to guess the correct number which works most of the time. If you see strange values here, bug NetApp support to fix this. Repeat this option to specify multiple volumes. =item B B|B Specify whether to collect only the volumes selected by the B option or to ignore those volumes. B defaults to B. However, if no B option is specified at all, all capacities will be selected anyway. =item B I Select volumes from which to collect snapshot information. Usually, the space used for snapshots is included in the space reported as "used". If snapshot information is collected as well, the space used for snapshots is subtracted from the used space. To make things even more interesting, it is possible to reserve space to be used for snapshots. If the space required for snapshots is less than that reserved space, there is "reserved free" and "reserved used" space in addition to "free" and "used". If the space required for snapshots exceeds the reserved space, that part allocated in the normal space is subtracted from the "used" space again. Repeat this option to specify multiple volumes. =item B Specify whether to collect only the volumes selected by the B option or to ignore those volumes. B defaults to B. However, if no B option is specified at all, all capacities will be selected anyway. =back =head2 Plugin C The C plugin uses a netlink socket to query the Linux kernel about statistics of various interface and routing aspects. =over 4 =item B I =item B I Instruct the plugin to collect interface statistics. This is basically the same as the statistics provided by the C plugin (see above) but potentially much more detailed. When configuring with B only the basic statistics will be collected, namely octets, packets, and errors. These statistics are collected by the C plugin, too, so using both at the same time is no benefit. When configured with B all counters B the basic ones, so that no data needs to be collected twice if you use the C plugin. This includes dropped packets, received multicast packets, collisions and a whole zoo of differentiated RX and TX errors. You can try the following command to get an idea of what awaits you: ip -s -s link list If I is B, all interfaces will be selected. =item B I [I] =item B I [I] =item B I [I] Collect the octets and packets that pass a certain qdisc, class or filter. QDiscs and classes are identified by their type and handle (or classid). Filters don't necessarily have a handle, therefore the parent's handle is used. The notation used in collectd differs from that used in tc(1) in that it doesn't skip the major or minor number if it's zero and doesn't print special ids by their name. So, for example, a qdisc may be identified by C even though the minor number of B qdiscs is zero and thus not displayed by tc(1). If B, B, or B is given without the second argument, i.E.e. without an identifier, all qdiscs, classes, or filters that are associated with that interface will be collected. Since a filter itself doesn't necessarily have a handle, the parent's handle is used. This may lead to problems when more than one filter is attached to a qdisc or class. This isn't nice, but we don't know how this could be done any better. If you have a idea, please don't hesitate to tell us. As with the B option you can specify B as the interface, meaning all interfaces. Here are some examples to help you understand the above text more easily: VerboseInterface "All" QDisc "eth0" "pfifo_fast-1:0" QDisc "ppp0" Class "ppp0" "htb-1:10" Filter "ppp0" "u32-1:0" =item B The behavior is the same as with all other similar plugins: If nothing is selected at all, everything is collected. If some things are selected using the options described above, only these statistics are collected. If you set B to B, this behavior is inverted, i.Ee. the specified statistics will not be collected. =back =head2 Plugin C The Network plugin sends data to a remote instance of collectd, receives data from a remote instance, or both at the same time. Data which has been received from the network is usually not transmitted again, but this can be activated, see the B option below. 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: Server "collectd.internal.tld" SecurityLevel "sign" Username "myhostname" Password "ohl0eQue" =over 4 =item BServer> I [I]B> The B statement/block sets the server to send datagrams to. The statement may occur multiple times to send each datagram to multiple destinations. The argument I may be a hostname, an IPv4 address or an IPv6 address. The optional second argument specifies a port number or a service name. If not given, the default, B<25826>, is used. The following options are recognized within B blocks: =over 4 =item B B|B|B Set the security you require for network communication. When the security level has been set to B, data sent over the network will be encrypted using I. The integrity of encrypted packets is ensured using I. When set to B, transmitted data is signed using the I message authentication code. When set to B, data is sent without any security. This feature is only available if the I plugin was linked with I. =item B I Sets the username to transmit. This is used by the server to lookup the password. See B below. All security levels except B require this setting. This feature is only available if the I plugin was linked with I. =item B I Sets a password (shared secret) for this socket. All security levels except B require this setting. This feature is only available if the I plugin was linked with I. =item B I Set the outgoing interface for IP packets. This applies at least to IPv6 packets and if possible to IPv4. If this option is not applicable, undefined or a non-existent interface name is specified, the default behavior is to let the kernel choose the appropriate interface. Be warned that the manual selection of an interface for unicast traffic is only necessary in rare cases. =back =item BListen> I [I]B> The B statement sets the interfaces to bind to. When multiple statements are found the daemon will bind to multiple interfaces. The argument I may be a hostname, an IPv4 address or an IPv6 address. If the argument is a multicast address the daemon will join that multicast group. The optional second argument specifies a port number or a service name. If not given, the default, B<25826>, is used. The following options are recognized within CListenE> blocks: =over 4 =item B B|B|B Set the security you require for network communication. When the security level has been set to B, only encrypted data will be accepted. The integrity of encrypted packets is ensured using I. When set to B, only signed and encrypted data is accepted. When set to B, all data will be accepted. If an B option was given (see below), encrypted data is decrypted if possible. This feature is only available if the I plugin was linked with I. =item B I Sets a file in which usernames are mapped to passwords. These passwords are used to verify signatures and to decrypt encrypted network packets. If B is set to B, this is optional. If given, signed data is verified and encrypted packets are decrypted. Otherwise, signed data is accepted without checking the signature and encrypted data cannot be decrypted. For the other security levels this option is mandatory. The file format is very simple: Each line consists of a username followed by a colon and any number of spaces followed by the password. To demonstrate, an example file could look like this: user0: foo user1: bar Each time a packet is received, the modification time of the file is checked using L. If the file has been changed, the contents is re-read. While the file is being read, it is locked using L. =item B I Set the incoming interface for IP packets explicitly. This applies at least to IPv6 packets and if possible to IPv4. If this option is not applicable, undefined or a non-existent interface name is specified, the default behavior is, to let the kernel choose the appropriate interface. Thus incoming traffic gets only accepted, if it arrives on the given interface. =back =item B I<1-255> Set the time-to-live of sent packets. This applies to all, unicast and multicast, and IPv4 and IPv6 packets. The default is to not change this value. That means that multicast packets will be sent with a TTL of C<1> (one) on most 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. =item B I If set to I, write packets that were received via the network plugin to the sending sockets. This should only be activated when the B- and B-statements differ. Otherwise packets may be send multiple times to the same multicast group. While this results in more network traffic than necessary it's not a huge problem since the plugin has a duplicate detection, so the values will not loop. =item B B|B The network plugin cannot only receive and send statistics, it can also create statistics about itself. Collected data included the number of received and sent octets and packets, the length of the receive queue and the number of values handled. When set to B, the I will make these statistics available. Defaults to B. =back =head2 Plugin C This plugin collects the number of connections and requests handled by the C (speak: engineEX), a HTTP and mail server/proxy. It queries the page provided by the C module, which isn't compiled by default. Please refer to L for more information on how to compile and configure nginx and this module. The following options are accepted by the C: =over 4 =item B I Sets the URL of the C output. =item B I Optional user name needed for authentication. =item B I Optional password needed for authentication. =item B B Enable or disable peer SSL certificate verification. See L for details. Enabled by default. =item 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 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. =back =head2 Plugin C 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. The Desktop Notification Specification can be found at L. =over 4 =item B I =item B I =item B I Set the I, in milliseconds, after which to expire the notification for C, C and C severities respectively. If zero has been specified, the displayed notification will not be closed at all - the user has to do so herself. These options default to 5000. If a negative number has been specified, the default is used as well. =back =head2 Plugin C The I plugin uses the I library to send notifications to a configured email address. I is available from L. Available configuration options: =over 4 =item B I
Email address from which the emails should appear to come from. Default: C =item B I
Configures the email address(es) to which the notifications should be mailed. May be repeated to send notifications to multiple addresses. At least one B must be present for the plugin to work correctly. =item B I Hostname of the SMTP server to connect to. Default: C =item B I TCP port to connect to. Default: C<25> =item B I Username for ASMTP authentication. Optional. =item B I Password for ASMTP authentication. Optional. =item B I Subject-template to use when sending emails. There must be exactly two string-placeholders in the subject, given in the standard I syntax, i.Ee. C<%s>. The first will be replaced with the severity, the second with the hostname. Default: C =back =head2 Plugin C =over 4 =item B I Hostname of the host running B. Defaults to B. =item B I UDP-Port to connect to. Defaults to B<123>. =item B B|B Sets whether or not to perform reverse lookups on peers. Since the name or IP-address may be used in a filename it is recommended to disable reverse lookups. The default is to do reverse lookups to preserve backwards compatibility, though. =back =head2 Plugin C =over 4 =item B IB<@>I[B<:>I] Add a UPS to collect data from. The format is identical to the one accepted by L. =back =head2 Plugin C The I plugin connects to the TCP port opened by the I plugin of the Optimized Link State Routing daemon and reads information about the current state of the meshed network. The following configuration options are understood: =over 4 =item B I Connect to I. Defaults to B<"localhost">. =item B I Specifies the port to connect to. This must be a string, even if you give the port as a number rather than a service name. Defaults to B<"2006">. =item B B|B|B Specifies what information to collect about links, i.Ee. direct connections of the daemon queried. If set to B, no information is collected. If set to B, the number of links and the average of all I (LQ) and I (NLQ) values is calculated. If set to B LQ and NLQ are collected per link. Defaults to B. =item B B|B|B Specifies what information to collect about routes of the daemon queried. If set to B, no information is collected. If set to B, the number of routes and the average I and I is calculated. If set to B metric and ETX are collected per route. Defaults to B. =item B B|B|B Specifies what information to collect about the global topology. If set to B, no information is collected. If set to B, the number of links in the entire topology and the average I (LQ) is calculated. If set to B LQ and NLQ are collected for each link in the entire topology. Defaults to B. =back =head2 Plugin C B See notes below. The C plugin uses the B library from the B project L to read sensors connected via the onewire bus. Currently only temperature sensors (sensors with the family code C<10>, e.Eg. DS1820, DS18S20, DS1920) can be read. If you have other sensors you would like to have included, please send a sort request to the mailing list. Hubs (the DS2409 chips) are working, but read the note, why this plugin is experimental, below. =over 4 =item B I Sets the device to read the values from. This can either be a "real" hardware device, such as a serial port or an USB port, or the address of the L socket, usually B. Though the documentation claims to automatically recognize the given address format, with versionE2.7p4 we had to specify the type explicitly. So with that version, the following configuration worked for us: Device "-s localhost:4304" This directive is B and does not have a default value. =item B I Selects sensors to collect or to ignore, depending on B, see below. Sensors are specified without the family byte at the beginning, to you'd use C, and B include the leading C<10.> family byte and point. =item B I|I If no configuration if given, the B plugin will collect data from all sensors found. This may not be practical, especially if sensors are added and removed regularly. Sometimes, however, it's easier/preferred to collect only specific sensors or all sensors I a few specified ones. This option enables you to do that: By setting B to I the effect of B is inverted: All selected interfaces are ignored and all other interfaces are collected. =item B I Sets the interval in which all sensors should be read. If not specified, the global B setting is used. =back B The C plugin is experimental, because it doesn't yet work with big setups. It works with one sensor being attached to one controller, but as soon as you throw in a couple more senors and maybe a hub or two, reading all values will take more than ten seconds (the default interval). We will probably add some separate thread for reading the sensors and some cache or something like that, but it's not done yet. We will try to maintain backwards compatibility in the future, but we can't promise. So in short: If it works for you: Great! But keep in mind that the config I change, though this is unlikely. Oh, and if you want to help improving this plugin, just send a short notice to the mailing list. ThanksE:) =head2 Plugin C The OpenVPN plugin reads a status file maintained by OpenVPN and gathers traffic statistics about connected clients. To set up OpenVPN to write to the status file periodically, use the B<--status> option of OpenVPN. Since OpenVPN can write two different formats, you need to set the required format, too. This is done by setting B<--status-version> to B<2>. So, in a nutshell you need: openvpn $OTHER_OPTIONS \ --status "/var/run/openvpn-status" 10 \ --status-version 2 Available options: =over 4 =item B I Specifies the location of the status file. =item B B|B When enabled, the filename of the status file will be used as plugin instance and the client's "common name" will be used as type instance. This is required when reading multiple status files. Enabling this option is recommended, but to maintain backwards compatibility this option is disabled by default. =item B B|B Sets whether or not statistics about the compression used by OpenVPN should be collected. This information is only available in I mode. Enabled by default. =item B B|B Sets whether or not traffic information is collected for each connected client individually. If set to false, currently no traffic data is collected at all because aggregating this data in a save manner is tricky. Defaults to B. =item B B|B When enabled, the number of currently connected clients or users is collected. This is especially interesting when B is disabled, but can be configured independently from that option. Defaults to B. =back =head2 Plugin C The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an Oracle® Database and lets you execute SQL statements there. It is very similar to the "dbi" plugin, because it was written around the same time. See the "dbi" plugin's documentation above for details. Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category" Type "gauge" # InstancePrefix "foo" InstancesFrom "category" ValuesFrom "value" ConnectID "db01" Username "oracle" Password "secret" Query "out_of_stock" =head3 B blocks The Query blocks are handled identically to the Query blocks of the "dbi" plugin. Please see its documentation above for details on how to specify queries. =head3 B blocks Database blocks define a connection to a database and which queries should be sent to that database. Each database needs a "name" as string argument in the starting tag of the block. This name will be used as "PluginInstance" in the values submitted to the daemon. Other than that, that name is not used. =over 4 =item B I 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 Username used for authentication. =item B I Password used for authentication. =item B I Associates the query named I with this database connection. The query needs to be defined I this statement, i.Ee. all query blocks you want to refer to must be placed above the database block you want to refer to them from. =back =head2 Plugin C This plugin embeds a Perl-interpreter into collectd and provides an interface to collectd's plugin system. See L for its documentation. =head2 Plugin C The I receives profiling information from I, an extension for the I interpreter. At the end of executing a script, i.e. after a PHP-based webpage has been delivered, the extension will send a UDP packet containing timing information, peak memory usage and so on. The plugin will wait for such packets, parse them and account the provided information, which is then dispatched to the daemon once per interval. Synopsis: Address "::0" Port "30002" # Overall statistics for the website. Server "www.example.com" # Statistics for www-a only Host "www-a.example.com" Server "www.example.com" # Statistics for www-b only Host "www-b.example.com" Server "www.example.com" The plugin provides the following configuration options: =over 4 =item B
I Configures the address used to open a listening socket. By default, plugin will bind to the I address C<::0>. =item B I Configures the port (service) to bind to. By default the default Pinba port "30002" will be used. The option accepts service names in addition to port numbers and thus requires a I argument. =item EB IE block The packets sent by the Pinba extension include the hostname of the server, the server name (the name of the virtual host) and the script that was executed. Using B blocks it is possible to separate the data into multiple groups to get more meaningful statistics. Each packet is added to all matching groups, so that a packet may be accounted for more than once. =over 4 =item B I Matches the hostname of the system the webserver / script is running on. This will contain the result of the L system call. If not configured, all hostnames will be accepted. =item B I Matches the name of the I, i.e. the contents of the C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all server names will be accepted. =item B