X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=a0d6f892cc0cb6efe5b6fa677f306c5893cd5127;hp=1a89be3dfc4e7d36d2e7681b270f5cac6419aacf;hb=5b1d67d04e490d48dd72dbb9f84d1a74bfb9dcc1;hpb=fc1c7d7583eefd8fc3f2740015e5665dffe3e7c9 diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 1a89be3d..a0d6f892 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" @@ -519,6 +519,7 @@ possibly filtering or messages. # ExchangeType "fanout" # RoutingKey "collectd" # Persistent false + # ConnectionRetryDelay 0 # Format "command" # StoreRates false # GraphitePrefix "collectd." @@ -540,6 +541,7 @@ possibly filtering or messages. # QueueDurable false # QueueAutoDelete true # RoutingKey "collectd.#" + # ConnectionRetryDelay 0 @@ -630,6 +632,13 @@ mode will be used, i.e. delivery is guaranteed. If set to B (the default), the I delivery mode will be used, i.e. messages may be lost due to high load, overflowing queues or similar issues. +=item B I + +When the connection to the AMQP broker is lost, defines the time in seconds to +wait before attempting to reconnect. Defaults to 0, which implies collectd will +attempt to reconnect at each read interval (in Subscribe mode) or each time +values are ready for submission (in Publish mode). + =item B B|B|B (Publish only) Selects the format in which messages are sent to the broker. If set to @@ -1169,6 +1178,74 @@ By default no detailed zone information is collected. =back +=head2 Plugin C + +The ceph plugin collects values from JSON data to be parsed by B +(L) retrieved from ceph daemon admin sockets. + +A separate B block must be configured for each ceph daemon to be +monitored. The following example will read daemon statistics from four +separate ceph daemons running on the same device (two OSDs, one MON, one MDS) : + + + LongRunAvgLatency false + ConvertSpecialMetricTypes true + + SocketPath "/var/run/ceph/ceph-osd.0.asok" + + + SocketPath "/var/run/ceph/ceph-osd.1.asok" + + + SocketPath "/var/run/ceph/ceph-mon.ceph1.asok" + + + SocketPath "/var/run/ceph/ceph-mds.ceph1.asok" + + + +The ceph plugin accepts the following configuration options: + +=over 4 + +=item B B|B + +If enabled, latency values(sum,count pairs) are calculated as the long run +average - average since the ceph daemon was started = (sum / count). +When disabled, latency values are calculated as the average since the last +collection = (sum_now - sum_last) / (count_now - count_last). + +Default: Disabled + +=item B B|B + +If enabled, special metrics (metrics that differ in type from similar counters) +are converted to the type of those similar counters. This currently only +applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The +ceph schema reports this metric type as a sum,count pair while similar counters +are treated as derive types. When converted, the sum is used as the counter +value and is treated as a derive type. +When disabled, all metrics are treated as the types received from the ceph schema. + +Default: Enabled + +=back + +Each B block must have a string argument for the plugin instance name. +A B is also required for each B block: + +=over 4 + +=item B I + +Name to be used as the instance name for this daemon. + +=item B I + +Specifies the path to the UNIX admin socket of the ceph daemon. + +=back + =head2 Plugin C This plugin collects the CPU user/system time for each I by reading the @@ -2880,8 +2957,8 @@ which the sizes of physical memory vary. =head2 Plugin C -The B connects to a Modbus "slave" via Modbus/TCP and reads -register values. It supports reading single registers (unsigned 16Ebit +The B connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and +reads register values. It supports reading single registers (unsigned 16Ebit values), large integer values (unsigned 32Ebit values) and floating point values (two registers interpreted as IEEE floats in big endian notation). @@ -2890,6 +2967,7 @@ B RegisterBase 0 RegisterType float + RegisterCmd ReadHolding Type voltage Instance "input-1" @@ -2897,10 +2975,19 @@ B RegisterBase 2 RegisterType float + RegisterCmd ReadHolding Type voltage Instance "input-2" + + RegisterBase 0 + RegisterType Int16 + RegisterCmd ReadHolding + Type temperature + Instance "temp-1" + + Address "192.168.0.42" Port "502" @@ -2913,6 +3000,17 @@ B + + Device "/dev/ttyUSB0" + Baudrate 38400 + Interval 20 + + + Instance "temperature" + Collect "supply-temperature-1" + + + =over 4 =item EB IE blocks @@ -2936,6 +3034,11 @@ Specifies what kind of data is returned by the device. If the type is B, B or B, two 16Ebit registers will be read and the data is combined into one value. Defaults to B. +=item B B|B + +Specifies register type to be collected from device. Works only with libmodbus +2.9.2 or higher. Defaults to B. + =item B I Specifies the "type" (data set) to use when dispatching the value to @@ -2961,15 +3064,25 @@ Within EHostE/E blocks, the following options are allowed: =item B
I -Specifies the node name (the actual network address) used to connect to the -host. This may be an IP address or a hostname. Please note that the used -I library only supports IPv4 at the moment. +For Modbus/TCP, specifies the node name (the actual network address) used to +connect to the host. This may be an IP address or a hostname. Please note that +the used I library only supports IPv4 at the moment. =item B I -Specifies the port used to connect to the host. The port can either be given as -a number or as a service name. Please note that the I argument must be -a string, even if ports are given in their numerical form. Defaults to "502". +for Modbus/TCP, specifies the port used to connect to the host. The port can +either be given as a number or as a service name. Please note that the +I argument must be a string, even if ports are given in their numerical +form. Defaults to "502". + +=item B I + +For Modbus/RTU, specifies the path to the serial device being used. + +=item B I + +For Modbus/RTU, specifies the baud rate of the serial device. +Note, connections currently support only 8/N/1. =item B I @@ -2978,7 +3091,7 @@ host. By default the global B setting will be used. =item EB IE -Over each TCP connection, multiple Modbus devices may be reached. The slave ID +Over each connection, multiple Modbus devices may be reached. The slave ID is used to specify which device should be addressed. For each device you want to query, one B block must be given. @@ -3109,12 +3222,12 @@ Disabled by default. Enable the collection of master / slave statistics in a replication setup. In order to be able to get access to these statistics, the user needs special -privileges. See the B documentation above. +privileges. See the B documentation above. Defaults to B. =item B I If enabled, the plugin sends a notification if the replication slave I/O and / -or SQL threads are not running. +or SQL threads are not running. Defaults to B. =item B I @@ -4245,6 +4358,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 +5075,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 +5450,10 @@ which configures the connection parameters for this node. Host "localhost" Port "6379" Timeout 2000 + + Type "queue_length" + Instance "myqueue" + @@ -5306,6 +5491,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 @@ -5410,6 +5611,14 @@ Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option. I must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and one (exclusive). +=item B B|B + +When set to B, various statistics about the I daemon will be +collected, with "rrdcached" as the I. Defaults to B. + +Statistics are read via Is socket using the STATS command. +See L for details. + =back =head2 Plugin C @@ -5639,6 +5848,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 +5933,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 @@ -5949,6 +6205,8 @@ Use the last number found. The matched number is a counter. Simply I the internal counter to this value. Variants exist for C, C, and C data sources. +=item B + =item B =item B @@ -5957,6 +6215,8 @@ Add the matched value to the internal counter. In case of B, the matched number may be negative, which will effectively subtract from the internal counter. +=item B + =item B =item B @@ -6176,6 +6436,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 @@ -6305,22 +6570,35 @@ Take the UUID from the given file (default I). =head2 Plugin C The I collects information about Varnish, an HTTP accelerator. +It collects a subset of the values displayed by L, and +organizes them in categories which can be enabled or disabled. Currently only +metrics shown in L's I
section are collected. The exact +meaning of each metric can be found in L. Synopsis: + CollectBackend true + CollectBan false CollectCache true CollectConnections true - CollectBackend true - CollectSHM true + CollectDirectorDNS false CollectESI false CollectFetch false CollectHCB false + CollectObjects false + CollectPurge false + CollectSession false + CollectSHM true CollectSMA false CollectSMS false CollectSM false + CollectStruct false CollectTotals false + CollectUptime false + CollectVCL false + CollectVSM false CollectWorkers false @@ -6334,29 +6612,24 @@ Inside each EBE blocks, the following options are recognized: =over 4 -=item B B|B - -Cache hits and misses. True by default. - -=item B B|B - -Number of client connections received, accepted and dropped. True by default. - =item B B|B Back-end connection statistics, such as successful, reused, and closed connections. True by default. -=item B B|B - -Statistics about the shared memory log, a memory region to store -log messages which is flushed to disk when full. True by default. - =item B B|B Statistics about ban operations, such as number of bans added, retired, and number of objects tested against ban operations. Only available with Varnish -3.x. False by default. +3.x and above. False by default. + +=item B B|B + +Cache hits and misses. True by default. + +=item B B|B + +Number of client connections received, accepted and dropped. True by default. =item B B|B @@ -6390,7 +6663,14 @@ number of objects tested against purge operations. Only available with Varnish =item B B|B Client session statistics. Number of past and current sessions, session herd and -linger counters, etc. False by default. +linger counters, etc. False by default. Note that if using Varnish 4.x, some +metrics found in the Connections and Threads sections with previous versions of +Varnish have been moved here. + +=item B B|B + +Statistics about the shared memory log, a memory region to store +log messages which is flushed to disk when full. True by default. =item B B|B @@ -6421,12 +6701,17 @@ the number of requests and bytes transferred. False by default. =item B B|B -Varnish uptime. False by default. +Varnish uptime. Only available with Varnish 3.x and above. False by default. =item B B|B Number of total (available + discarded) VCL (config files). False by default. +=item B B|B + +Collect statistics about Varnish's shared memory usage (used by the logging and +statistics subsystems). Only available with Varnish 4.x. False by default. + =item B B|B Collect statistics about worker threads. False by default. @@ -6494,7 +6779,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. @@ -6510,7 +6795,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. @@ -6520,7 +6805,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. @@ -6754,25 +7039,29 @@ want to use authentication all three fields must be set. This output plugin submits values to an HTTP server using POST requests and encoding metrics with JSON or using the C command described in -L. Each destination you want to post data to needs to -have one B block, within which the destination can be configured further, -for example by specifying authentication data. +L. Synopsis: - + + URL "http://example.com/post-collectd" User "collectd" Password "weCh3ik0" Format JSON - + -B blocks need one string argument which is used as the URL to which data -is posted. The following options are understood within B blocks. +The plugin can send values to multiple HTTP servers by specifying one +EBEIE block for each server. Within each B +block, the following options are available: =over 4 +=item B I + +URL to which the values are submitted to. Mandatory. + =item B I Optional user name needed for authentication. @@ -6851,13 +7140,13 @@ Defaults to C<4096>. =item B B -If set to B, average transfer speed in bytes per second will be checked. -In case it is below B connection will be considered slow +If set to B, average transfer speed in bytes per second will be checked. +In case it is below B connection will be considered slow and aborted. =item B I -Sets bytes per second value for B to make a decission if +Sets bytes per second value for B to make a decission if connection is too slow. Default value is C<100>. =item B I @@ -6974,6 +7263,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 @@ -7019,7 +7363,26 @@ Service name or port number to connect to. Defaults to C<5555>. =item B B|B Specify the protocol to use when communicating with I. Defaults to -B. +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. + +When enabled, it can occur that events get processed by the Riemann server +close to or after their expiration time. Tune the B and +B settings according to the amount of values collected, if this +is an issue. + +Defaults to true + +=item B I + +Maximum payload size for a riemann packet. Defaults to 8192 =item B B|B @@ -7077,6 +7440,31 @@ attribute for each metric being sent out to I. =back +=head2 Plugin C + +The I will collect statistics from a I server +using the mntr command. It requires Zookeeper 3.4.0+ and access to the +client port. + +B + + + Host "127.0.0.1" + Port "2181" + + +=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<2181>. + +=back + =head1 THRESHOLD CONFIGURATION Starting with version C<4.3.0> collectd has support for B. By that