X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=581da28541db82e41b4cc71ee1dd572a918587cb;hb=1de709a53e48795be10bbc3a875520c1a5d60217;hp=605ba14796222cf32ddc0f738c3d60d13c19802f;hpb=67a5f0bd07ca46402ad13f610bb4a154d216d50d;p=collectd.git
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 605ba147..ff44ba15 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"
@@ -501,6 +501,10 @@ 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
@@ -510,6 +514,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
@@ -529,7 +636,7 @@ than those of other plugins. It usually looks something like this:
MinVersion 50000
Type "gauge"
- InstancePrefix "out_of_stock"
+ InstancePrefix "out_of_stock"
InstancesFrom "category"
ValuesFrom "value"
@@ -606,6 +713,9 @@ 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
@@ -653,20 +763,24 @@ There must be exactly one B option inside each B block.
=item B I
-Prepends I followed by a dash I<("-")> to the type instance. See
-B on how the rest of the type instance is built.
+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.
-There must be at least one B option inside each B block.
+If neither B nor B is given, the type-instance
+will be empty.
=item B I [I ...]
@@ -763,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
@@ -814,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
@@ -955,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
-Do not send the value list to any output (a.k.a. write) plugins.
+Available configuration options:
-=item B
+=over 4
-Skip threshold checking for this value list.
+=item B I [I]
-=item B
+Sets sets the multicast group and UDP port to which to subscribe.
-Completely ignore this value list.
+Default: B<239.2.11.71>E/EB<8649>
-=back
+=item EB IE
-Two or more actions may be combined by specifying multiple B options.
+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.
-=item B I
+=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.
-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.
+=item B I
-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.
+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
@@ -1170,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
@@ -1301,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
@@ -1321,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 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.
+
+ 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
@@ -1363,15 +1621,459 @@ 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.
+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 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 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