X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcollectd.conf.pod;h=b2aab2139e1ce45633e2004609955c7e5b5a13f6;hb=1b4d95b869063e619bd7aae54cf37c5a1b91fbee;hp=d9721cefd8e71d7052ad9b338a67147bd53287b3;hpb=7c5cd3178a903871e57a8399bb19ce7ee15dd0f1;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index d9721cef..b2aab213 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 @@ -131,6 +130,15 @@ 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. +=item B I + +Specifies the 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 =item B B|B @@ -803,12 +811,22 @@ 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 + +By default, the plugin will try to keep the connection to UPS open between +reads. Since this appears to be somewhat brittle (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 in such cases. + +You can instruct the plugin to close the connection after each read by setting +this option to B. + =back =head2 Plugin C @@ -1547,7 +1565,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 @@ -2265,6 +2283,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 @@ -4474,6 +4513,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. @@ -5133,6 +5182,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 @@ -5395,6 +5451,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 @@ -5567,7 +5627,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 @@ -6581,6 +6641,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 @@ -7095,7 +7228,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. @@ -7361,14 +7494,16 @@ Synopsis: Host "localhost" Port "6379" Timeout 1000 + Prefix "collectd/" 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 -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. See L and L for details. @@ -7399,10 +7534,17 @@ 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. +=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. + =back =head2 Plugin C @@ -7531,10 +7673,11 @@ attribute for each metric being sent out to I. 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, write_sensu plugin -does not send over a collectd_host parameter so it not possible to use -one collectd instance as a gateway for other collectd: each collectd host -must write to its own sensu client. +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: @@ -7562,7 +7705,7 @@ The following options are understood by the I: 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. Indise the B block, the following per-connection options are +I. Inside the B block, the following per-connection options are understood: =over 4 @@ -7580,9 +7723,9 @@ Service name or port number to connect to. Defaults to C<3030>. 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. +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 @@ -7593,12 +7736,12 @@ only done when there is more than one DS. =item B B|B -If set to B, create sensu events for notifications. This is 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 sensu events for metrics. This is 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. @@ -7613,8 +7756,8 @@ 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. +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