X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=d13932bb552bb67221f1b96d0b748081553922e7;hb=cc0fe32830bc2cfd1353c151aa1028107f5c05de;hp=6f5ee7fb0b2e7ad3b0efa6bcf385c3d7da182045;hpb=ea8c925a678839f21037c40a902924f4ead79e42;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 6f5ee7fb..d13932bb 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -3210,6 +3210,30 @@ Pause to apply between attempts of connection to gpsd in seconds (default 5 sec) =back +=head2 Plugin C + +Efficiently collects various statistics from the system's NVIDIA GPUs using the +NVML library. Currently collected are fan speed, core temperature, percent +load, percent memory used, compute and memory frequencies, and power +consumption. + +=over 4 + +=item B + +If one or more of these options is specified, only GPUs at that index (as +determined by nvidia-utils through I) have statistics collected. +If no instance of this option is specified, all GPUs are monitored. + +=item B + +If set to true, all detected GPUs B the ones at indices specified by +B entries are collected. For greater clarity, setting IgnoreSelected +without any GPUIndex directives will result in B statistics being +collected. + +=back + =head2 Plugin C The I plugin provides an RPC interface to submit values to or query @@ -5309,8 +5333,9 @@ When configuring with B only the basic statistics will be collected, namely octets, packets, and errors. These statistics are collected by the C plugin, too, so using both at the same time is no benefit. -When configured with B all counters B the basic ones, -so that no data needs to be collected twice if you use the C plugin. +When configured with B all counters B the basic ones +will be collected, so that no data needs to be collected twice if you use the +C plugin. This includes dropped packets, received multicast packets, collisions and a whole zoo of differentiated RX and TX errors. You can try the following command to get an idea of what awaits you: @@ -6250,6 +6275,7 @@ B Address "127.0.0.1" Socket "/var/run/openvswitch/db.sock" Bridges "br0" "br_ext" + InterfaceStats false The plugin provides the following configuration options: @@ -6283,6 +6309,13 @@ omitted or is empty then all OVS bridges will be monitored. Default: empty (monitor all bridges) +=item B B|B + +Indicates that the plugin should gather statistics for individual interfaces +in addition to ports. This can be useful when monitoring an OVS setup with +bond ports, where you might wish to know individual statistics for the +interfaces included in the bonds. Defaults to B. + =back =head2 Plugin C @@ -8364,26 +8397,26 @@ Sets how the values are cumulated. I is one of: =item B -Calculate the average. +Calculate the average of all values matched during the interval. =item B -Use the smallest number only. +Report the smallest value matched during the interval. =item B -Use the greatest number only. +Report the greatest value matched during the interval. =item B -Use the last number found. +Report the last value matched during the interval. =item B -Use the last number found. The number is not reset at the end of an interval. -It is continously reported until another number is matched. This is intended -for cases in which only state changes are reported, for example a thermometer -that only reports the temperature when it changes. +Report the last matching value. The metric is I reset to C at the end +of an interval. It is continuously reported until another value is matched. +This is intended for cases in which only state changes are reported, for +example a thermometer that only reports the temperature when it changes. =item B @@ -8414,6 +8447,9 @@ Increase the internal counter by one. These B are the only ones that do not use the matched subexpression, but simply count the number of matched lines. Thus, you may use a regular expression without submatch in this case. +B is reset to I after every read, unlike other B +metrics which are reset to C. + =item B Type to do calculations based on the distribution of values, primarily @@ -8487,8 +8523,12 @@ The B and B types interpret the submatch as a floating point number, using L. The B and B types interpret the submatch as an unsigned integer using L. The B types interpret the submatch as a signed integer using -L. B and B do not use the submatch at all -and it may be omitted in this case. +L. B, B and B do not use the +submatch at all and it may be omitted in this case. + +The B types, unless noted otherwise, are reset to C after being +reported. In other words, B reports the average of all values +matched since the last metric was reported (or C if there was no match). =item B I @@ -8841,6 +8881,33 @@ dynamic number assigned by the kernel. Otherwise, CnE> is used if there is only one package and CnE-coreEmE> if there is more than one, where I is the n-th core of package I. +=item B I|I + +Reading data from CPU has side-effect: collectd process's CPU affinity mask +changes. After reading data is completed, affinity mask needs to be restored. +This option allows to set restore policy. + +B (the default): Restore the affinity by setting affinity to any/all +CPUs. + +B: Save affinity using sched_getaffinity() before reading data and +restore it after. + +On some systems, sched_getaffinity() will fail due to inconsistency of the CPU +set size between userspace and kernel. In these cases plugin will detect the +unsuccessful call and fail with an error, preventing data collection. +Most of configurations does not need to save affinity as Collectd process is +allowed to run on any/all available CPUs. + +If you need to save and restore affinity and get errors like 'Unable to save +the CPU affinity', setting 'possible_cpus' kernel boot option may also help. + +See following links for details: + +L +L +L + =back =head2 Plugin C @@ -9236,7 +9303,7 @@ be set to C. Setting C will cause the I to be set to C. -=item B B +=item B B 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 @@ -9249,6 +9316,9 @@ B means to use the global B setting, which is probably not useful on its own because all guests will appear to have the same name. This is useful in conjunction with B though. +B means use information from guest's metadata. Use +B and B to localize this information. + You can also specify combinations of these fields. For example B means to concatenate the guest name and UUID (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">). @@ -9257,7 +9327,7 @@ At the moment of writing (collectd-5.5), hostname string is limited to 62 characters. In case when combination of fields exceeds 62 characters, hostname will be truncated without a warning. -=item B B|B
+=item B B|B
|B 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 @@ -9267,23 +9337,42 @@ 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 +B means use the interface's number in guest. + +=item B B When the virt plugin logs data, it sets the plugin_instance of the collected data according to this setting. The default is to not set the plugin_instance. B means use the guest's name as provided by the hypervisor. B means use the guest's UUID. +B means use information from guest's metadata. You can also specify combinations of the B and B fields. For example B means to concatenate the guest name and UUID (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">). -=item B B +=item B B -How many read instances you want to use for this plugin. The default is one, -and the sensible setting is a multiple of the B value. -If you are not sure, just use the default setting. +When B is used in B or B, this +selects in which metadata namespace we will pick the hostname. The default is +I. + +=item B B + +When B is used in B or B, this +describes where the hostname is located in the libvirt metadata. The default is +I. + +=item B B|B + +Enabled by default. Allows to disable stats reporting of block devices for +whole plugin. + +=item B B|B + +Enabled by default. Allows to disable stats reporting of network interfaces for +whole plugin. =item B B @@ -9335,11 +9424,38 @@ B: I metrics can't be collected if I plugin is enabled. =back =item B B|B + Override default configuration to only send notifications when there is a change in the lifecycle state of a domain. When set to true notifications will be sent for every read cycle. Default is false. Does not affect the stats being dispatched. +=item B B + +How many read instances you want to use for this plugin. The default is one, +and the sensible setting is a multiple of the B value. + +This option is only useful when domains are specially tagged. +If you are not sure, just use the default setting. + +The reader instance will only query the domains with attached matching tag. +Tags should have the form of 'virt-X' where X is the reader instance number, +starting from 0. + +The special-purpose reader instance #0, guaranteed to be always present, +will query all the domains with missing or unrecognized tag, so no domain will +ever be left out. + +Domain tagging is done with a custom attribute in the libvirt domain metadata +section. Value is selected by an XPath I +expression in the I namespace. +(XPath and namespace values are not configurable yet). + +Tagging could be used by management applications to evenly spread the +load among the reader threads, or to pin on the same threads all +the libvirt domains which use the same shared storage, to minimize +the disruption in presence of storage outages. + =back =head2 Plugin C @@ -9673,6 +9789,13 @@ B =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. + +This option is supported only for libmicrohttpd newer than 0.9.0. + =item B I Port the embedded webserver should listen on. Defaults to B<9103>. @@ -10473,6 +10596,141 @@ C. =back +=head2 Plugin C + +The C plugin writes data in I format log messages. +It implements the basic syslog protocol, RFC 5424, extends it with +content-based filtering, rich filtering capabilities, +flexible configuration options and adds features such as using TCP for transport. +The plugin can connect to a I daemon, like syslog-ng and rsyslog, that will +ingest metrics, transform and ship them to the specified output. +The plugin uses I over the "line based" protocol with a default port 44514. +The data will be sent in blocks of at most 1428 bytes to minimize the number of +network packets. + +Synopsis: + + + ResolveInterval 60 + ResolveJitter 60 + + Host "syslog-1.my.domain" + Port "44514" + Prefix "collectd" + MessageFormat "human" + HostTags "" + + + +The configuration consists of one or more EBEIE +blocks and global directives. + +Global directives are: + +=over 4 + +=item B I + +=item B I + +When I connects to a syslog node, it will request the hostname from +DNS. This can become a problem if the syslog node is unavailable or badly +configured because collectd will request DNS in order to reconnect for every +metric, which can flood your DNS. So you can cache the last value for +I seconds. +Defaults to the I of the I, e.g. 10Eseconds. + +You can also define a jitter, a random interval to wait in addition to +I. This prevents all your collectd servers to resolve the +hostname at the same time when the connection fails. +Defaults to the I of the I, e.g. 10Eseconds. + +B If the DNS resolution has already been successful when the socket +closes, the plugin will try to reconnect immediately with the cached +information. DNS is queried only when the socket is closed for a longer than +I + I seconds. + +=back + +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<44514>. + + +=item B I + +When set, I is added to the end of the metric. +It is intended to be used for adding additional metadata to tag the metric with. +Dots and whitespace are I escaped in this string. + +Examples: + +When MessageFormat is set to "human". + + ["prefix1" "example1"="example1_v"]["prefix2" "example2"="example2_v"]" + +When MessageFormat is set to "JSON", text should be in JSON format. +Escaping the quotation marks is required. + + HostTags "\"prefix1\": {\"example1\":\"example1_v\",\"example2\":\"example2_v\"}" + +=item B I + +I selects the format in which messages are sent to the +syslog deamon, human or JSON. Defaults to human. + +Syslog message format: + +VERSION ISOTIMESTAMP HOSTNAME APPLICATION PID MESSAGEID STRUCTURED-DATA MSG + +The difference between the message formats are in the STRUCTURED-DATA and MSG parts. + +Human format: + + <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID + ["collectd" "value": "v1" "plugin"="plugin_v" "plugin_instance"="plugin_instance_v" + "type_instance"="type_instance_v" "type"="type_v" "ds_name"="ds_name_v" "interval"="interval_v" ] + "host_tag_example"="host_tag_example_v" plugin_v.type_v.ds_name_v="v1" + +JSON format: + + <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID STRUCTURED-DATA + { + "collectd": { + "time": time_as_epoch, "interval": interval_v, "plugin": "plugin_v", + "plugin_instance": "plugin_instance_v", "type":"type_v", + "type_instance": "type_instance_v", "plugin_v": {"type_v": v1} + } , "host":"host_v", "host_tag_example": "host_tag_example_v" + } + +=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 to 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. + +=item B I + +When set, I is added to all metrics names as a prefix. It is intended in +case you want to be able to define the source of the specific metric. Dots and +whitespace are I escaped in this string. + +=back + =head2 Plugin C This plugin collects metrics of hardware CPU load for machine running Xen @@ -11461,7 +11719,7 @@ be an FQDN. =head1 IGNORELISTS B are a generic framework to either ignore some metrics or report -specific metircs only. Plugins usually provide one or more options to specify +specific metrics only. Plugins usually provide one or more options to specify the items (mounts points, devices, ...) and the boolean option C.