X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=27ddeb30efdd04f575b415198f1c084878c499f1;hp=56bab99ab808001875127d039af3f7dd806a1d92;hb=2c179fea9eb62d88bbd46d777b596fff5f48997c;hpb=f14feb1eddfe5760a64640b98ab7bbc5c493f614 diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 56bab99a..27ddeb30 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -38,7 +38,7 @@ i.e. a CPluginE...E> block. The syntax of this config file is similar to the config file of the famous I webserver. Each line contains either an option (a key and a list of one or more values) or a section-start or -end. Empty lines and everything -after a non-quoted hash-symbol (C<#>) is ignored. I are unquoted +after a non-quoted hash-symbol (C<#>) are ignored. I are unquoted strings, consisting only of alphanumeric characters and the underscore (C<_>) character. Keys are handled case insensitive by I itself and all plugins included with it. I can either be an I, a @@ -70,7 +70,7 @@ CB ...E> block. =item B I -Sets the base directory. This is the directory beneath all RRD-files are +Sets the base directory. This is the directory beneath which all RRD-files are created. Possibly more subdirectories are created. This is also the working directory for the daemon. @@ -83,7 +83,7 @@ I will be mostly useless. Only the first B statement or block for a given plugin name has any effect. This is useful when you want to split up the configuration into smaller files and want each file to be "self contained", i.e. it contains a B -block I then appropriate B statement. The downside is that if +block I the appropriate B statement. The downside is that if you have multiple conflicting B blocks, e.g. when they specify different intervals, only one of them (the first one encountered) will take effect and all others will be silently ignored. @@ -127,8 +127,17 @@ the average user from ever having to deal with this low level linking stuff. =item B I Sets a plugin-specific interval for collecting metrics. This overrides the -global B setting. If a plugin provides own support for specifying an -interval, that setting will take precedence. +global B setting. If a plugin provides its own support for specifying +an interval, that setting will take precedence. + +=item B I + +Specifies the interval, in seconds, to call the flush callback if it's +defined in this plugin. By default, this is disabled. + +=item B I + +Specifies the value of the timeout argument of the flush callback. =back @@ -199,13 +208,11 @@ I may be specified to filter which files to include. This may be used in combination with recursively including a directory to easily be able to arbitrarily mix configuration files and other documents (e.g. README files). The given example is similar to the first example above but includes all files -matching C<*.conf> in any subdirectory of C: - - Include "/etc/collectd.d" "*.conf" +matching C<*.conf> in any subdirectory of C. =back -If more than one files are included by a single B option, the files +If more than one file is 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. @@ -246,7 +253,7 @@ magic! (Assuming you're using the I or I plugin.) =item B I -Read plugin doubles interval between queries after each failed attempt +A read plugin doubles the interval between queries after each failed attempt to get data. This options limits the maximum value of the interval. The default value is @@ -519,7 +526,9 @@ are disabled by default. 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. +possibly filtering out messages. + +B # Send values to an AMQP broker @@ -817,12 +826,24 @@ B can handle it. TCP-Port to connect to. Defaults to B<3551>. -=item B B +=item B B|B If set to B, the time reported in the C metric will be converted to seconds. This is the recommended setting. If set to B, the default for backwards compatibility, the time will be reported in minutes. +=item B B|B + +The plugin is designed to keep the connection to I open between reads. +If plugin poll interval is greater than 15 seconds (hardcoded socket close +timeout in I NIS), then this option is B by default. + +You can instruct the plugin to close the connection after each read by setting +this option to B or force keeping the connection by setting it to B. + +If I appears to close the connection due to inactivity quite quickly, +the plugin will try to detect this problem and switch to an open-read-close mode. + =back =head2 Plugin C @@ -1430,6 +1451,92 @@ number. =back +=head2 cURL Statistics + +All cURL-based plugins support collection of generic, request-based +statistics. These are disabled by default and can be enabled selectively for +each page or URL queried from the curl, curl_json, or curl_xml plugins. See +the documentation of those plugins for specific information. This section +describes the available metrics that can be configured with each plugin. All +options are disabled by default. + +See L for more details. + +=over 4 + +=item B B + +Total time of the transfer, including name resolving, TCP connect, etc. + +=item B B + +Time it took from the start until name resolving was completed. + +=item B B + +Time it took from the start until the connect to the remote host (or proxy) +was completed. + +=item B B + +Time it took from the start until the SSL/SSH connect/handshake to the remote +host was completed. + +=item B B + +Time it took from the start until the file transfer is just about to begin. + +=item B B + +Time it took from the start until the first byte was received. + +=item B B + +Time it took for all redirection steps include name lookup, connect, +pre-transfer and transfer before final transaction was started. + +=item B B + +The total number of redirections that were actually followed. + +=item B B + +The total amount of bytes that were uploaded. + +=item B B + +The total amount of bytes that were downloaded. + +=item B B + +The average download speed that curl measured for the complete download. + +=item B B + +The average upload speed that curl measured for the complete upload. + +=item B B + +The total size of all the headers received. + +=item B B + +The total size of the issued requests. + +=item B B + +The content-length of the download. + +=item B B + +The specified size of the upload. + +=item B B + +The number of new connections that were created to achieve the transfer. + +=back + =head2 Plugin C The curl plugin uses the B (L) to read web pages @@ -1530,11 +1637,21 @@ Beware that requests will get aborted if they take too long to complete. Adjust B accordingly if you expect B to report such slow requests. +This option is similar to enabling the B statistic but it's +measured by collectd instead of cURL. + =item B B|B Measure response code for the request. If this setting is enabled, B blocks (see below) are optional. Disabled by default. +=item BStatisticsE> + +One B block can be used to specify cURL statistics to be collected +for each request to the remote web site. See the section "cURL Statistics" +above for details. If this setting is enabled, B blocks (see below) are +optional. + =item BMatchE> One or more B blocks that define how to match information in the data @@ -1647,6 +1764,12 @@ URL. By default the global B setting will be used. These options behave exactly equivalent to the appropriate options of the I plugin. Please see there for a detailed description. +=item BStatisticsE> + +One B block can be used to specify cURL statistics to be collected +for each request to the remote URL. See the section "cURL Statistics" above +for details. + =back The following options are valid within B blocks: @@ -1749,6 +1872,12 @@ Examples: These options behave exactly equivalent to the appropriate options of the I. Please see there for a detailed description. +=item BStatisticsE> + +One B block can be used to specify cURL statistics to be collected +for each request to the remote URL. See the section "cURL Statistics" above +for details. + =item EB IE Within each B block, there must be one or more B blocks. Each @@ -1821,6 +1950,7 @@ than those of other plugins. It usually looks something like this: Driver "mysql" + Interval 120 DriverOption "host" "localhost" DriverOption "username" "collectd" DriverOption "password" "aZo6daiw" @@ -2000,6 +2130,11 @@ the daemon. Other than that, that name is not used. =over 4 +=item B I + +Sets the interval (in seconds) in which the values will be collected from this +database. By default the global B setting will be used. + =item B I Specifies the driver to use to connect to the database. In many cases those @@ -2470,6 +2605,51 @@ source, this is optional. Otherwise the option is required. =back +=head2 Plugin C + +The I plugin provides an RPC interface to submit values to or query +values from collectd based on the open source gRPC framework. It exposes an +end-point for dispatching values to the daemon. + +The B homepage can be found at L. + +=over 4 + +=item B I I + +The B statement sets the network address to bind to. When multiple +statements are specified, the daemon will bind to all of them. If none are +specified, it defaults to B<0.0.0.0:50051>. + +The argument I may be a hostname, an IPv4 address, or an IPv6 address. + +Optionally, B may be specified as a configuration block which +supports the following options: + +=over 4 + +=item B I|I + +Whether to enable SSL for incoming connections. Default: false. + +=item B I + +=item B I + +=item B I + +Filenames specifying SSL certificate and key material to be used with SSL +connections. + +=back + +=item B I + +Number of threads to start for handling incoming connections. The default +value is B<5>. + +=back + =head2 Plugin C To get values from B collectd connects to B (127.0.0.1), @@ -2530,6 +2710,17 @@ with I and all interfaces with names starting with I followed by at least one digit. +=item B I|I + +Interface name is not unique on Solaris (KSTAT), interface name is unique +only within a module/instance. Following tuple is considered unique: + (ks_module, ks_instance, ks_name) +If this option is set to true, interface name contains above three fields +separated by an underscore. For more info on KSTAT, visit +L + +This option is only available on Solaris. + =back =head2 Plugin C @@ -3250,6 +3441,146 @@ B option is mandatory. =back +=head2 Plugin C + +The I can send metrics to MQTT (B blocks) and receive +values from MQTT (B blocks). + +B + + + + Host "mqtt.example.com" + Prefix "collectd" + + + Host "mqtt.example.com" + Topic "collectd/#" + + + +The plugin's configuration is in B and/or B blocks, +configuring the sending and receiving direction respectively. The plugin will +register a write callback named C> where I is the string +argument given to the B block. Both types of blocks share many but not +all of the following options. If an option is valid in only one of the blocks, +it will be mentioned explicitly. + +B + +=over 4 + +=item B I + +Hostname of the MQTT broker to connect to. + +=item B I + +Port number or service name of the MQTT broker to connect to. + +=item B I + +Username used when authenticating to the MQTT broker. + +=item B I + +Password used when authenticating to the MQTT broker. + +=item B I + +MQTT client ID to use. Defaults to the hostname used by I. + +=item B [B<0>-B<2>] + +Sets the I, with the values C<0>, C<1> and C<2> meaning: + +=over 4 + +=item B<0> + +At most once + +=item B<1> + +At least once + +=item B<2> + +Exactly once + +=back + +In B blocks, this option determines the QoS flag set on outgoing +messages and defaults to B<0>. In B blocks, determines the maximum +QoS setting the client is going to accept and defaults to B<2>. If the QoS flag +on a message is larger than the maximum accepted QoS of a subscriber, the +message's QoS will be downgraded. + +=item B I (Publish only) + +This plugin will use one topic per I which will looks like a path. +I is used as the first path element and defaults to B. + +An example topic name would be: + + collectd/cpu-0/cpu-user + +=item B B|B (Publish only) + +Controls whether the MQTT broker will retain (keep a copy of) the last message +sent to each topic and deliver it to new subscribers. Defaults to B. + +=item B B|B (Publish only) + +Controls whether C and C metrics are converted to a I +before sending. Defaults to B. + +=item B B|B (Subscribe only) + +Controls whether the MQTT "cleans" the session up after the subscriber +disconnects or if it maintains the subscriber's subscriptions and all messages +that arrive while the subscriber is disconnected. Defaults to B. + +=item B I (Subscribe only) + +Configures the topic(s) to subscribe to. You can use the single level C<+> and +multi level C<#> wildcards. Defaults to B, i.e. all topics beneath +the B branch. + +=item B I + +Path to the PEM-encoded CA certificate file. Setting this option enables TLS +communication with the MQTT broker, and as such, B should be the TLS-enabled +port of the MQTT broker. +A valid TLS configuration requires B, B and B. + +=item B I + +Path to the PEM-encoded certificate file to use as client certificate when +connecting to the MQTT broker. +A valid TLS configuration requires B, B and B. + +=item B I + +Path to the unencrypted PEM-encoded key file corresponding to B. +A valid TLS configuration requires B, B and B. + +=item B I + +If configured, this specifies the string protocol version (e.g. C, +C) to use for the TLS connection to the broker. If not set a default +version is used which depends on the version of OpenSSL the Mosquitto library +was linked against. + +=item B I + +A string describing the ciphers available for use. See L and the +C utility for more information. If unset, the default ciphers +will be used. + + +=back + =head2 Plugin C The C requires B to be installed. It connects to @@ -4305,6 +4636,21 @@ Default: C =back +=head2 Plugin C + +The I plugin writes notifications to Nagios' I as +a I. + +Available configuration options: + +=over 4 + +=item B I + +Sets the I to write to. Defaults to F. + +=back + =head2 Plugin C The C plugin collects per-peer ntpd data such as time offset and time @@ -4542,6 +4888,16 @@ The following options are accepted within each B block: Sets the URL to use to connect to the I server. This option is I. +=item B I + +Name in the form of an LDAP distinguished name intended to be used for +authentication. Defaults to empty string to establish an anonymous authorization. + +=item B I + +Password for simple bind authentication. If this option is not set, +unauthenticated bind operation is used. + =item B B Defines whether TLS must be used when connecting to the I server. @@ -4563,8 +4919,9 @@ client configuration mechanisms. See ldap.conf(5) for the details. =item B I -Sets the timeout value for ldap operations. Defaults to B<-1> which results in -an infinite timeout. +Sets the timeout value for ldap operations, in seconds. By default, the +configured B is used to set the timeout. Use B<-1> to disable +(infinite timeout). =item B I @@ -4813,6 +5170,13 @@ Default: B<0.9> Sets the Time-To-Live of generated ICMP packets. +=item B I + +Sets the size of the data payload in ICMP packet to specified I (it +will be filled with regular ASCII pattern). If not set, default 56 byte +long string is used so that the packet size of an ICMPv4 packet is exactly +64 bytes, similar to the behaviour of normal ping(1) command. + =item B I Sets the source address to use. I may either be a numerical network @@ -4920,13 +5284,12 @@ 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 (see the B and B options below for an exception to this -rule). The following configuration options are available to define the query: +rule). + +In each B block, there is one or more B blocks. Multiple +B blocks may be used to extract multiple values from a single 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. +The following configuration options are available to define the query: =over 4 @@ -4944,7 +5307,7 @@ allowed as long as a single non-empty command has been specified only. The returned lines will be handled separately one after another. -=item B I|I|I|I +=item B I|I|I|I|I Specify the parameters which should be passed to the SQL query. The parameters are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as @@ -4981,6 +5344,34 @@ specific or global B options). Please note that parameters are only supported by PostgreSQL's protocol version 3 and above which was introduced in version 7.4 of PostgreSQL. +=item B I + +Specify how to create the "PluginInstance" for reporting this query results. +Only one column is supported. You may concatenate fields and string values in +the query statement to get the required results. + +=item B I + +=item B I + +Specify the minimum or maximum version of PostgreSQL that this query should be +used with. Some statistics might only be available with certain versions of +PostgreSQL. This allows you to specify multiple queries with the same name but +which apply to different versions, thus allowing you to use the same +configuration in a heterogeneous environment. + +The I has to be specified as the concatenation of the major, minor +and patch-level versions, each represented as two-decimal-digit numbers. For +example, version 8.2.3 will become 80203. + +=back + +The B block defines how to handle the values returned from the query. +It defines which column holds which value and how to dispatch that value to +the daemon. + +=over 4 + =item B I The I name to be used when dispatching the values. The type describes @@ -4988,7 +5379,7 @@ how to handle the data and where to store it. See L for more details on types and their configuration. The number and type of values (as selected by the B option) has to match the type of the given name. -This option is required inside a B block. +This option is mandatory. =item B I @@ -5024,20 +5415,6 @@ This option is required inside a B block and may be specified multiple times. If multiple B options are specified, the columns are read in the given order. -=item B I - -=item B I - -Specify the minimum or maximum version of PostgreSQL that this query should be -used with. Some statistics might only be available with certain versions of -PostgreSQL. This allows you to specify multiple queries with the same name but -which apply to different versions, thus allowing you to use the same -configuration in a heterogeneous environment. - -The I has to be specified as the concatenation of the major, minor -and patch-level versions, each represented as two-decimal-digit numbers. For -example, version 8.2.3 will become 80203. - =back The following predefined queries are available (the definitions can be found @@ -5207,6 +5584,8 @@ Specify the plugin instance name that should be used instead of the database name (which is the default, if this option has not been specified). This allows to query multiple databases of the same name on the same host (e.g. when running multiple database server versions in parallel). +The plugin instance name can also be set from the query result using +the B option in B block. =item B I @@ -5461,6 +5840,9 @@ collected for these selected processes are size of the resident segment size (RSS), user- and system-time used, number of processes and number of threads, io data (where available) and minor and major pagefaults. +Some platforms have a limit on the length of process names. I must stay +below this limit. + =item B I I Similar to the B option this allows to select more detailed @@ -5470,6 +5852,10 @@ dispatched to the daemon using the specified I as an identifier. This allows to "group" several processes together. I must not contain slashes. +=item B I + +Collect context switch of the process. + =back =head2 Plugin C @@ -5936,6 +6322,12 @@ few ones. 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 + +Configures how sensor readings are reported. When set to I, sensor +readings are reported using their descriptive label (e.g. "VCore"). When set to +I (the default) the sensor name is used ("in0"). + =back =head2 Plugin C @@ -6084,6 +6476,12 @@ rate of counters and size of sets will be zero, timers report C and gauges are unchanged. If set to B, the such metrics are not dispatched and removed from the internal cache. +=item B B|B + +When enabled, creates a C metric which reports the change since the last +read. This option primarily exists for compatibility with the I +implementation by Etsy. + =item B I Calculate and dispatch the configured percentile, i.e. compute the latency, so @@ -6692,13 +7090,13 @@ fails or if you want to disable this feature. =item B I|I Boolean enabling the collection of the temperature of each core. -This option should only be used if the automated detectionfails or +This option should only be used if the automated detectionfails or if you want to disable this feature. =item B I|I Boolean enabling the collection of the temperature of each package. -This option should only be used if the automated detectionfails or +This option should only be used if the automated detectionfails or if you want to disable this feature. =item B I @@ -7038,17 +7436,17 @@ 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. -=item B B +=item B B When the virt plugin logs data, it sets the plugin_instance 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. +data according to this setting. The default is to not set the plugin_instance. +B means use the guest's name as provided by the hypervisor. B means use the guest's UUID. -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">). +You can also specify combinations of the B and B 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">). =back @@ -7123,6 +7521,14 @@ Service name or port number to connect to. Defaults to C<2003>. Protocol to use when connecting to I. Defaults to C. +=item B I + +When set to non-zero, forces the connection to the Graphite backend to be +closed and re-opend periodically. This behavior is desirable in environments +where the connection to the Graphite backend is done through load balancers, +for example. When set to zero, the default, the connetion is kept open for as +long as possible. + =item B B|B If set to B (the default), logs errors when sending data to I. @@ -7349,6 +7755,12 @@ authentication. Password required to load the private key in B. +=item B
I
+ +A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example: + + Header "X-Custom-Header: custom_value" + =item B B|B|B|B|B|B Define which SSL protocol version must be used. By default C will @@ -7391,6 +7803,10 @@ complete. When this limit is reached, the POST operation will be aborted, and all the data in the current send buffer will probably be lost. Defaults to 0, which means the connection never times out. +=item B B|B + +Enables printing of HTTP error code to log. Turned off by default. + The C plugin regularly submits the collected values to the HTTP server. How frequently this happens depends on how much data you are collecting and the size of B. The optimal value to set B to is @@ -7517,14 +7933,20 @@ Synopsis: Host "localhost" Port "6379" Timeout 1000 + Prefix "collectd/" + Database 1 + MaxSetSize -1 + StoreRates true Values are submitted to I, using the metric name as the key, and the timestamp as the score. Retrieving a date range can then be done using the C I command. Additionally, all the identifiers of these -I are kept in a I called C and can be -retrieved using the C I command. See +I are kept in a I called C (or +C<${prefix}/values> if the B option was specified) and can be retrieved +using the C I command. You can specify the database to use +with the B parameter (default is C<0>). See L and L for details. @@ -7559,6 +7981,28 @@ that numerical port numbers must be given as a string, too. The B option sets the socket connection timeout, in milliseconds. +=item B I + +Prefix used when constructing the name of the I and the I +containing all metrics. Defaults to C, so metrics will have names +like C. When setting this to something different, it +is recommended but not required to include a trailing slash in I. + +=item B I + +This index selects the redis database to use for writing operations. Defaults +to C<0>. + +=item B I + +The B option limits the number of items that the I can +hold. Negative values for I sets no limit, which is the default behavior. + +=item B B|B + +If set to B (the default), convert counter values to rates. If set to +B counter values are stored as is, i.e. as an increasing integer number. + =back =head2 Plugin C @@ -7603,11 +8047,26 @@ Hostname or address to connect to. Defaults to C. Service name or port number to connect to. Defaults to C<5555>. -=item B B|B +=item B B|B|B Specify the protocol to use when communicating with I. Defaults to B. +=item B I + +When using the B protocol, path to a PEM certificate to present +to remote host. + +=item B I + +When using the B protocol, path to a PEM CA certificate to +use to validate the remote hosts's identity. + +=item B I + +When using the B protocol, path to a PEM private key associated +with the certificate defined by B. + =item B B|B If set to B and B is set to B, @@ -7627,6 +8086,11 @@ Defaults to true Maximum payload size for a riemann packet. Defaults to 8192 +=item B I + +Maximum amount of seconds to wait in between to batch flushes. +No timeout by default. + =item B B|B If set to B (the default), convert counter values to rates. If set to @@ -7793,6 +8257,14 @@ attribute for each metric being sent out to I. =back +=head2 Plugin C + +This plugin collects metrics of hardware CPU load for machine running Xen +hypervisor. Load is calculated from 'idle time' value, provided by Xen. +Result is reported using the C type, for each CPU (core). + +This plugin doesn't have any options (yet). + =head2 Plugin C The I will collect statistics from a I server @@ -8690,6 +9162,8 @@ Available options: =item B I +=item B I I + Set the appropriate field to the given string. The strings for plugin instance and type instance may be empty, the strings for host and plugin may not be empty. It's currently not possible to set the type of a value this way.