X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=2ee22197cbbdba2343869775a543fc7f7c142b69;hb=dd8429c16bc57f949abb2537e003b76ad88b6f90;hp=a65d432bd2ed0e20721ee51fb09763f27ce43f03;hpb=dbeee0cfad69e701ea2665001fd9f2bce49c9489;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index a65d432b..2ee22197 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -2880,8 +2880,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 +2890,7 @@ B RegisterBase 0 RegisterType float + RegisterCmd ReadHolding Type voltage Instance "input-1" @@ -2897,10 +2898,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 +2923,17 @@ B + + Device "/dev/ttyUSB0" + Baudrate 38400 + Interval 20 + + + Instance "temperature" + Collect "supply-temperature-1" + + + =over 4 =item EB IE blocks @@ -2936,6 +2957,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 +2987,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 +3014,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 +3145,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 +5534,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 +6128,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 +6138,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 +6962,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. @@ -7218,7 +7270,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 +7280,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 +7347,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