src/collectd.1

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "COLLECTD 1"
 136 .TH COLLECTD 1 "2015-03-10" "5.4.1.805.g42e4d6c" "collectd"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 collectd \- System statistics collection daemon
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 collectd \fI[options]\fR
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 collectd is a daemon that receives system statistics and makes them available
 149 in a number of ways. The main daemon itself doesn't have any real functionality
 150 apart from loading, querying and submitting to plugins. For a description of
 151 available plugins please see \*(L"\s-1PLUGINS\*(R"\s0 below.
 152 .SH "OPTIONS"
 153 .IX Header "OPTIONS"
 154 Most of collectd's configuration is done using using a configfile. See
 155 \&\fIcollectd.conf\fR\|(5) for an in-depth description of all options.
 156 .IP "\fB\-C\fR \fI<config\-file>\fR" 4
 157 .IX Item "-C <config-file>"
 158 Specify an alternative config file. This is the place to go when you wish to
 159 change \fBcollectd\fR's behavior. The path may be relative to the current working
 160 directory.
 161 .IP "\fB\-t\fR" 4
 162 .IX Item "-t"
 163 Test the configuration only. The program immediately exits after parsing the
 164 config file. A return code not equal to zero indicates an error.
 165 .IP "\fB\-T\fR" 4
 166 .IX Item "-T"
 167 Test the plugin read callbacks only. The program immediately exits after invoking
 168 the read callbacks once. A return code not equal to zero indicates an error.
 169 .IP "\fB\-P\fR \fI<pid\-file>\fR" 4
 170 .IX Item "-P <pid-file>"
 171 Specify an alternative pid file. This overwrites any settings in the config
 172 file. This is thought for init-scripts that require the PID-file in a certain
 173 directory to work correctly. For everyday-usage use the \fBPIDFile\fR
 174 config-option.
 175 .IP "\fB\-f\fR" 4
 176 .IX Item "-f"
 177 Don't fork to the background. \fIcollectd\fR will also \fBnot\fR close standard file
 178 descriptors, detach from the session nor write a pid file. This is mainly
 179 thought for 'supervising' init replacements such as \fIrunit\fR. If using
 180 \&\fIupstart\fR or \fIsystemd\fR though, starting with version 5.5.0 \fIcollectd\fR is
 181 able to notify these two init replacements, and \fBdoes\fR require forking to the
 182 background for process supervision. The \fIcontrib/\fR directory has sample
 183 \&\fIupstart\fR and \fIsystemd\fR configuration files.
 184 .IP "\fB\-h\fR" 4
 185 .IX Item "-h"
 186 Output usage information and exit.
 187 .SH "PLUGINS"
 188 .IX Header "PLUGINS"
 189 As noted above, the real power of collectd lies within it's plugins. A
 190 (hopefully complete) list of plugins and short descriptions can be found in the
 191 \&\fI\s-1README\s0\fR file that is distributed with the sourcecode. If you're using a
 192 package it's a good bet to search somewhere near \fI/usr/share/doc/collectd\fR.
 193 .PP
 194 There are two big groups of plugins, \fBinput\fR and \fBoutput\fR plugins:
 195 .IP "\(bu" 4
 196 Input plugins are queried periodically. They somehow acquire the current value
 197 of whatever they where designed to work with and submit these values back to
 198 the daemon, i. e. they \*(L"dispatch\*(R" the values. As an example, the \f(CW\*(C`cpu plugin\*(C'\fR
 199 reads the current cpu-counters of time spent in the various modes (user,
 200 system, nice, ...) and dispatches these counters to the daemon.
 201 .IP "\(bu" 4
 202 Output plugins get the dispatched values from the daemon and does something
 203 with them. Common applications are writing to RRD-files, CSV-files or sending
 204 the data over a network link to a remote box.
 205 .PP
 206 Of course not all plugins fit neatly into one of the two above categories. The
 207 \&\f(CW\*(C`network plugin\*(C'\fR, for example, is able to send (i.\ e. \*(L"write\*(R") \fBand\fR
 208 receive (i.\ e. \*(L"dispatch\*(R") values. Also, it opens a socket upon
 209 initialization and dispatches the values when it receives them and isn't
 210 triggered at the same time the input plugins are being read. You can think of
 211 the network receive part as working asynchronous if it helps.
 212 .PP
 213 In addition to the above, there are \*(L"logging plugins\*(R". Right now those are the
 214 \&\f(CW\*(C`logfile plugin\*(C'\fR and the \f(CW\*(C`syslog plugin\*(C'\fR. With these plugins collectd can
 215 provide information about issues and significant situations to the user.
 216 Several loglevels let you suppress uninteresting messages.
 217 .PP
 218 Starting with version \f(CW4.3.0\fR collectd has support for \fBmonitoring\fR. This is
 219 done by checking thresholds defined by the user. If a value is out of range, a
 220 notification will be dispatched to \*(L"notification plugins\*(R". See
 221 \&\fIcollectd.conf\fR\|(5) for more detailed information about threshold checking.
 222 .PP
 223 Please note that some plugins, that provide other means of communicating with
 224 the daemon, have manpages of their own to describe their functionality in more
 225 detail. In particular those are \fIcollectd\-email\fR\|(5), \fIcollectd\-exec\fR\|(5),
 226 \&\fIcollectd\-perl\fR\|(5), \fIcollectd\-snmp\fR\|(5), and \fIcollectd\-unixsock\fR\|(5)
 227 .SH "SIGNALS"
 228 .IX Header "SIGNALS"
 229 \&\fBcollectd\fR accepts the following signals:
 230 .IP "\fB\s-1SIGINT\s0\fR, \fB\s-1SIGTERM\s0\fR" 4
 231 .IX Item "SIGINT, SIGTERM"
 232 These signals cause \fBcollectd\fR to shut down all plugins and terminate.
 233 .IP "\fB\s-1SIGUSR1\s0\fR" 4
 234 .IX Item "SIGUSR1"
 235 This signal causes \fBcollectd\fR to signal all plugins to flush data from
 236 internal caches. E.\ g. the \f(CW\*(C`rrdtool plugin\*(C'\fR will write all pending data
 237 to the \s-1RRD\s0 files. This is the same as using the \f(CW\*(C`FLUSH \-1\*(C'\fR command of the
 238 \&\f(CW\*(C`unixsock plugin\*(C'\fR.
 239 .SH "SEE ALSO"
 240 .IX Header "SEE ALSO"
 241 \&\fIcollectd.conf\fR\|(5),
 242 \&\fIcollectd\-email\fR\|(5),
 243 \&\fIcollectd\-exec\fR\|(5),
 244 \&\fIcollectd\-perl\fR\|(5),
 245 \&\fIcollectd\-snmp\fR\|(5),
 246 \&\fIcollectd\-unixsock\fR\|(5),
 247 \&\fItypes.db\fR\|(5),
 248 <http://collectd.org/>
 249 .SH "AUTHOR"
 250 .IX Header "AUTHOR"
 251 Florian Forster <octo@collectd.org>