X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=994c9da4f0cd409eda8841f621d548e7a97d1c4b;hb=47f4026f7791ab81d98fe63fed5dd557b76aab5e;hp=1b73c417d9ebfc54211eefc252116d733a0b9c96;hpb=7fc4c1f412c4002b787b5ce24b08e3091ced08a5;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 1b73c417..994c9da4 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -730,6 +730,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 @@ -1072,13 +1095,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). @@ -1098,11 +1123,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: @@ -1559,17 +1603,17 @@ transfer agents and web caches. =item B B|B -Enables or disables reporting of free, used and used disk space in 1K-blocks. -Defaults to true. +Enables or disables reporting of free, used and used disk space in 1K-blocks. +Defaults to B. -=item B B|B +=item B B|B Enables or disables reporting of free, used and used disk space in percentage. -Defaults to false. +Defaults to B. -This is useful for deploying collectd on the cloud, where machines with -different disk size may exist. Then it is more practical to configure thresholds -based on relative disk size. +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 @@ -2155,6 +2199,25 @@ interface path might change between reboots of a guest or across migrations. =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 @@ -2367,11 +2430,11 @@ B Temperature vddg Temperature vddq IgnoreSelectedTemperature true - + ShowPower true Power total0 Power total1 - IgnoreSelectedPower true + IgnoreSelectedPower true The following options are valid inside the Bmic> block: @@ -2428,7 +2491,7 @@ Fan In =item fout -Fan Out +Fan Out =item vccp @@ -2469,11 +2532,11 @@ Known power names are: =item total0 -Total power utilization averaged over Time Window 0 (uWatts). +Total power utilization averaged over Time Window 0 (uWatts). =item total1 -Total power utilization averaged over Time Window 0 (uWatts). +Total power utilization averaged over Time Window 0 (uWatts). =item inst @@ -2481,31 +2544,31 @@ Instantaneous power (uWatts). =item imax -Max instantaneous power (uWatts). +Max instantaneous power (uWatts). =item pcie -PCI-E connector power (uWatts). +PCI-E connector power (uWatts). =item c2x3 -2x3 connector power (uWatts). +2x3 connector power (uWatts). =item c2x4 -2x4 connector power (uWatts). +2x4 connector power (uWatts). =item vccp -Core rail (uVolts). +Core rail (uVolts). =item vddg -Uncore rail (uVolts). +Uncore rail (uVolts). =item vddq -Memory subsystem rail (uVolts). +Memory subsystem rail (uVolts). =back @@ -5293,6 +5356,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 @@ -6041,7 +6117,7 @@ Synopsis: Host "localhost" Port "2003" - Protocol "udp" + Protocol "tcp" LogSendErrors true Prefix "collectd" @@ -6244,6 +6320,7 @@ Synopsis: TTLFactor 2.0 Tag "foobar" + Attribute "foo" "bar" The following options are understood by the I: @@ -6304,6 +6381,11 @@ default value. Add the given string as an additional tag to the metric being sent to I. +=item B I I + +Consider the two given strings to be the key and value of an additional +attribute for each metric being sent out to I. + =back =head1 THRESHOLD CONFIGURATION @@ -6338,7 +6420,7 @@ When a value comes within range again or is received after it was missing, an Here is a configuration example to get you started. Read below for more information. - + WarningMin 0.00 WarningMax 1000.00 @@ -6369,7 +6451,7 @@ information. - + There are basically two types of configuration statements: The C, C, and C blocks select the value for which a threshold should be