X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=581da28541db82e41b4cc71ee1dd572a918587cb;hb=1de709a53e48795be10bbc3a875520c1a5d60217;hp=a1287c8bd87f3f6340d9cc83d7bd3c56db496192;hpb=7c595b0513a7023144f7540e63e8e61274daaa83;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index a1287c8b..ff44ba15 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -126,6 +126,14 @@ The sample config file that is installed with Cinstall> includes a line which sets this option, though, so that default installations will have this setting enabled. +=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 @@ -257,6 +265,150 @@ 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 @@ -273,6 +425,9 @@ installed and an "cpu governor" (that's a kernel module) is loaded. 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 @@ -282,12 +437,194 @@ 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. 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. + +=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, of which is used to collect +a value from a JSON map object. If a B path element is that of a I<*> wildcard, +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 -This plugin uses the "B" library (L) to -connect to various databases, execute SQL statements and read back the results. -You can configure how each column is to be interpreted and the plugin will -generate one data set from each row returned according to these rules. +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: @@ -295,9 +632,14 @@ 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" - Type "gauge" - InstancesFrom "category" - ValuesFrom "value" + # Use with MySQL 5.0.0 or later + MinVersion 50000 + + Type "gauge" + InstancePrefix "out_of_stock" + InstancesFrom "category" + ValuesFrom "value" + Driver "mysql" @@ -310,8 +652,8 @@ than those of other plugins. It usually looks something like this: -The configuration above defines one query and one database. The query is then -linked to the database with the B option I the +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 @@ -322,10 +664,35 @@ The following is a complete list of options: =head3 B blocks -Query blocks define SQL statements and how the returned data should be +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. +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 @@ -346,6 +713,41 @@ like this: 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 @@ -357,15 +759,28 @@ 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 "TypeInstance" -for each row. You need to specify at least one column for each query. If you -specify more than one column, the value of all columns will be join together -with the hyphen as separation character. +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. +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 ...] @@ -380,6 +795,8 @@ 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 @@ -460,6 +877,12 @@ 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 I|I + +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). + =back =head2 Plugin C @@ -511,6 +934,10 @@ may not work on certain platforms, such as MacEOSEX. 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 @@ -652,94 +1079,90 @@ Controls whether or not to recurse into subdirectories. Enabled by default. =back -=head2 Plugin C +=head2 Plugin C -This plugin allows you to filter and rewrite value lists based on -Perl-compatible regular expressions whose syntax and semantics are as close as -possible to those of the Perl 5 language. See L for details. +The I is written in I and therefore documented in +L. - - - Host "^mail\d+$" - Plugin "^tcpconns$" - TypeInstance "^SYN_" +=head2 Plugin C - Action NoWrite - +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. - - Plugin "^sensors$" - PluginInstance "^Some Weird Sensor Chip Name Prefix" +Synopsis: - SubstitutePluginInstance "foo" - - + + MCReceiveFrom "239.2.11.71" "8649" + + Type "swap" + TypeInstance "total" + DataSource "value" + + + Type "swap" + TypeInstance "free" + DataSource "value" + + -The configuration consists of one or more C blocks, each of which -specifies a regular expression identifying a set of value lists and how to -handle successful matches. A value list keeps the values of a single data-set -and is identified by the tuple (host, plugin, plugin instance, type, type -instance). The plugin and type instances are optional components. If they are -missing they are treated as empty strings. Within those blocks, the following -options are recognized: +The following metrics are built-in: =over 4 -=item B I +=item * -=item B I +load_one, load_five, load_fifteen -=item B I +=item * -=item B I +cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio -=item B I +=item * -Specifies the regular expression for each component of the identifier. If any -of these options is missing it is interpreted as a pattern which matches any -string. All five components of a value list have to match the appropriate -regular expression to trigger the specified action. +mem_free, mem_shared, mem_buffers, mem_cached, mem_total -=item B I|I|I +=item * -Specify how to handle successful matches: +bytes_in, bytes_out -=over 4 +=item * + +pkts_in, pkts_out -=item B +=back + +Available configuration options: -Do not send the value list to any output (a.k.a. write) plugins. +=over 4 -=item B +=item B I [I] -Skip threshold checking for this value list. +Sets sets the multicast group and UDP port to which to subscribe. -=item B +Default: B<239.2.11.71>E/EB<8649> -Completely ignore this value list. +=item EB IE -=back +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. -Two or more actions may be combined by specifying multiple B options. +=over 4 -=item B I +=item B I -=item B I +Type to map this metric to. Required. -=item B I +=item B I -=item B I +Type-instance to use. Optional. -=item B I +=item B I -Upon a successful match, the matching substring will be replaced by the -specified I text. These options require that an appropriate regex -has been specified before, e.Eg. B requires that the -B option has been specified before. +Data source to map this metric to. If the configured type has exactly one data +source, this is optional. Otherwise the option is required. -B: It is not recommended to modify the type unless you really know what -you are doing. The type is used to identify the data-set definition of the -dispatched values. +=back =back @@ -867,6 +1290,62 @@ 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 @@ -969,6 +1448,10 @@ Prefix all lines printed by the current time. 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 C uses mbmon to retrieve temperature, voltage, etc. @@ -994,6 +1477,57 @@ 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 @@ -1014,19 +1548,50 @@ TCP-Port to connect to. Defaults to B<11211>. =head2 Plugin C -The C requires B to be installed. It connects to the -database 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 complaint loudly in case anything goes wrong. +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 complaint 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 + -This plugin issues C and evaluates C, -C and C which correspond to F, -F and F. Also, the values of -C are put in F and values of C are put -in F. Please refer to the B, -I<5.2.4. Server Status Variables> for an explanation of these values. + + Host "localhost" + Socket "/var/run/mysql/mysqld.sock" + SlaveStats true + SlaveNotifications true + + -Use the following options to configure the plugin: +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 @@ -1036,7 +1601,9 @@ Hostname of the database server. Defaults to B. =item B I -Username to use when connecting to the database. +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 @@ -1064,70 +1631,514 @@ 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 +=head2 Plugin C + +The netapp plugin can collect various performance and capacity informations +from a NetApp filer using the NetApp API. + +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 + + + + GetIO "volume0" + IgnoreSelectedIO false + GetOps "volume0" + IgnoreSelectedOps false + GetLatency "volume0" + IgnoreSelectedLatency false + + + + GetCapacity "vol0" + GetCapacity "vol1" + IgnoreSelectedCapacity false + GetSnapshot "vol1" + GetSnapshot "vol3" + IgnoreSelectedSnapshot false + + + + Interval 30 + GetCPULoad true + GetInterfaces true + GetDiskOps true + GetDiskIO true + + + -The C plugin uses a netlink socket to query the Linux kernel about -statistics of various interface and routing aspects. +The netapp plugin accepts the following configuration options: =over 4 -=item B I +=item B I -=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. -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. +=item B B|B -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. +The protocol collectd will use to query this host. -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: +Optional - ip -s -s link list +Type: string -If I is B, all interfaces will be selected. +Default: https -=item B I [I] +Valid options: http, https -=item B I [I] +=item B
I
-=item B I [I] +The hostname or IP address of the host. -Collect the octets and packets that pass a certain qdisc, class or filter. +Optional -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). +Type: string -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. +Default: The "host" block's name. -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. +=item B I -As with the B option you can specify B as the interface, -meaning all interfaces. +The TCP port to connect to on the host. -Here are some examples to help you understand the above text more easily: +Optional - - VerboseInterface "All" - QDisc "eth0" "pfifo_fast-1:0" +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 + +The host specific interval between data collections is multiplied by this value +for collecting these data. + +Optional + +Type: integer + +Default: 1 + +=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 + +=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 + +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 + +B Select volumes from which to collect snapshot information. + +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" @@ -1145,32 +2156,119 @@ specified statistics will not be collected. =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 actived, 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 I [I] +=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 [I] +=item B I + +Sets a password (shared secret) for this socket. All security levels except +B require this setting. -The B statement sets the server to send datagrams B. The statement -may occur multiple times to send each datagram to multiple destinations. +This feature is only available if the I plugin was linked with +I. + +=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. -If no B statement is found the server tries join both, the default IPv6 -multicast group and the default IPv4 multicast group. If no B statement -is found the client will try to send data to the IPv6 multicast group first. If -that fails the client will try the IPv4 multicast group. +The following options are recognized within CListenE> blocks: -The default IPv6 multicast group is C. The default IPv4 -multicast group is C<239.192.74.66>. +=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: -The optional I argument sets the port to use. It can either be given -using a numeric port number or a service name. If the argument is omitted the -default port B<25826> is assumed. + 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. + +=back =item B I<1-255> @@ -1179,6 +2277,11 @@ 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. + =item B I If set to I, write packets that were received via the network plugin to @@ -1272,6 +2375,61 @@ 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 @@ -1304,6 +2462,55 @@ 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. @@ -1353,6 +2560,11 @@ 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 @@ -1361,14 +2573,40 @@ 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 probmise. So in -short: If it works for you: Great! But kaap in mind that the config I +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. + +=back + =head2 Plugin C -The "oracle" plugin uses the Oracle® Call Interface (OCI) to connect to an +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. @@ -1376,9 +2614,12 @@ plugin's documentation above for details. Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category" - Type "gauge" - InstancesFrom "category" - ValuesFrom "value" + + Type "gauge" + # InstancePrefix "foo" + InstancesFrom "category" + ValuesFrom "value" + ConnectID "db01" @@ -1432,6 +2673,13 @@ to collectd's plugin system. See L for its documentation. =head2 Plugin C +The I plugin starts a new thread which sends ICMP "ping" packets to the +configured hosts periodically and measures the network latency. Whenever the +C function of the plugin is called, it submits the average latency, the +standard deviation and the drop rate for each host. + +Available configuration options: + =over 4 =item B I @@ -1439,6 +2687,26 @@ to collectd's plugin system. See L for its documentation. Host to ping periodically. This option may be repeated several times to ping multiple hosts. +=item B I + +Sets the interval in which to send ICMP echo packets to the configured hosts. +This is B the interval in which statistics are queries from the plugin but +the interval in which the hosts are "pinged". Therefore, the setting here +should be smaller than or equal to the global B setting. Fractional +times, such as "1.24" are allowed. + +Default: B<1.0> + +=item B I + +Time to wait for a response from the host to which an ICMP packet had been +sent. If a reply was not received after I seconds, the host is assumed +to be down or the packet to be dropped. This setting must be smaller than the +B setting above for the plugin to work correctly. Fractional +arguments are accepted. + +Default: B<0.9> + =item B I<0-255> Sets the Time-To-Live of generated ICMP packets. @@ -1468,10 +2736,28 @@ L. - Query "SELECT magic, spells FROM wizard WHERE host = $1;" + Statement "SELECT magic FROM wizard WHERE host = $1;" Param hostname - Column gauge magic - Column counter spells + + Type gauge + InstancePrefix "magic" + ValuesFrom magic + + + + + Statement "SELECT COUNT(type) AS count, type \ + FROM (SELECT CASE \ + WHEN resolved = 'epoch' THEN 'open' \ + ELSE 'resolved' END AS type \ + FROM tickets) type \ + GROUP BY type;" + + Type counter + InstancePrefix "rt36_tickets" + InstancesFrom "type" + ValuesFrom "count" + @@ -1483,23 +2769,33 @@ L. KRBSrvName "kerberos_service_name" Query magic + Service "service_name" + Query backend # predefined + Query rt36_tickets The B block defines one database query which may later be used by a database definition. It accepts a single mandatory argument which specifies -the name of the query. The names of all queries have to be unique. The -following configuration options are available to define the query: +the name of the query. The names of all queries have to be unique (see the +B and B options below for an exception to this +rule). The following configuration options are available to define the query: + +In each B block, there is one or more B blocks. B +blocks define how to handle the values returned from the query. They define +which column holds which value and how to dispatch that value to the daemon. +Multiple B blocks may be used to extract multiple values from a single +query. =over 4 -=item B I +=item B I -Specify the I which the plugin should execute. The string may -contain the tokens B<$1>, B<$2>, etc. which are used to reference the first, -second, etc. parameter. The value of the parameters is specified by the +Specify the I which the plugin should execute. The string +may contain the tokens B<$1>, B<$2>, etc. which are used to reference the +first, second, etc. parameter. The value of the parameters is specified by the B configuration option - see below for details. To include a literal B<$> character followed by a number, surround it with single quotes (B<'>). @@ -1507,7 +2803,14 @@ Any SQL command which may return data (such as C