X-Git-Url: https://git.octo.it/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcollectd.conf.pod;h=39a657d29eb4b7a8e12245e7daf828ef357a9fc5;hb=855ba3880b50bc4a774a8c8d23612bba3550b3e7;hp=691a7494fecf3b521cf3afb46dee4c7e85a9f4a3;hpb=bdf4ac4bba349bac128fea28fac13fda784ae78c;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 691a7494..39a657d2 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" @@ -341,10 +341,10 @@ The full example configuration looks like this: Plugin "cpu" Type "cpu" - + GroupBy "Host" GroupBy "TypeInstance" - + CalculateSum true CalculateAverage true @@ -420,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 @@ -495,7 +495,7 @@ possibly filtering or messages. # GraphitePrefix "collectd." # GraphiteEscapeChar "_" - + # Receive values from an AMQP broker Host "localhost" @@ -506,6 +506,8 @@ possibly filtering or messages. Exchange "amq.fanout" # ExchangeType "fanout" # Queue "queue_name" + # QueueDurable false + # QueueAutoDelete true # RoutingKey "collectd.#" @@ -558,9 +560,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 @@ -822,17 +838,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" @@ -973,6 +989,31 @@ at all, B cgroups are selected. =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. Implies ValuesPercentage when false. +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 @@ -1046,6 +1087,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 @@ -1157,11 +1202,19 @@ The following options are valid within B blocks: Sets the plugin instance to I. =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 @@ -1250,6 +1303,8 @@ Examples: =item B I +=item B B|B + =item B B|B =item B B|B @@ -1603,17 +1658,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 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. +Enables or disables reporting of free and used disk space in percentage. +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 @@ -1649,6 +1704,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 @@ -2199,6 +2268,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 @@ -2233,6 +2321,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 @@ -2406,7 +2522,7 @@ B ShowCPU true ShowCPUCores true ShowMemory true - + ShowTemperatures true Temperature vddg Temperature vddq @@ -2415,7 +2531,7 @@ B ShowPower true Power total0 Power total1 - IgnoreSelectedPower true + IgnoreSelectedPower true The following options are valid inside the Bmic> block: @@ -2424,7 +2540,7 @@ The following options are valid inside the Bmic> block: =item B B|B -If enabled (the default) a sum of the CPU usage accross all cores is reported. +If enabled (the default) a sum of the CPU usage across all cores is reported. =item B B|B @@ -2472,7 +2588,7 @@ Fan In =item fout -Fan Out +Fan Out =item vccp @@ -2513,11 +2629,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 @@ -2525,36 +2641,57 @@ 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 =back +=head2 Plugin C + +The I provides the following configuration options: + +=over 4 + +=item B B|B + +Enables or disables reporting of physical memory usage in absolute numbers, +i.e. bytes. Defaults to B. + +=item B B|B + +Enables or disables reporting of physical memory usage in percentages, e.g. +percent of physical memory used. Defaults to B. + +This is useful for deploying I in a heterogeneous environment in +which the sizes of physical memory vary. + +=back + =head2 Plugin C The B connects to a Modbus "slave" via Modbus/TCP and reads @@ -2570,19 +2707,19 @@ B 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" @@ -2815,7 +2952,7 @@ Required capabilities are documented below. User "username" Password "aef4Aebe" Interval 30 - + Interval 30 GetNameCache true @@ -2823,12 +2960,12 @@ Required capabilities are documented below. GetBufferCache true GetInodeCache true - + Interval 30 GetBusy true - + Interval 30 GetIO "volume0" @@ -2838,7 +2975,7 @@ Required capabilities are documented below. GetLatency "volume0" IgnoreSelectedLatency false - + Interval 30 GetCapacity "vol0" @@ -2848,15 +2985,15 @@ Required capabilities are documented below. GetSnapshot "vol3" IgnoreSelectedSnapshot false - + Interval 60 - + Interval 30 - + Interval 30 GetCPULoad true @@ -3417,7 +3554,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) @@ -5337,6 +5474,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 @@ -5472,6 +5622,7 @@ user using (extended) regular expressions, as described in L. Instance "exim" + Interval 60 Regex "S=([1-9][0-9]*)" DSType "CounterAdd" @@ -5498,6 +5649,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: @@ -6085,7 +6239,7 @@ Synopsis: Host "localhost" Port "2003" - Protocol "udp" + Protocol "tcp" LogSendErrors true Prefix "collectd" @@ -6270,9 +6424,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. @@ -6288,6 +6547,7 @@ Synopsis: TTLFactor 2.0 Tag "foobar" + Attribute "foo" "bar" The following options are understood by the I: @@ -6341,6 +6601,17 @@ interval is multiplied to set the TTL. The default value is B<2.0>. Unless you know exactly what you're doing, you should only increase this setting from its default value. +=item B B|B + +If set to B, create riemann events for notifications. This is B +by default. When processing thresholds from write_riemann, it might prove +useful to avoid getting notification events. + +=item B B|B + +If set to B, attach state to events based on thresholds defined +in the B plugin. Defaults to B. + =back =item B I @@ -6348,6 +6619,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 @@ -6382,7 +6658,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 @@ -6413,7 +6689,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 @@ -7002,7 +7278,7 @@ Example: Max 100 Satisfy "All" - + # Match if the value of any data source is outside the range of 0 - 100. Min 0 @@ -7184,7 +7460,7 @@ Example: # Replace "example.net" with "example.com" Host "\\" "example.com" - + # Strip "www." from hostnames Host "\\