X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=7eaac5b096484c3f886d56275e84f29217324db7;hb=d8a02e6c6f5875dfcab7b011d1f340e3a13c9e39;hp=4117c7626b4ad91832f8936078bc94492bf10f4b;hpb=cfe801cf0236ea2fade924e0f2b5ce3d1a51698a;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 4117c762..7eaac5b0 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 @@ -502,7 +501,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. @@ -1547,7 +1546,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 +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 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 @@ -2480,12 +2500,6 @@ other interfaces are collected. =back -=head2 Plugin C - -The I allows to B to gather information about -process IPC mechanims, like used semaphores, size of shared memory -segments and others. - =head2 Plugin C =over 4 @@ -5139,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 @@ -5573,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 @@ -6587,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 @@ -6882,6 +6976,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 @@ -6900,6 +6998,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 @@ -7101,7 +7203,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. @@ -7405,7 +7507,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. @@ -7488,7 +7590,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.