X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=a65d432bd2ed0e20721ee51fb09763f27ce43f03;hb=e1812f8e5c5f91328398c66b602d07ee7c6ede51;hp=60cc9b525621f4e36c0e411327759fc5e0c81a9d;hpb=3949234bad21a8dfd3c4a8298cbef2c7083170da;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 60cc9b52..a65d432b 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -9,17 +9,17 @@ collectd.conf - Configuration for the system statistics collection daemon B Interval 3600 ValuesPercentage true - + LoadPlugin ping Host "example.org" @@ -4245,6 +4245,70 @@ short: If it works for you: Great! But keep in mind that the config I change, though this is unlikely. Oh, and if you want to help improving this plugin, just send a short notice to the mailing list. ThanksE:) +=head2 Plugin C + +To use the C plugin you first need to configure the I +server correctly. The backend database C needs to be loaded and +working. See slapd-monitor(5) for the details. + +The configuration of the C plugin consists of one or more B +blocks. Each block requires one string argument as the instance name. For +example: + + + + URL "ldap://localhost/" + + + URL "ldaps://localhost/" + + + +The instance name will be used as the I. To emulate the old +(versionE4) behavior, you can use an empty string (""). In order for the +plugin to work correctly, each instance name must be unique. This is not +enforced by the plugin and it is your responsibility to ensure it is. + +The following options are accepted within each B block: + +=over 4 + +=item B I + +Sets the URL to use to connect to the I server. This option is +I. + +=item B B + +Defines whether TLS must be used when connecting to the I server. +Disabled by default. + +=item B B + +Enables or disables peer host name verification. If enabled, the plugin checks +if the C or a C field of the SSL +certificate matches the host name provided by the B option. If this +identity check fails, the connection is aborted. Enabled by default. + +=item B I + +File that holds one or more SSL certificates. If you want to use TLS/SSL you +may possibly need this option. What CA certificates are checked by default +depends on the distribution you use and can be changed with the usual ldap +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. + +=item B I + +An integer which sets the LDAP protocol version number to use when connecting +to the I server. Defaults to B<3> for using I. + +=back + =head2 Plugin C The OpenVPN plugin reads a status file maintained by OpenVPN and gathers @@ -4898,6 +4962,10 @@ Specify the username to be used when connecting to the server. Specify the password to be used when connecting to the server. +=item B I + +Skip expired values in query output. + =item B I|I|I|I Specify whether to use an SSL connection when contacting the server. The @@ -5269,6 +5337,10 @@ which configures the connection parameters for this node. Host "localhost" Port "6379" Timeout 2000 + + Type "queue_length" + Instance "myqueue" + @@ -5306,6 +5378,22 @@ read function is blocking, you should keep this value as low as possible. Keep in mind that the sum of all B values for all B should be lower than B defined globally. +=item B I + +The B block identifies a query to execute against the redis server. +There may be an arbitrary number of queries to execute. + +=item B I + +Within a query definition, a valid collectd type to use as when submitting +the result of the query. When not supplied, will default to B. + +=item B I + +Within a query definition, an optional type instance to use when submitting +the result of the query. When not supplied will default to the escaped +command, up to 64 chars. + =back =head2 Plugin C @@ -5639,6 +5727,40 @@ measurements are discarded. =back +=head2 Plugin C + +The C plugin collects SMART information from physical +disks. Values collectd include temperature, power cycle count, poweron +time and bad sectors. Also, all SMART attributes are collected along +with the normalized current value, the worst value, the threshold and +a human readable value. + +Using the following two options you can ignore some disks or configure the +collection only of specific disks. + +=over 4 + +=item B I + +Select the disk I. Whether it is collected or ignored depends on the +B setting, see below. As with other plugins that use the +daemon's ignorelist functionality, a string that starts and ends with a slash +is interpreted as a regular expression. Examples: + + Disk "sdd" + Disk "/hda[34]/" + +=item B B|B + +Sets whether selected disks, i.Ee. the ones matches by any of the B +statements, are ignored or if all other disks are ignored. The behavior +(hopefully) is intuitive: If no B option is configured, all disks are +collected. If at least one B option is given and no B or +set to B, B matching disks will be collected. If B +is set to B, all disks are collected B the ones matched. + +=back + =head2 Plugin C Since the configuration of the C is a little more complicated than @@ -5690,7 +5812,20 @@ that I of all reported timers are smaller than or equal to the computed latency. This is useful for cutting off the long tail latency, as it's often done in I (SLAs). -If not specified, no percentile is calculated / dispatched. +Different percentiles can be calculated by setting this option several times. +If none are specified, no percentiles are calculated / dispatched. + +=item B B|B + +=item B B|B + +=item B B|B + +=item B B|B + +Calculate and dispatch various values out of I metrics received during +an interval. If set to B, the default, these values aren't calculated / +dispatched. =back @@ -6176,6 +6311,11 @@ connections a mail server or news server has to other mail or news servers, or how many connections a web proxy holds to web servers. You have to give the port in numeric form. +=item B I|I + +If this option is set to I a summary of statistics from all connections +are collectd. This option defaults to I. + =back =head2 Plugin C @@ -6514,7 +6654,7 @@ will be collected. =item B B -When the libvirt plugin logs data, it sets the hostname of the collected data +When the virt plugin logs data, it sets the hostname 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. @@ -6530,7 +6670,7 @@ between, thus I<"foo:1234-1234-1234-1234">). =item B B|B
-When the libvirt plugin logs interface data, it sets the name of the collected +When the virt plugin logs interface data, it sets the name of the collected data according to this setting. The default is to use the path as provided by the hypervisor (the "dev" property of the target node), which is equal to setting B. @@ -6540,7 +6680,7 @@ interface path might change between reboots of a guest or across migrations. =item B B -When the libvirt plugin logs data, it sets the plugin_instance of the collected +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. @@ -6978,6 +7118,61 @@ want to set B to your Kafka broker list. =back +=head2 Plugin C + +The I submits values to I, a data structure server. + +Synopsis: + + + + Host "localhost" + Port "6379" + Timeout 1000 + + + +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 +L and L for +details. + +The information shown in the synopsis above is the I +which is used by the plugin if no configuration is present. + +The plugin can send values to multiple instances of I by specifying +one B block for each instance. Within the B blocks, the following +options are available: + +=over 4 + +=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 +canonical identifier which is used as I. It is limited to +64Echaracters in length. + +=item B I + +The B option is the hostname or IP-address where the I instance is +running on. + +=item B I + +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 + +The B option sets the socket connection timeout, in milliseconds. + +=back + =head2 Plugin C The I will send values to I, a powerful stream @@ -7025,6 +7220,20 @@ Service name or port number to connect to. Defaults to C<5555>. Specify the protocol to use when communicating with I. Defaults to B. +=item B B|B + +If set to B and B is set to B, +events will be batched in memory and flushed at +regular intervals or when B is exceeded. + +Notifications are not batched and sent as soon as possible. + +Defaults to false + +=item B I + +Maximum payload size for a riemann packet. Defaults to 8192 + =item B B|B If set to B (the default), convert counter values to rates. If set to