X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=7a66c8188f8182589da12df69cc04e9dbf21ea1e;hb=218c57128f2e54960133cff3e774b5ef9944068a;hp=8ce4a86d43f891b7fec2ea7b762a248ecabace51;hpb=76d9c9033e021cbdb0da0fc2b0ad23bc3d7ad487;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 8ce4a86d..7a66c818 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -98,7 +98,6 @@ Options inside a B block can override default settings and influence the way plugins are loaded, e.g.: - Globals true Interval 60 @@ -151,12 +150,27 @@ plugins that don't provide any configuration, e.g. the I. When set to B, various statistics about the I daemon will be collected, with "collectd" as the I. Defaults to B. -The "write_queue" I reports the number of elements currently -queued and the number of elements dropped off the queue by the -B/B mechanism. +The following metrics are reported: -The "cache" I reports the number of elements in the value list -cache (the cache you can interact with using L). +=over 4 + +=item C + +The number of metrics currently in the write queue. You can limit the queue +length with the B and B options. + +=item C + +The number of metrics dropped due to a queue length limitation. +If this value is non-zero, your system can't handle all incoming metrics and +protects itself against overload by dropping metrics. + +=item C + +The number of elements in the metric cache (the cache you can interact with +using L). + +=back =item B I [I] @@ -502,7 +516,7 @@ are disabled by default. =head2 Plugin C -The I can be used to communicate with other instances of +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. @@ -775,6 +789,12 @@ 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 I + +Specifies which ciphers to use in the connection. The list of ciphers +must specify valid ciphers. See +L for details. + =item B I The B option sets the overall timeout for HTTP requests to B, in @@ -1541,7 +1561,7 @@ setting accordingly to prevent this from blocking other plugins. =head2 Plugin C The B collects values from JSON data to be parsed by -B (L) retrieved via +B (L) retrieved via either B (L) or read directly from a unix socket. The former can be used, for example, to collect values from CouchDB documents (which are stored JSON notation), and the @@ -2259,6 +2279,27 @@ expected from them. This is documented in great detail in L. =back +=head2 Plugin C + +The C plugin provides statistics about used, unused and total number of +file handles on Linux. + +The I provides the following configuration options: + +=over 4 + +=item B B|B + +Enables or disables reporting of file handles usage in absolute numbers, +e.g. file handles used. Defaults to B. + +=item B B|B + +Enables or disables reporting of file handles usage in percentages, e.g. +percent of file handles used. Defaults to B. + +=back + =head2 Plugin C The C plugin counts the number of files in a certain directory (and @@ -2472,6 +2513,23 @@ do that: By setting B to I the effect of B is inverted: All selected interfaces are ignored and all other interfaces are collected. +It is possible to use regular expressions to match interface names, if the +name is surrounded by I and collectd was compiled with support for +regexps. This is useful if there's a need to collect (or ignore) data +for a group of interfaces that are similarly named, without the need to +explicitly list all of them (especially useful if the list is dynamic). +Example: + + Interface "lo" + Interface "/^veth/" + Interface "/^tun[0-9]+/" + IgnoreSelected "true" + +This will ignore the loopback interface, all interfaces with names starting +with I and all interfaces with names starting with I followed by +at least one digit. + + =back =head2 Plugin C @@ -2512,9 +2570,13 @@ a notification is sent. =item B I I [I [I]] -Select the rules to count. If only I
and I are given, this plugin -will collect the counters of all rules which have a comment-match. The comment -is then used as type-instance. +=item B I
I [I [I]] + +Select the iptables/ip6tables filter rules to count packets and bytes from. + +If only I
and I are given, this plugin will collect the counters +of all rules which have a comment-match. The comment is then used as +type-instance. If I or I is given, only the rule with the matching comment or the Ith rule will be collected. Again, the comment (or the number) will be @@ -5127,6 +5189,13 @@ activating this option. The draw-back is, that data covering the specified amount of time will be lost, for example, if a single statement within the transaction fails or if the database server crashes. +=item B I + +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). + =item B I Specify the hostname or IP of the PostgreSQL server to connect to. If the @@ -5561,7 +5630,7 @@ that numerical port numbers must be given as a string, too. Use I to authenticate when connecting to I. -=item B I +=item B I The B option set the socket timeout for node response. Since the Redis read function is blocking, you should keep this value as low as possible. Keep @@ -6575,6 +6644,79 @@ Default: B<1978> =back +=head2 Plugin C + +The I reads CPU frequency and C-state residency on modern +Intel processors by using the new Model Specific Registers. + +=over 4 + +=item B I + +Bitmask of the list of core C states supported by the processor. +This option should only be used if the automated detection fails. +Default value extracted from the cpu model and family. + +Currently supported C-states (by this plugin): 3, 6, 7 + +Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states + +=item B I + +Bitmask of the list of pacages C states supported by the processor. +This option should only be used if the automated detection fails. +Default value extracted from the cpu model and family. + +Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10 + +Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7 + +=item B I|I + +Boolean enabling the collection of the I/O System-Management Interrupt +counter'. This option should only be used if the automated detection +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 +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 +if you want to disable this feature. + +=item B I + +Thermal Control Circuit Activation Temperature of the installed +CPU. This temperature is used when collecting the temperature of +cores or packages. This option should only be used if the automated +detection fails. Default value extracted from B + +=item B I + +Bitmask of the list of elements to be thermally monitored. This option +should only be used if the automated detection fails or if you want to +disable some collections. The different bits of this bitmask accepted +by this plugin are: + +=over 4 + +=item 0 ('1'): Package + +=item 1 ('2'): DRAM + +=item 2 ('4'): Cores + +=item 3 ('8'): Embedded graphic device + +=back + +=back + =head2 Plugin C =over 4 @@ -6870,6 +7012,10 @@ 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">). +At the moment of writing (collectd-5.5), hostname string is limited to 62 +characters. In case when combination of fields exceeds 62 characters, +hostname will be truncated without a warning. + =item B B|B
When the virt plugin logs interface data, it sets the name of the collected @@ -6888,6 +7034,10 @@ by the hypervisor, which is equal to setting B. 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">). + =back =head2 Plugin C @@ -7089,7 +7239,7 @@ Hostname or address to connect to. Defaults to C. Service name or port number to connect to. Defaults to C<27017>. -=item B I +=item B I Set the timeout for each operation on I to I milliseconds. Setting this option to zero means no timeout, which is the default. @@ -7360,7 +7510,7 @@ Synopsis: 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. Additionnally, all the identifiers of these +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 L and L for @@ -7378,9 +7528,9 @@ options are available: =item B I The B block identifies a new I node, that is a new I -instance running in an specified host and port. The name for node is a +instance running on a specified host and port. The node name is a canonical identifier which is used as I. It is limited to -64Echaracters in length. +51Echaracters in length. =item B I @@ -7393,7 +7543,7 @@ The B option is the TCP port on which the Redis instance accepts connections. Either a service name of a port number may be given. Please note that numerical port numbers must be given as a string, too. -=item B I +=item B I The B option sets the socket connection timeout, in milliseconds. @@ -7476,7 +7626,7 @@ C. =item B B|B -If set the B, append the name of the I (DS) to the +If set to B, append the name of the I (DS) to the "service", i.e. the field that, together with the "host" field, uniquely identifies a metric in I. If set to B (the default), this is only done when there is more than one DS. @@ -7521,6 +7671,116 @@ attribute for each metric being sent out to I. =back +=head2 Plugin C + +The I will send values to I, a powerful stream +aggregation and monitoring system. The plugin sends I encoded data to +a local I client using a TCP socket. + +At the moment, the I does not send over a collectd_host +parameter so it is not possible to use one collectd instance as a gateway for +others. Each collectd host must pair with one I client. + +Synopsis: + + + + Host "localhost" + Port "3030" + StoreRates true + AlwaysAppendDS false + MetricHandler "influx" + MetricHandler "default" + NotificationHandler "flapjack" + NotificationHandler "howling_monkey" + Notifications true + + Tag "foobar" + Attribute "foo" "bar" + + +The following options are understood by the I: + +=over 4 + +=item EB IE + +The plugin's configuration consists of one or more B blocks. Each block +is given a unique I and specifies one connection to an instance of +I. Inside the B block, the following per-connection options are +understood: + +=over 4 + +=item B I
+ +Hostname or address to connect to. Defaults to C. + +=item B I + +Service name or port number to connect to. Defaults to C<3030>. + +=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. + +This will be reflected in the C tag: If +B is enabled, converted values will have "rate" appended to the +data source type, e.g. C. + +=item B B|B + +If set the B, append the name of the I (DS) to the +"service", i.e. the field that, together with the "host" field, uniquely +identifies a metric in I. If set to B (the default), this is +only done when there is more than one DS. + +=item B B|B + +If set to B, create I events for notifications. This is B +by default. At least one of B or B should be enabled. + +=item B B|B + +If set to B, create I events for metrics. This is B +by default. At least one of B or B should be enabled. + + +=item B I + +Sets the separator for I metrics name or checks. Defaults to "/". + +=item B I + +Add a handler that will be set when metrics are sent to I. You can add +several of them, one per line. Defaults to no handler. + +=item B I + +Add a handler that will be set when notifications are sent to I. You can +add several of them, one per line. Defaults to no handler. + +=item B I + +Add the given string as a prefix to the event service name. +If B not set or set to an empty string (""), +no prefix will be used. + +=back + +=item B I + +Add the given string as an additional tag to the metric being sent to +I. + +=item B I I + +Consider the two given strings to be the key and value of an additional +attribute for each metric being sent out to I. + +=back + =head2 Plugin C The I will collect statistics from a I server