X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=69f7308befe716923dd780c9216f6738375ddbcd;hb=refs%2Fheads%2Fff%2Fjson;hp=26e1ea5e11fc05445058bdd5497043a2f016d5e2;hpb=306fd73c8c5a936211e2a7dd4e43d2451fb3b245;p=collectd.git
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 26e1ea5e..69f7308b 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -454,7 +454,7 @@ finance page and dispatch the value to collectd.
Regex "]*> *([0-9]*\\.[0-9]+) *"
DSType "GaugeAverage"
- # Note: `stock_value' is not a standard type.
+ # Note: `stock_value' is not a standard type.
Type "stock_value"
Instance "AMD"
@@ -510,6 +510,109 @@ 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
@@ -665,7 +768,7 @@ separated by dashes 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 join together with the dashes I<("-")> as separation character.
+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
@@ -770,6 +873,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
@@ -821,6 +930,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
@@ -962,6 +1075,88 @@ Controls whether or not to recurse into subdirectories. Enabled by default.
=back
+=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),
@@ -1086,6 +1281,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
@@ -1217,6 +1468,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
@@ -1237,19 +1539,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.
-This plugin issues the MySQL 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.
+Synopsis:
-Use the following options to configure the plugin:
+
+
+ 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
@@ -1289,6 +1622,17 @@ 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
@@ -1370,32 +1714,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 B I [I]
+=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 [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
-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.
+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.
+
+=back
=item B I<1-255>
@@ -1404,6 +1835,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
@@ -1584,6 +2020,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