X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=a0d6f892cc0cb6efe5b6fa677f306c5893cd5127;hb=5b1d67d04e490d48dd72dbb9f84d1a74bfb9dcc1;hp=a65d432bd2ed0e20721ee51fb09763f27ce43f03;hpb=3c15b0e6fa66db107025ae08d3bbb9824d987a89;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index a65d432b..a0d6f892 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -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 @@ -5498,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 @@ -6084,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 @@ -6092,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 @@ -6914,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. @@ -7009,6 +7138,22 @@ are available on the server side. I must be at least 1024 and cannot exceed the size of an C, i.e. 2EGByte. 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 +and aborted. + +=item B I + +Sets bytes per second value for B to make a decission if +connection is too slow. Default value is C<100>. + +=item B I + +If defined, provided positive integer value will be used to set maximum time +in seconds that you allow for transfer(http post) operation to take. + =back =head2 Plugin C @@ -7218,7 +7363,7 @@ 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 @@ -7228,7 +7373,12 @@ regular intervals or when B is exceeded. Notifications are not batched and sent as soon as possible. -Defaults to false +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 @@ -7290,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