X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=3a8af849b722a33bdfa08ef44c03c311f0a03cde;hb=103f05e098865196fc5f28df51e99b64fd6b5202;hp=69e5005635c24998001eeab65f8e6016b9c27857;hpb=96e0f2341bace029acefe0a88bab96ae326c0ff5;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 69e50056..3a8af849 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -9,14 +9,14 @@ collectd.conf - Configuration for the system statistics collection daemon B Interval 3600 - + LoadPlugin ping Host "example.org" @@ -70,17 +70,33 @@ directory for the daemon. =item B I -Loads the plugin I. There must be at least one such line or B -will be mostly useless. +Loads the plugin I. This is required to load plugins, unless the +B option is enabled (see below). Without any loaded plugins, +I will be mostly useless. -Starting with collectd 4.9, this may also be a block in which further options -affecting the behavior of B may be specified. The following -options are allowed inside a B block: +Only the first B statement or block for a given plugin name has any +effect. This is useful when you want to split up the configuration into smaller +files and want each file to be "self contained", i.e. it contains a B +block I then appropriate B statement. The downside is that if +you have multiple conflicting B blocks, e.g. when they specify +different intervals, only one of them (the first one encountered) will take +effect and all others will be silently ignored. - - Globals true - Interval 10 - +B may either be a simple configuration I or a I +with additional options, affecting the behavior of B. A simple +statement looks like this: + + LoadPlugin "cpu" + +Options inside a B block can override default settings and +influence the way plugins are loaded, e.g.: + + + Globals true + Interval 60 + + +The following options are valid inside B blocks: =over 4 @@ -111,7 +127,20 @@ interval, that setting will take precedence. =back -=item B I +=item B B|B + +When set to B (the default), each plugin needs to be loaded explicitly, +using the B statement documented above. If a +BPluginE...E> block is encountered and no configuration +handling callback for this plugin has been registered, a warning is logged and +the block is ignored. + +When set to B, explicit B statements are not required. Each +BPluginE...E> block acts as if it was immediately preceded by a +B statement. B statements are still required for +plugins that don't provide any configuration, e.g. the I. + +=item B I [I] If I points to a file, includes that file. If I points to a directory, recursively includes all files within that directory and its @@ -206,6 +235,36 @@ Number of threads to start for dispatching value lists to write plugins. The default value is B<5>, but you may want to increase this if you have more than five plugins that may take relatively long to write to. +=item B I + +=item B I + +Metrics are read by the I and then put into a queue to be handled +by the I. If one of the I is slow (e.g. network +timeouts, I/O saturation of the disk) this queue will grow. In order to avoid +running into memory issues in such a case, you can limit the size of this +queue. + +By default, there is no limit and memory may grow indefinitely. This is most +likely not an issue for clients, i.e. instances that only handle the local +metrics. For servers it is recommended to set this to a non-zero value, though. + +You can set the limits using B and B. +Each of them takes a numerical argument which is the number of metrics in the +queue. If there are I metrics in the queue, any new metrics I be +dropped. If there are less than I metrics in the queue, all new metrics +I be enqueued. If the number of metrics currently in the queue is between +I and I, the metric is dropped with a probability that is +proportional to the number of metrics in the queue (i.e. it increases linearly +until it reaches 100%.) + +If B is set to non-zero and B is +unset, the latter will default to half of B. + +If you do not want to randomly drop values when the queue size is between +I and I, set If B and +B to same value. + =item B I Sets the hostname that identifies a host. If you omit this setting, the @@ -282,10 +341,10 @@ The full example configuration looks like this: Plugin "cpu" Type "cpu" - + GroupBy "Host" GroupBy "TypeInstance" - + CalculateSum true CalculateAverage true @@ -361,13 +420,13 @@ The following example calculates the average usage of all "even" CPUs: Plugin "cpu" PluginInstance "/[0,2,4,6,8]$/" Type "cpu" - + SetPlugin "cpu" SetPluginInstance "even-%{aggregation}" - + GroupBy "Host" GroupBy "TypeInstance" - + CalculateAverage true @@ -438,7 +497,7 @@ possibly filtering or messages. # GraphiteSeparateInstances false # GraphiteAlwaysAppendDS false - + # Receive values from an AMQP broker Host "localhost" @@ -449,6 +508,8 @@ possibly filtering or messages. Exchange "amq.fanout" # ExchangeType "fanout" # Queue "queue_name" + # QueueDurable false + # QueueAutoDelete true # RoutingKey "collectd.#" @@ -501,9 +562,23 @@ be bound to this exchange. =item B I (Subscribe only) -Configures the I name to subscribe to. If no queue name was configures +Configures the I name to subscribe to. If no queue name was configured explicitly, a unique queue name will be created by the broker. +=item B B|B (Subscribe only) + +Defines if the I subscribed to is durable (saved to persistent storage) +or transient (will disappear if the AMQP broker is restarted). Defaults to +"false". + +This option should be used in conjunction with the I option on the +publish side. + +=item B B|B (Subscribe only) + +Defines if the I subscribed to will be deleted once the last consumer +unsubscribes. Defaults to "true". + =item B I In I blocks, this configures the routing key to set on all outgoing @@ -686,6 +761,29 @@ default for backwards compatibility, the time will be reported in minutes. =back +=head2 Plugin C + +This plugin collects the value of the available sensors in an +I5> board. AquaeroE5 is a water-cooling controller board, +manufactured by Aqua Computer GmbH L, with a USB2 +connection for monitoring and configuration. The board can handle multiple +temperature sensors, fans, water pumps and water level sensors and adjust the +output settings such as fan voltage or power used by the water pump based on +the available inputs using a configurable controller included in the board. +This plugin collects all the available inputs as well as some of the output +values chosen by this controller. The plugin is based on the I +library provided by I. + +=over 4 + +=item B I + +Device path of the AquaeroE5's USB HID (human interface device), usually +in the form C. If this option is no set the plugin will try +to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID. + +=back + =head2 Plugin C This plugin collects information about an Ascent server, a free server for the @@ -729,6 +827,131 @@ and are checked by default depends on the distribution you use. =back +=head2 Plugin C + +This plugin reads absolute air pressure using digital barometer sensor MPL115A2 +or MPL3115 from Freescale (sensor attached to any I2C bus available in +the computer, for HW details see +I or +I). +The sensor type - one fo these two - is detected automatically by the plugin +and indicated in the plugin_instance (typically you will see subdirectory +"barometer-mpl115" or "barometer-mpl3115"). + +The plugin provides absolute barometric pressure, air pressure reduced to sea +level (several possible approximations) and as an auxiliary value also internal +sensor temperature. It uses (expects/provides) typical metric units - pressure +in [hPa], temperature in [C], altitude in [m]. + +It was developed and tested under Linux only. The only platform dependency is +the standard Linux i2c-dev interface (the particular bus driver has to +support the SM Bus command subset). + +The reduction or normalization to mean sea level pressure requires (depedning on +selected method/approximation) also altitude and reference to temperature sensor(s). +When multiple temperature sensors are configured the minumum of their values is +always used (expecting that the warmer ones are affected by e.g. direct sun light +at that moment). + +Synopsis: + + + Device "/dev/i2c-0"; + Oversampling 512 + PressureOffset 0.0 + TemperatureOffset 0.0 + Normalization 2 + Altitude 238.0 + TemperatureSensor "myserver/onewire-F10FCA000800/temperature" + + +=over 4 + +=item B I + +Device name of the I2C bus to which the sensor is connected. Note that typically +you need to have loaded the i2c-dev module. +Using i2c-tools you can check/list i2c buses available on your system by: + + i2cdetect -l + +Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use: + + i2cdetect -y -a 0 + +This way you should be able to verify that the pressure sensor (either type) is +connected and detected on address 0x60. + +=item B I + +For MPL115 this is the size of the averaging window. To filter out sensor noise +a simple averaging using floating window of configurable size is used. The plugin +will use average of the last C measurements (value of 1 means no averaging). +Minimal size is 1, maximal 1024. + +For MPL3115 this is the oversampling value. The actual oversampling is performed +by the sensor and the higher value the higher accuracy and longer conversion time +(although nothing to worry about in the collectd context). Supported values are: +1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to +the closest supported one. Default is 128. + +=item B I + +You can further calibrate the sensor by supplying pressure and/or temperature offsets. +This is added to the measured/caclulated value (i.e. if the measured value is too high +then use negative offset). +In hPa, default is 0.0. + +=item B I + +You can further calibrate the sensor by supplying pressure and/or temperature offsets. +This is added to the measured/caclulated value (i.e. if the measured value is too high +then use negative offset). +In C, default is 0.0. + +=item B I + +Normalization method - what approximation/model is used to compute mean sea +level pressure from the air absolute pressure. + +Supported values of the C (integer between from 0 to 2) are: + +=over 5 + +=item B<0> - no conversion, absolute pressrure is simply copied over. For this method you + do not need to configure C or C. + +=item B<1> - international formula for conversion , +See I. +For this method you have to configure C but do not need C +(uses fixed global temperature average instead). + +=item B<2> - formula as recommended by the Deutsche Wetterdienst (German +Meteorological Service). +See I +For this method you have to configure both C and C. + +=back + + +=item B I + +The altitude (in meters) of the location where you meassure the pressure. + +=item B I + +Temperature sensor which should be used as a reference when normalizing the pressure. +When specified more sensors a minumum is found and uses each time. +The temperature reading directly from this pressure sensor/plugin +is typically not suitable as the pressure sensor +will be probably inside while we want outside temperature. +The collectd reference name is something like +/-/- +( is usually omitted when there is just single value type). +Or you can figure it out from the path of the output data files. + +=back + =head2 Plugin C Starting with BIND 9.5.0, the most widely used DNS server software provides @@ -755,17 +978,17 @@ Synopsis: ParseTime false OpCodes true QTypes true - + ServerStats true ZoneMaintStats true ResolverStats false MemoryStats true - + QTypes true ResolverStats true CacheRRSets true - + Zone "127.in-addr.arpa/IN" @@ -883,6 +1106,67 @@ By default no detailed zone information is collected. =back +=head2 Plugin C + +This plugin collects the CPU user/system time for each I by reading the +F files in the first cpuacct-mountpoint (typically +F on machines using systemd). + +=over 4 + +=item B I + +Select I based on the name. Whether only matching I are +collected or if they are ignored is controlled by the B option; +see below. + +=item B B|B + +Invert the selection: If set to true, all cgroups I the ones that +match any one of the criteria are collected. By default only selected +cgroups are collected if a selection is made. If no selection is configured +at all, B cgroups are selected. + +=back + +=head2 Plugin C + +This plugin collects IP conntrack statistics. + +=over 4 + +=item B + +Assume the B and B files to be found in +F instead of F. + +=back + +=head2 Plugin C + +The I collects CPU usage metrics. + +The following configuration options are available: + +=over 4 + +=item B B|B + +Reports non-idle CPU usage as the "active" value. Defaults to false. + +=item B B|B + +When true reports usage for all cores. When false, reports cpu usage +aggregated over all cores. +Defaults to true. + +=item B B|B + +When true report percentage usage instead of tick values. Defaults to false. + +=back + + =head2 Plugin C This plugin doesn't have any options. It reads @@ -956,6 +1240,10 @@ Username to use if authorization is required to read the page. Password to use if authorization is required to read the page. +=item B B|B + +Enable HTTP digest authentication. + =item B B|B Enable or disable peer SSL certificate verification. See @@ -1005,13 +1293,15 @@ is set to B, B blocks are optional. =head2 Plugin C -The B uses B (L) and -B (L) to retrieve JSON data -via cURL. This can be used to collect values from CouchDB documents (which are -stored JSON notation), for example. +The B collects values from JSON data to be parsed by +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 +latter to collect values from a uWSGI stats socket. -The following example will collect several values from the built-in `_stats' -runtime statistics module of CouchDB +The following example will collect several values from the built-in +C<_stats> runtime statistics module of I (L). @@ -1031,11 +1321,30 @@ runtime statistics module of CouchDB -In the B block, there may be one or more B blocks, each defining -a URL to be fetched via HTTP (using libcurl) and one or more B blocks. -The B string argument must be in a path format, which is used to collect a -value from a JSON map object. If a path element of B is the -I<*>Ewildcard, the values for all keys will be collectd. +This example will collect data directly from a I "Stats Server" socket. + + + + Instance "uwsgi" + + Type "http_requests" + + + + Type "http_requests" + + + + +In the B block, there may be one or more B blocks, each +defining a URL to be fetched via HTTP (using libcurl) or B +blocks defining a unix socket to read JSON from directly. Each of +these blocks may have one or more B blocks. + +The B string argument must be in a path format. Each component is +used to match the key from a JSON map or the index of an JSON +array. If a path component of a B is a I<*>Ewildcard, the +values for all map keys or array indices will be collectd. The following options are valid within B blocks: @@ -1045,12 +1354,25 @@ The following options are valid within B blocks: Sets the plugin instance to I. +=item B I + +Sets the interval (in seconds) in which the values will be collected from this +URL. By default the global B setting will be used. + =item B I + =item B I + +=item B B|B + =item B B|B + =item B B|B + =item B I + =item B
I
+ =item B I These options behave exactly equivalent to the appropriate options of the @@ -1139,6 +1461,8 @@ Examples: =item B I +=item B B|B + =item B B|B =item B B|B @@ -1378,6 +1702,16 @@ it should be able to handle integer an floating point types, as well as strings There must be at least one B option inside each B block. +=item B [I I ...] + +Names the columns whose content is used as metadata for the data sets +that are dispatched to the daemon. + +The actual data type in the columns is not that important. The plugin will +automatically cast the values to the right type if it know how to do that. So +it should be able to handle integer an floating point types, as well as strings +(if they include a number at the beginning). + =back =head3 B blocks @@ -1490,6 +1824,20 @@ Enable this option if inodes are a scarce resource for you, usually because many small files are stored on the disk. This is a usual scenario for mail transfer agents and web caches. +=item B B|B + +Enables or disables reporting of free and used disk space in 1K-blocks. +Defaults to B. + +=item B B|B + +Enables or disables reporting of free and used disk space in percentage. +Defaults to B. + +This is useful for deploying I on the cloud, where machines with +different disk size may exist. Then it is more practical to configure +thresholds based on relative disk size. + =back =head2 Plugin C @@ -1524,6 +1872,20 @@ 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. +=item B B|B + +Whether to use the device's "BSD Name", on MacEOSEX, instead of the +default major/minor numbers. Requires collectd to be built with Apple's +IOKitLib support. + +=item B I + +Attempt to override disk instance name with the value of a specified udev +attribute when built with B. If the attribute is not defined for the +given device, the default name is used. Example: + + UdevNameAttr "DM_NAME" + =back =head2 Plugin C @@ -2072,8 +2434,35 @@ setting B. B
means use the interface's mac address. This is useful since the 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 +data according to this setting. The default is to use the guest name as provided +by the hypervisor, which is equal to setting B. + +B means use the guest's UUID. + +=back + +=head2 Plugin C + +The I collects the system load. These numbers give a rough overview +over the utilization of a machine. The system load is defined as the number of +runnable tasks in the run-queue and is provided by many operating systems as a +one, five or fifteen minute average. + +The following configuration options are available: + +=over 4 + +=item B B|B + +When enabled, system load divided by number of available CPU cores is reported +for intervals 1 min, 5 min and 15 min. Defaults to false. + =back + =head2 Plugin C =over 4 @@ -2108,6 +2497,34 @@ B: There is no need to notify the daemon after moving or removing the log file (e.Eg. when rotating the logs). The plugin reopens the file for each line it writes. +=head2 Plugin C + +The I behaves like the logfile plugin but formats +messages as JSON events for logstash to parse and input. + +=over 4 + +=item B B + +Sets the log-level. If, for example, set to B, then all events with +severity B, B, or B will be written to the logfile. + +Please note that B is only available if collectd has been compiled with +debugging support. + +=item B I + +Sets the file to write log messages to. The special strings B and +B can be used to write to the standard output and standard error +channels, respectively. This, of course, only makes much sense when I +is running in foreground- or non-daemon-mode. + +=back + +B: There is no need to notify the daemon after moving or removing the +log file (e.Eg. when rotating the logs). The plugin reopens the file +for each line it writes. + =head2 Plugin C The I reads CPU statistics of I, a @@ -2238,35 +2655,216 @@ interpreted. For a description of match blocks, please see L<"Plugin tail">. =head2 Plugin C -The C connects to a memcached server and queries statistics +The B connects to a memcached server and queries statistics about cache utilization, memory and bandwidth used. L - - - Host "memcache.example.com" - Port 11211 - - + + + Host "memcache.example.com" + Port 11211 + + + +The plugin configuration consists of one or more B blocks which +specify one I connection each. Within the B blocks, the +following options are allowed: + +=over 4 + +=item B I + +Hostname to connect to. Defaults to B<127.0.0.1>. + +=item B I + +TCP-Port to connect to. Defaults to B<11211>. + +=item B I + +Connect to I using the UNIX domain socket at I. If this +setting is given, the B and B settings are ignored. + +=back + +=head2 Plugin C + +The B gathers CPU statistics, memory usage and temperatures from +Intel's Many Integrated Core (MIC) systems. + +B + + + ShowCPU true + ShowCPUCores true + ShowMemory true + + ShowTemperatures true + Temperature vddg + Temperature vddq + IgnoreSelectedTemperature true + + ShowPower true + Power total0 + Power total1 + IgnoreSelectedPower true + + +The following options are valid inside the Bmic> block: + +=over 4 + +=item B B|B + +If enabled (the default) a sum of the CPU usage across all cores is reported. + +=item B B|B + +If enabled (the default) per-core CPU usage is reported. + +=item B B|B + +If enabled (the default) the physical memory usage of the MIC system is +reported. + +=item B B|B + +If enabled (the default) various temperatures of the MIC system are reported. + +=item B I + +This option controls which temperatures are being reported. Whether matching +temperatures are being ignored or I matching temperatures are reported +depends on the B setting below. By default I +temperatures are reported. + +=item B B|B + +Controls the behavior of the B setting above. If set to B +(the default) only temperatures matching a B option are reported +or, if no B option is specified, all temperatures are reported. If +set to B, matching temperatures are I and all other temperatures +are reported. + +Known temperature names are: + +=over 4 + +=item die + +Die of the CPU + +=item devmem + +Device Memory + +=item fin + +Fan In + +=item fout + +Fan Out + +=item vccp + +Voltage ccp + +=item vddg + +Voltage ddg + +=item vddq + +Voltage ddq + +=back + +=item B B|B + +If enabled (the default) various temperatures of the MIC system are reported. + +=item B I + +This option controls which power readings are being reported. Whether matching +power readings are being ignored or I matching power readings are reported +depends on the B setting below. By default I +power readings are reported. + +=item B B|B + +Controls the behavior of the B setting above. If set to B +(the default) only power readings matching a B option are reported +or, if no B option is specified, all power readings are reported. If +set to B, matching power readings are I and all other power readings +are reported. + +Known power names are: + +=over 4 + +=item total0 + +Total power utilization averaged over Time Window 0 (uWatts). + +=item total1 + +Total power utilization averaged over Time Window 0 (uWatts). + +=item inst + +Instantaneous power (uWatts). + +=item imax + +Max instantaneous power (uWatts). + +=item pcie + +PCI-E connector power (uWatts). + +=item c2x3 + +2x3 connector power (uWatts). + +=item c2x4 + +2x4 connector power (uWatts). + +=item vccp + +Core rail (uVolts). + +=item vddg + +Uncore rail (uVolts). + +=item vddq + +Memory subsystem rail (uVolts). + +=back + +=back + +=head2 Plugin C -The plugin configuration consists of one or more B blocks which -specify one I connection each. Within the B blocks, the -following options are allowed: +The I provides the following configuration options: =over 4 -=item B I - -Hostname to connect to. Defaults to B<127.0.0.1>. +=item B B|B -=item B I +Enables or disables reporting of physical memory usage in absolute numbers, +i.e. bytes. Defaults to B. -TCP-Port to connect to. Defaults to B<11211>. +=item B B|B -=item B I +Enables or disables reporting of physical memory usage in percentages, e.g. +percent of physical memory used. Defaults to B. -Connect to I using the UNIX domain socket at I. If this -setting is given, the B and B settings are ignored. +This is useful for deploying I in a heterogeneous environment in +which the sizes of physical memory vary. =back @@ -2277,7 +2875,7 @@ 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). -Synopsis: +B RegisterBase 0 @@ -2285,19 +2883,19 @@ Synopsis: Type voltage Instance "input-1" - + RegisterBase 2 RegisterType float Type voltage Instance "input-2" - + Address "192.168.0.42" Port "502" Interval 60 - + Instance "power-supply" Collect "voltage-input-1" @@ -2428,9 +3026,11 @@ Synopsis: Password "password" Port "3306" MasterStats true + ConnectTimeout 10 + Alias "squeeze" Host "localhost" Socket "/var/run/mysql/mysqld.sock" SlaveStats true @@ -2445,6 +3045,11 @@ section "mysql_real_connect()" in the B. =over 4 +=item B I + +Alias to use as sender instead of hostname when reporting. This may be useful +when having cryptic hostnames. + =item B I Hostname of the database server. Defaults to B. @@ -2483,6 +3088,11 @@ only has any effect, if B is set to B (the default). Otherwise, use the B option above. See the documentation for the C function for details. +=item B I + +If enabled, metrics about the InnoDB storage engine are collected. +Disabled by default. + =item B I =item B I @@ -2496,6 +3106,10 @@ privileges. See the B documentation above. If enabled, the plugin sends a notification if the replication slave I/O and / or SQL threads are not running. +=item B I + +Sets the connect timeout for the MySQL client. + =back =head2 Plugin C @@ -2530,7 +3144,7 @@ Required capabilities are documented below. User "username" Password "aef4Aebe" Interval 30 - + Interval 30 GetNameCache true @@ -2538,12 +3152,12 @@ Required capabilities are documented below. GetBufferCache true GetInodeCache true - + Interval 30 GetBusy true - + Interval 30 GetIO "volume0" @@ -2553,7 +3167,7 @@ Required capabilities are documented below. GetLatency "volume0" IgnoreSelectedLatency false - + Interval 30 GetCapacity "vol0" @@ -2563,15 +3177,15 @@ Required capabilities are documented below. GetSnapshot "vol3" IgnoreSelectedSnapshot false - + Interval 60 - + Interval 30 - + Interval 30 GetCPULoad true @@ -3132,7 +3746,7 @@ signature): # Export to an internal server # (demonstrates usage without additional options) Server "collectd.internal.tld" - + # Export to an external server # (demonstrates usage with signature options) @@ -3521,13 +4135,36 @@ B See notes below. The C plugin uses the B library from the B project L to read sensors connected via the onewire bus. -Currently only temperature sensors (sensors with the family code C<10>, -e.Eg. DS1820, DS18S20, DS1920) can be read. If you have other sensors you -would like to have included, please send a sort request to the mailing list. +It can be used in two possible modes - standard or advanced. + +In the standard mode only temperature sensors (sensors with the family code +C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have +other sensors you would like to have included, please send a sort request to +the mailing list. You can select sensors to be read or to be ignored depending +on the option B). When no list is provided the whole bus is +walked and all sensors are read. Hubs (the DS2409 chips) are working, but read the note, why this plugin is experimental, below. +In the advanced mode you can configure any sensor to be read (only numerical +value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature"). +In this mode you have to list all the sensors. Neither default bus walk nor +B are used here. Address and type (file) is extracted from +the path automatically and should produce compatible structure with the "standard" +mode (basically the path is expected as for example +"/uncached/10.F10FCA000800/temperature" where it would extract address part +"F10FCA000800" and the rest after the slash is considered the type - here +"temperature"). +There are two advantages to this mode - you can access virtually any sensor +(not just temperature), select whether to use cached or directly read values +and it is slighlty faster. The downside is more complex configuration. + +The two modes are distinguished automatically by the format of the address. +It is not possible to mix the two modes. Once a full path is detected in any +B then the whole addressing (all sensors) is considered to be this way +(and as standard addresses will fail parsing they will be ignored). + =over 4 =item B I @@ -3548,14 +4185,23 @@ This directive is B and does not have a default value. =item B I -Selects sensors to collect or to ignore, depending on B, see -below. Sensors are specified without the family byte at the beginning, to you'd -use C, and B include the leading C<10.> family byte and -point. +In the standard mode selects sensors to collect or to ignore +(depending on B, see below). Sensors are specified without +the family byte at the beginning, so you have to use for example C, +and B include the leading C<10.> family byte and point. +When no B is configured the whole Onewire bus is walked and all supported +sensors (see above) are read. + +In the advanced mode the B specifies full OWFS path - e.g. +C (or when cached values are OK +C). B is not used. + +As there can be multiple devices on the bus you can list multiple sensor (use +multiple B elements). =item B I|I -If no configuration if given, the B plugin will collect data from all +If no configuration is given, the B plugin will collect data from all sensors found. This may not be practical, especially if sensors are added and removed regularly. Sometimes, however, it's easier/preferred to collect only specific sensors or all sensors I a few specified ones. This option @@ -3563,6 +4209,8 @@ enables you to do that: By setting B to I the effect of B is inverted: All selected interfaces are ignored and all other interfaces are collected. +Used only in the standard mode - see above. + =item B I Sets the interval in which all sensors should be read. If not specified, the @@ -4239,13 +4887,6 @@ Specify the password to be used when connecting to the server. Specify whether to use an SSL connection when contacting the server. The following modes are supported: -=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). - =over 4 =item I @@ -4266,6 +4907,13 @@ Use SSL only. =back +=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 Kerberos service name to use when authenticating with Kerberos 5 @@ -4907,12 +5555,129 @@ and all other sensors are collected. =back +=head2 Plugin C + +The I uses I to retrieve measurements from any device +supported by the L project. + +B + + + LogLevel 3 + + Driver "fluke-dmm" + MinimumInterval 10 + Conn "/dev/ttyUSB2" + + + Driver "cem-dt-885x" + Conn "/dev/ttyUSB1" + + + +=over 4 + +=item B B<0-5> + +The I logging level to pass on to the I log, as a number +between B<0> and B<5> (inclusive). These levels correspond to C, +C, C, C, Cand C, respectively. +The default is B<2> (C). The I log messages, regardless of +their level, are always submitted to I at its INFO log level. + +=item EB IE + +A sigrok-supported device, uniquely identified by this section's options. The +I is passed to I as the I. + +=item B I + +The sigrok driver to use for this device. + +=item B I + +If the device cannot be auto-discovered, or more than one might be discovered +by the driver, I specifies the connection string to the device. +It can be of the form of a device path (e.g.EC), or, in +case of a non-serial USB-connected device, the USB IB<.>I +separated by a period (e.g.EC<0403.6001>). A USB device can also be +specified as IB<.>I
(e.g.EC<1.41>). + +=item B I + +For serial devices with non-standard port settings, this option can be used +to specify them in a form understood by I, e.g.EC<9600/8n1>. +This should not be necessary; drivers know how to communicate with devices they +support. + +=item B I + +Specifies the minimum time between measurement dispatches to I, in +seconds. Since some I supported devices can acquire measurements many +times per second, it may be necessary to throttle these. For example, the +I cannot process writes more than once per second. + +The default B is B<0>, meaning measurements received from the +device are always dispatched to I. When throttled, unused +measurements are discarded. + +=back + =head2 Plugin C Since the configuration of the C is a little more complicated than other plugins, its documentation has been moved to an own manpage, L. Please see there for details. +=head2 Plugin C + +The I listens to a UDP socket, reads "events" in the statsd +protocol and dispatches rates or other aggregates of these numbers +periodically. + +The plugin implements the I, I, I and I types which +are dispatched as the I types C, C, C and +C respectively. + +The following configuration options are valid: + +=over 4 + +=item B I + +Bind to the hostname / address I. By default, the plugin will bind to the +"any" address, i.e. accept packets sent to any of the hosts addresses. + +=item B I + +UDP port to listen to. This can be either a service name or a port number. +Defaults to C<8125>. + +=item B B|B + +=item B B|B + +=item B B|B + +=item B B|B + +These options control what happens if metrics are not updated in an interval. +If set to B, the default, metrics are dispatched unchanged, i.e. the +rate of counters and size of sets will be zero, timers report C and gauges +are unchanged. If set to B, the such metrics are not dispatched and +removed from the internal cache. + +=item B I + +Calculate and dispatch the configured percentile, i.e. compute the latency, so +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. + +=back + =head2 Plugin C The I collects information about used and available swap space. On @@ -4935,6 +5700,19 @@ This option is only available if the I can read C When enabled, the I is reported in bytes. When disabled, the default, I is reported in pages. This option is available under Linux only. +=item B B|B + +Enables or disables reporting of absolute swap metrics, i.e. number of I +available and used. Defaults to B. + +=item B B|B + +Enables or disables reporting of relative swap metrics, i.e. I +available and free. Defaults to B. + +This is useful for deploying I in a heterogeneous environment, where +swap sizes differ and you want to specify generic thresholds or similar. + =back =head2 Plugin C @@ -5070,6 +5848,7 @@ user using (extended) regular expressions, as described in L. Instance "exim" + Interval 60 Regex "S=([1-9][0-9]*)" DSType "CounterAdd" @@ -5096,6 +5875,9 @@ This plugin instance is for all B blocks that B it, until the next B option. This way you can extract several plugin instances from one logfile, handy when parsing syslog and the like. +The B option allows you to define the length of time between reads. If +this is not set, the default Interval will be used. + Each B block has the following options to describe how the match should be performed: @@ -5554,6 +6336,17 @@ and closed connections. True by default. 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. + +=item B B|B + +DNS director lookup cache statistics. Only available with Varnish 3.x. False by +default. + =item B B|B Edge Side Includes (ESI) parse statistics. False by default. @@ -5567,10 +6360,27 @@ Statistics about fetches (HTTP requests sent to the backend). False by default. Inserts and look-ups in the crit bit tree based hash. Look-ups are divided into locked and unlocked look-ups. False by default. +=item B B|B + +Statistics on cached objects: number of objects expired, nuked (prematurely +expired), saved, moved, etc. False by default. + +=item B B|B + +Statistics about purge operations, such as number of purges added, retired, and +number of objects tested against purge operations. Only available with Varnish +2.x. False by default. + +=item B B|B + +Client session statistics. Number of past and current sessions, session herd and +linger counters, etc. False by default. + =item B B|B -malloc or umem (umem_alloc(3MALLOC) based) storage statistics. -The umem storage component is Solaris specific. False by default. +malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage +component is Solaris specific. Only available with Varnish 2.x. False by +default. =item B B|B @@ -5579,13 +6389,28 @@ component is used internally only. False by default. =item B B|B -file (memory mapped file) storage statistics. False by default. +file (memory mapped file) storage statistics. Only available with Varnish 2.x. +False by default. + +=item B B|B + +Current varnish internal state statistics. Number of current sessions, objects +in cache store, open connections to backends (with Varnish 2.x), etc. False by +default. =item B B|B Collects overview counters, such as the number of sessions created, the number of requests and bytes transferred. False by default. +=item B B|B + +Varnish uptime. 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 worker threads. False by default. @@ -5630,9 +6455,9 @@ iptables to feed data for the guest IPs into the iptables plugin. The C plugin writes data to I, an open-source metrics storage and graphing project. The plugin connects to I, the data layer -of I, and sends data via the "line based" protocol (per default using -portE2003). The data will be sent in blocks of at most 1428 bytes to -minimize the number of network packets. +of I, via I or I and sends data via the "line based" +protocol (per default using portE2003). The data will be sent in blocks +of at most 1428 bytes to minimize the number of network packets. Synopsis: @@ -5640,6 +6465,8 @@ Synopsis: Host "localhost" Port "2003" + Protocol "tcp" + LogSendErrors true Prefix "collectd" @@ -5657,6 +6484,17 @@ Hostname or address to connect to. Defaults to C. Service name or port number to connect to. Defaults to C<2003>. +=item B I + +Protocol to use when connecting to I. Defaults to C. + +=item B B|B + +If set to B (the default), logs errors when sending data to I. +If set to B, it will not log the errors. This is especially useful when +using Protocol UDP since many times we want to use the "fire-and-forget" +approach and logging errors fills syslog with unneeded messages. + =item B I When set, I is added in front of the host name. Dots and whitespace are @@ -5695,6 +6533,59 @@ more than one DS. =back +=head2 Plugin C + +The C plugin writes data to I, a scalable open-source +time series database. The plugin connects to a I, a masterless, no shared +state daemon that ingests metrics and stores them in HBase. The plugin uses +I over the "line based" protocol with a default port 4242. The data will +be sent in blocks of at most 1428 bytes to minimize the number of network +packets. + +Synopsis: + + + + Host "tsd-1.my.domain" + Port "4242" + HostTags "status=production" + + + +The configuration consists of one or more EBEIE +blocks. Inside the B blocks, the following options are recognized: + +=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<4242>. + + +=item B I + +When set, I is added to the end of the metric. It is intended to be +used for name=value pairs that the TSD will tag the metric with. Dots and +whitespace are I escaped in this string. + +=item B B|B + +If set to B, convert counter values to rates. If set to B +(the default) counter values are stored as is, as an increasing +integer number. + +=item B B|B + +If set the B, append the name of the I (DS) to the "metric" +identifier. If set to B (the default), this is only done when there is +more than one DS. + +=back + =head2 Plugin C The I will send values to I, a schema-less @@ -5796,6 +6687,33 @@ File that holds one or more SSL certificates. If you want to use HTTPS you will possibly need this option. What CA certificates come bundled with C and are checked by default depends on the distribution you use. +=item B I + +Directory holding one or more CA certificate files. You can use this if for +some reason all the needed CA certificates aren't in the same file and can't be +pointed to using the B option. Requires C to be built against +OpenSSL. + +=item B I + +File that holds the private key in PEM format to be used for certificate-based +authentication. + +=item B I + +File that holds the SSL certificate to be used for certificate-based +authentication. + +=item B I + +Password required to load the private key in B. + +=item B B|B|B|B|B|B + +Define which SSL protocol version must be used. By default C will +attempt to figure out the remote SSL protocol version. See +L for more details. + =item B B|B Format of the output to generate. If set to B, will create output that @@ -5812,9 +6730,114 @@ number. =back +=head2 Plugin C + +The I will send values to a I topic, a distributed +queue. +Synopsis: + + + Property "metadata.broker.list" "broker1:9092,broker2:9092" + + Format JSON + + + +The following options are understood by the I: + +=over 4 + +=item EB IE + +The plugin's configuration consists of one or more B blocks. Each block +is given a unique I and specifies one kafka producer. +Inside the B block, the following per-topic options are +understood: + +=over 4 + +=item B I I + +Configure the named property for the current topic. Properties are +forwarded to the kafka producer library B. + +=item B I + +Use the specified string as a partioning key for the topic. Kafka breaks +topic into partitions and guarantees that for a given topology, the same +consumer will be used for a specific key. The special (case insensitive) +string B can be used to specify that an arbitrary partition should +be used. + +=item B B|B|B + +Selects the format in which messages are sent to the broker. If set to +B (the default), values are sent as C commands which are +identical to the syntax used by the I and I. + +If set to B, the values are encoded in the I, +an easy and straight forward exchange format. + +If set to B, values are encoded in the I format, which is +" \n". + +=item B B|B + +Determines whether or not C, C and C data sources +are converted to a I (i.e. a C value). If set to B (the +default), no conversion is performed. Otherwise the conversion is performed +using the internal value cache. + +Please note that currently this option is only used if the B option has +been set to B. + +=item B (B=I only) + +A prefix can be added in the metric name when outputting in the I format. +It's added before the I name. +Metric name will be "" + +=item B (B=I only) + +A postfix can be added in the metric name when outputting in the I format. +It's added after the I name. +Metric name will be "" + +=item B (B=I only) + +Specify a character to replace dots (.) in the host part of the metric name. +In I metric name, dots are used as separators between different +metric parts (host, plugin, type). +Default is "_" (I). + +=item B B|B + +If set to B, the plugin instance and type instance will be in their own +path component, for example C. If set to B (the +default), the plugin and plugin instance (and likewise the type and type +instance) are put into one component, for example C. + +=item B B|B + +If set to B (the default), convert counter values to rates. If set to +B counter values are stored as is, i.e. as an increasing integer number. + +This will be reflected in the C tag: If B is enabled, +converted values will have "rate" appended to the data source type, e.g. +C. + +=back + +=item B I I + +Configure the kafka producer through properties, you almost always will +want to set B to your Kafka broker list. + +=back + =head2 Plugin C -The I will send values to I, a powerfull stream +The I will send values to I, a powerful stream aggregation and monitoring system. The plugin sends I encoded data to I using UDP packets. @@ -5827,9 +6850,10 @@ Synopsis: Protocol UDP StoreRates true AlwaysAppendDS false - Delay 10 + TTLFactor 2.0 Tag "foobar" + Attribute "foo" "bar" The following options are understood by the I: @@ -5874,6 +6898,26 @@ If set the B, append the name of the I (DS) to the identifies a metric in I. If set to B (the default), this is only done when there is more than one DS. +=item B I + +I events have a I