X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=0c8e1e2011635a1b17361db5851e1fa1ff9ffe2c;hb=0c88d3b2d330c152be0bc6af8faecef0211a705e;hp=524c435bfa497330cf9a528caea451fb61bccf49;hpb=09c57e6f2fa67509f815245329610ef0658709f7;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 524c435b..0c8e1e20 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 @@ -775,6 +774,18 @@ 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 +milliseconds. By default, the configured B is used to set the +timeout. + =back =head2 Plugin C @@ -863,6 +874,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 + +The B option sets the overall timeout for HTTP requests to B, in +milliseconds. By default, the configured B is used to set the +timeout. + =back =head2 Plugin C @@ -1160,6 +1177,12 @@ Collect global memory statistics. Default: Enabled. +=item B I + +The B option sets the overall timeout for HTTP requests to B, in +milliseconds. By default, the configured B is used to set the +timeout. + =item B I Collect statistics about a specific I<"view">. BIND can behave different, @@ -1488,6 +1511,10 @@ C). Measure response time for the request. If this setting is enabled, B blocks (see below) are optional. Disabled by default. +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. + =item B B|B Measure response code for the request. If this setting is enabled, B @@ -1502,6 +1529,18 @@ plugin below on how matches are defined. If the B or B options are set to B, B blocks are optional. +=item B I + +The B option sets the overall timeout for HTTP requests to B, in +milliseconds. By default, the configured B is used to set the +timeout. Prior to version 5.5.0, there was no timeout and requests could hang +indefinitely. This legacy behaviour can be achieved by setting the value of +B to 0. + +If B is 0 or bigger than the B, keep in mind that each slow +network connection will stall one read thread. Adjust the B global +setting accordingly to prevent this from blocking other plugins. + =back =head2 Plugin C @@ -1588,6 +1627,8 @@ URL. By default the global B setting will be used. =item B I +=item B I + These options behave exactly equivalent to the appropriate options of the I plugin. Please see there for a detailed description. @@ -1688,6 +1729,8 @@ Examples: =item B I +=item B I + These options behave exactly equivalent to the appropriate options of the I. Please see there for a detailed description. @@ -2221,6 +2264,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. + +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 @@ -4115,6 +4179,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 + +The B option sets the overall timeout for HTTP requests to B, in +milliseconds. By default, the configured B is used to set the +timeout. + =back =head2 Plugin C @@ -5083,6 +5153,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 @@ -5517,7 +5594,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 @@ -6531,6 +6608,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 @@ -7045,7 +7195,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. @@ -7349,7 +7499,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. @@ -7477,6 +7627,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