Linux Certif

Toute la documentation sur la certification Linux LPI

collectd.conf

NAME

collectd.conf - Configuration for the system statistics collection daemon collectd

SYNOPSIS

   Mode    Client
   DataDir /path/to/data/
   PIDFile /path/to/pidfile/collectd.pid
   LogFile /path/to/logfile/collectd.log
   Server  123.123.123.123 12345
 
 

   LoadPlugin cpu
   LoadPlugin load
   LoadPlugin ping
 
 

   <Plugin ping>
     Host example.org
     Host provider.net
   </Plugin>
 
 

DESCRIPTION

This config file controls how the system statistics collection daemon collectd behaves. The most significant options are Mode, which controlls if the daemon will act as client, server or will be independent in local mode, and LoadPlugin which controls which plugins to load.

The syntax of this config file is similar to the config file of the famos Apache Webserver. Each line containes either a key-value-pair or a section-start or -end. Empty lines and everything after the hash-symbol `#' is ignored.

GLOBAL OPTIONS

Mode (Local|Client|Server|Log)

Sets the operating mode. See the section MODES in collectd(1) for a description. This option determines which other options are allowed. Defaults to Local.

LoadPlugin Plugin

Loads the plugin Plugin. There must be at least one such line or collectd will be mostly useless. The names of the plugins are listed in collectd(1).

PIDFile File

Sets where to write the PID file to. This file is overwritten when it exists and deleted when the program ist stopped. Some init-scripts might override this setting using the -P commandline option. Available in all modes.

DataDir Directory

Sets the data directory. This is the directory beneath all RRD-files are created. Possibly more subdirectories are created. This is also the working directory for the daemon. Available in all modes, though the Client mode won't write to this directory.

LogFile File

Sets the file to write debugging output to. This is only used if compiled with debugging enabled. It's ignored otherwise. Available in all modes.

Listen Host [Port]

Server Host [Port]

In client mode the Server statement sets the server to send datagrams to. The statement may occur multiple times to send each datagram to multiple destinations.

In server mode the Listen statement sets the interfaces to bind to. When multiple statements are found the daemon will bind to multiple interfaces.

The argument Host may be a hostname, an IPv4 address or an IPv6 address. If the argument is a multicast address the daemon will join that multicast group.

If no Listen statement is found the server tries join both, the IPv6 multicast group and the IPv4 multicast group. If no Server statement is found the client will try to send data to the IPv6 multicast group first. If that failes the client will try the IPv4 multicast group.

The default IPv6 multicast group is "ff18::efc0:4a42". The default IPv4 multicast group is 239.192.74.66.

The optional Port argument sets the port to use. It can either be given using a numeric port number or a service name. If the argument is omited the default port 25826 is assumed.

TimeToLive 1-255

Set the time-to-live of sent packets. This applies to all, unicast and multicast, and IPv4 and IPv6 packets. The default is to not change this value. That means that multicast packets will be sent with a TTL of 1 (one) on most operating systems.

PLUGIN OPTIONS

Some Plugins may register own options. These options must be inclosed in a "Plugin"-Section. Which options exist depends on the plugin used:

Plugin "apache"

Plugin apache

To configure the "apache"-plugin you first need to configure the Apache webserver correctly. The Apache-plugin "mod_status" needs to be loaded and working and the "ExtendedStatus" directive needs to be enabled. You can use the following snipped to base your Apache config upon:

   ExtendedStatus on
   <IfModule mod_status.c>
     <Location /mod_status>
       SetHandler server-status
     </Location>
   </IfModule>
 
 

The following options are accepted by the "apache"-plugin:

URL http://host/mod_status?auto

Sets the URL of the "mod_status" output. This needs to be the output generated by "ExtendedStatus on" and it needs to be the machine readable output generated by appending the "?auto" argument.

User Username

Optional user name needed for authentication.

Password Password

Optional password needed for authentication.

CACert File

File that holds one or more SSL certificates. If you want to use HTTPS you will possibly need this option. What CA certificates come bundeled with "libcurl" and are checked by default depends on the distribution you use.

Plugin "apcups"

Plugin apcups

Host Hostname

Hostname of the host running apcupsd. Defaults to localhost. Please note that IPv6 support has been disabled unless someone can confirm or decline that apcupsd can handle it.

Port Port

TCP-Port to connect to. Defaults to 3551.

Plugin "df"

Plugin df

Device Device

Select partitions based on the devicename.

MountPoint Directory

Select partitions based on the mountpoint.

FSType FSType

Select partitions based on the filesystem type.

IgnoreSelected true|false

Invert the selection: If set to true, all partitions except the ones that match any one of the criteria are collected. By default only selected partitions are collected if a selection is made. If no selection is conifured at all, all partitions are selected.

Plugin "dns"

Plugin dns

Interface Interface

The dns plugin uses libpcap to capture dns traffic and analyses it. This option sets the interface that should be used. If this option is not set, or set to ``any'', the plugin will try to get packets from all interfaces. This may not work on certain platforms, such as Mac OS X.

IgnoreSource IP-address

Ignore packets that originate from this address.

Plugin "email"

Plugin email

SocketGroup Group

If running as root change the group of the UNIX-socket after it has been created. Defaults to collectd.

SocketPerms Permissions

Change the file permissions of the UNIX-socket after it has been created. The permissions must be given as a numeric, octal value as you would pass to chmod(1). Defaults to 0770.

MaxConns Number

Sets the maximum number of connections that can be handled in parallel. Since this many threads will be started immediately setting this to a very high value will waste valuable resources. Defaults to 5 and will be forced to be at most 16384 to prevent typos and dumb mistakes.

Plugin "hddtemp"

Plugin hddtemp

Host Hostname

Hostname to connect to. Defaults to 127.0.0.1.

Port Port

TCP-Port to connect to. Defaults to 7634.

Plugin "mbmon"

Plugin mbmon

Host Hostname

Hostname to connect to. Defaults to 127.0.0.1.

Port Port

TCP-Port to connect to. Defaults to 411.

Plugin "ntpd"

Plugin ntpd

Host Hostname

Hostname of the host running ntpd. Defaults to localhost.

Port Port

UDP-Port to connect to. Defaults to 123.

Plugin "mysql"

Plugin mysql

Host Hostname

Hostname of the database server. Defaults to localhost.

User Username

Username to use when connecting to the database.

Password Password

Password needed to log into the database.

Database Database

Select this database. Defaults to no database which is a perfecly reasonable option for what this plugin does.

Plugin "ping"

Plugin ping

Host IP-address

Host to ping periodically. This option may be repeated several times to ping multiple hosts.

TTL 0-255

Sets the Time-To-Live of generated ICMP packets.

Plugin "sensors"

Plugin sensors

ExtendedSensorNaming true|false

If set to true this option switches on the extended sensors and RRD-files naming. This option exists to preserve backwards compatibility. It is recommended that you set this option to true. The default is false to maintain compatibility only.

Sensors get names like chip-bus-address/type-feature (e.g. it8712-isa-0290/voltage-in1) and RRD files are therefore stored in a standalone directory inside the DataDir directory and get names like lm_sensors-chip-bus-address/type-feature.rrd (e.g. lm_sensors-it8712-isa-0290/voltage-in1.rrd).

The ExtendedSensorNaming option breaks the compatibility with previous sensors and RRD files naming and the place where RRDs are stored. If you turn it on, the plugin will create new RRD files in a standalone directory inside the DataDir directory and without previous history. You can rename ``old'' RRD-files to preserve already collected statistics, because the file layout hasn't changed. If you have two chips of the same type, you need to use ExtendedSensorNaming in order to collect information from both chips.

If not set or set to false, the extended naming is not active. Sensors get names like chip-feature (e.g. it8712-in1) and RRD files are stored in the main DataDir directory and get names like sensors-chip-feature.rrd (e.g. sensors-it8712-in1.rrd). You simply continue using the plugin the old way and additionally also getting data for newly added sensors in this mode.

Sensor chip-feature or Sensor chip-bus-address/type-feature

Both option modes select the name of the sensor which you want to collect. The naming scheme is dependent on the state of the ExtendedSensorNaming option (see previous option). Both option modes can also deselect the sensor according to the IgnoreSelected option (see below).

For example the option "Sensor it8712-in1" will cause the collectd to gather data for the voltage sensor in1 of the it8712 chip in case of the ExtendedSensorNaming option is set to false.

And likewise the option "Sensor it8712-isa-0290/voltage-in1" will cause the collectd to gather data for the voltage sensor in1 of the it8712 on the isa bus at the address 0290 in case of the ExtendedSensorNaming option set to true.

IgnoreSelected true|false

If no configuration if given, the sensors-plugin will collect data from all sensors. This may not be practical, especially for uninteresting sensors. Thus, you can use the Sensor-option to pick the sensors you're interested in. Sometimes, however, it's easier/prefered to collect all sensors except a few ones. This option enables you to do that: By setting IgnoreSelected to true the effect of Sensor is inversed: All selected sensors are ignored and all other sensors are collected.

back

Plugin "traffic"

Plugin traffic

Interface Interface

Select this interface. By default these interfaces will then be collected. For a more detailed description see IgnoreSelected below.

IgnoreSelected true|false

If no configuration if given, the traffic-plugin will collect data from all interfaces. This may not be practical, especially for loopback- and similar interfaces. Thus, you can use the Interface-option to pick the interfaces you're interested in. Sometimes, however, it's easier/prefered to collect all interfaces except a few ones. This option enables you to do that: By setting IgnoreSelected to true the effect of Interface is inversed: All selected interfaces are ignored and all other interfaces are collected.

SEE ALSO

collectd(1)

AUTHOR

Florian Forster <octo@verplant.org>