src/collectd-exec.pod

   1 =head1 NAME
   2
   3 collectd-exec - Documentation of collectd's C<exec plugin>
   4
   5 =head1 SYNOPSIS
   6
   7   # See collectd.conf(5)
   8   LoadPlugin exec
   9   # ...
  10   <Plugin exec>
  11     Exec "myuser:mygroup" "myprog"
  12     Exec "otheruser" "/path/to/another/binary" "arg0" "arg1"
  13     NotificationExec "user" "/usr/lib/collectd/exec/handle_notification"
  14   </Plugin>
  15
  16 =head1 DESCRIPTION
  17
  18 The C<exec plugin> forks of an executable either to receive values or to
  19 dispatch notifications to the outside world. The syntax of the configuration is
  20 explained in L<collectd.conf(5)> but summarized in the above synopsis.
  21
  22 If you want/need better performance or more functionality you should take a
  23 long look at the C<perl plugin>, L<collectd-perl(5)>.
  24
  25 =head1 EXECUTABLE TYPES
  26
  27 There are currently two types of executables that can be executed by the
  28 C<exec plugin>:
  29
  30 =over 4
  31
  32 =item C<Exec>
  33
  34 These programs are forked and values that it writes to C<STDOUT> are read back.
  35 The executable is forked in a fashion similar to L<init>: It is forked once and
  36 not again until it exits. If it exited, it will be forked again after at most
  37 I<Interval> seconds. It is perfectly legal for the executable to run for a long
  38 time and continuously write values to C<STDOUT>.
  39
  40 See L<EXEC DATA FORMAT> below for a description of the output format expected
  41 from these programs.
  42
  43 B<Warning:> If the executable only writes one value and then exits I will be
  44 executed every I<Interval> seconds. If I<Interval> is short (the default is 10
  45 seconds) this may result in serious system load.
  46
  47 =item C<NotificationExec>
  48
  49 The program is forked once for each notification that is handled by the daemon.
  50 The notification is passed to the program on C<STDIN> in a fashion similar to
  51 HTTP-headers. In contrast to programs specified with C<Exec> the execution of
  52 this program is not serialized, so that several instances of this program may
  53 run at once if multiple notifications are received.
  54
  55 See L<NOTIFICATION DATA FORMAT> below for a description of the data passed to
  56 these programs.
  57
  58 =back
  59
  60 =head1 EXEC DATA FORMAT
  61
  62 The forked executable is expected to print values to C<STDOUT>. The expected
  63 format is as follows:
  64
  65 =over 4
  66
  67 =item Comments
  68
  69 Each line beginning with a C<#> (hash mark) is ignored.
  70
  71 =item B<PUTVAL> I<Identifier> [I<OptionList>] I<Valuelist>
  72
  73 Submits one or more values (identified by I<Identifier>, see below) to the
  74 daemon which will dispatch it to all it's write-plugins.
  75
  76 An I<Identifier> is of the form
  77 C<I<host>B</>I<plugin>B<->I<instance>B</>I<type>B<->I<instance>> with both
  78 I<instance>-parts being optional. If they're omitted the hyphen must be
  79 omitted, too. I<plugin> and each I<instance>-part may be chosen freely as long
  80 as the tuple (plugin, plugin instance, type instance) uniquely identifies the
  81 plugin within collectd. I<type> identifies the type and number of values
  82 (i.E<nbsp>e. data-set) passed to collectd. A large list of predefined
  83 data-sets is available in the B<types.db> file. See L<types.db(5)> for a
  84 description of the format of this file.
  85
  86 The I<OptionList> is an optional list of I<Options>, where each option is a
  87 key-value-pair. A list of currently understood options can be found below, all
  88 other options will be ignored. Values that contain spaces must be quoted with
  89 double quotes.
  90
  91 I<Valuelist> is a colon-separated list of the time and the values, each either
  92 an integer if the data-source is a counter, or a double if the data-source is
  93 of type "gauge". You can submit an undefined gauge-value by using B<U>. When
  94 submitting B<U> to a counter the behavior is undefined. The time is given as
  95 epoch (i.E<nbsp>e. standard UNIX time).
  96
  97 You can mix options and values, but the order is important: Options only
  98 effect following values, so specifying an option as last field is allowed, but
  99 useless. Also, an option applies to B<all> following values, so you don't need
 100 to re-set an option over and over again.
 101
 102 The currently defined B<Options> are:
 103
 104 =over 4
 105
 106 =item B<interval=>I<seconds>
 107
 108 Gives the interval in which the data identified by I<Identifier> is being
 109 collected.
 110
 111 =back
 112
 113 Please note that this is the same format as used in the B<unixsock plugin>, see
 114 L<collectd-unixsock(5)>. There's also a bit more information on identifiers in
 115 case you're confused.
 116
 117 Since examples usually let one understand a lot better, here are some:
 118
 119   PUTVAL leeloo/cpu-0/cpu-idle N:2299366
 120   PUTVAL alice/interface/if_octets-eth0 interval=10 1180647081:421465:479194
 121
 122 =item B<PUTNOTIF> [I<OptionList>] B<message=>I<Message>
 123
 124 Submits a notification to the daemon which will then dispatch it to all plugins
 125 which have registered for receiving notifications.
 126
 127 The B<PUTNOTIF> if followed by a list of options which further describe the
 128 notification. The B<message> option is special in that it will consume the rest
 129 of the line as its value. The B<message>, B<severity>, and B<time> options are
 130 mandatory.
 131
 132 Valid options are:
 133
 134 =over 4
 135
 136 =item B<message=>I<Message> (B<REQUIRED>)
 137
 138 Sets the message of the notification. This is the message that will be made
 139 accessible to the user, so it should contain some useful information. As with
 140 all options: If the message includes spaces, it must be quoted with double
 141 quotes. This option is mandatory.
 142
 143 =item B<severity=failure>|B<warning>|B<okay> (B<REQUIRED>)
 144
 145 Sets the severity of the notification. This option is mandatory.
 146
 147 =item B<time=>I<Time> (B<REQUIRED>)
 148
 149 Sets the time of the notification. The time is given as "epoch", i.E<nbsp>e. as
 150 seconds since January 1st, 1970, 00:00:00. This option is mandatory.
 151
 152 =item B<host=>I<Hostname>
 153
 154 =item B<plugin=>I<Plugin>
 155
 156 =item B<plugin_instance=>I<Plugin-Instance>
 157
 158 =item B<type=>I<Type>
 159
 160 =item B<type_instance=>I<Type-Instance>
 161
 162 These "associative" options establish a relation between this notification and
 163 collected performance data. This connection is purely informal, i.E<nbsp>e. the
 164 daemon itself doesn't do anything with this information. However, websites or
 165 GUIs may use this information to place notifications near the affected graph or
 166 table. All the options are optional, but B<plugin_instance> without B<plugin>
 167 or B<type_instance> without B<type> doesn't make much sense and should be
 168 avoided.
 169
 170 =back
 171
 172 =back
 173
 174 Please note that this is the same format as used in the B<unixsock plugin>, see
 175 L<collectd-unixsock(5)>.
 176
 177 When collectd exits it sends a B<SIGTERM> to all still running
 178 child-processes upon which they have to quit.
 179
 180 =head1 NOTIFICATION DATA FORMAT
 181
 182 The notification executables receive values rather than providing them. In
 183 fact, after the program is started C<STDOUT> is connected to C</dev/null>.
 184
 185 The data is passed to the executables over C<STDIN> in a format very similar to
 186 HTTP: At first there is a "header" with one line per field. Every line consists
 187 of a field name, ended by a colon, and the associated value until end-of-line.
 188 The "header" is ended by two newlines immediately following another,
 189 i.E<nbsp>e. an empty line. The rest, basically the "body", is the message of
 190 the notification.
 191
 192 The following is an example notification passed to a program:
 193
 194   Severity: FAILURE
 195   Time: 1200928930
 196   Host: myhost.mydomain.org
 197   \n
 198   This is a test notification to demonstrate the format
 199
 200 The following header files are currently used. Please note, however, that you
 201 should ignore unknown header files to be as forward-compatible as possible.
 202
 203 =over 4
 204
 205 =item B<Severity>
 206
 207 Severity of the notification. May either be B<FAILURE>, B<WARNING>, or B<OKAY>.
 208
 209 =item B<Time>
 210
 211 The time in epoch, i.E<nbsp>e. as seconds since 1970-01-01 00:00:00 UTC.
 212
 213 =item B<Host>
 214
 215 =item B<Plugin>
 216
 217 =item B<PluginInstance>
 218
 219 =item B<Type>
 220
 221 =item B<TypeInstance>
 222
 223 Identification of the performance data this notification is associated with.
 224 All of these fields are optional because notifications do not B<need> to be
 225 associated with a certain value.
 226
 227 =back
 228
 229 =head1 ENVIRONMENT
 230
 231 The following environment variables are set by the plugin before calling
 232 I<exec>:
 233
 234 =over 4
 235
 236 =item COLLECTD_INTERVAL
 237
 238 Value of the global interval setting.
 239
 240 =item COLLECTD_HOSTNAME
 241
 242 Hostname used by I<collectd> to dispatch local values.
 243
 244 =back
 245
 246 =head1 USING NAGIOS PLUGINS
 247
 248 Though the interface is far from perfect, there are tons of plugins for Nagios.
 249 You can use these plugins with collectd by using a simple transition layer,
 250 C<exec-nagios.px>, which is shipped with the collectd distribution in the
 251 C<contrib/> directory. It is a simple Perl script that comes with embedded
 252 documentation. To see it, run the following command:
 253
 254   perldoc exec-nagios.px
 255
 256 This script expects a configuration file, C<exec-nagios.conf>. You can find an
 257 example in the C<contrib/> directory, too.
 258
 259 Even a simple mechanism to submit "performance data" to collectd is
 260 implemented. If you need a more sophisticated setup, please rewrite the plugin
 261 to make use of collectd's more powerful interface.
 262
 263 =head1 CAVEATS
 264
 265 =over 4
 266
 267 =item
 268
 269 The user, the binary is executed as, may not have root privileges, i.E<nbsp>e.
 270 must have an UID that is non-zero. This is for your own good.
 271
 272 =item
 273
 274 Early versions of the plugin did not use a command but treated all lines as if
 275 they were arguments to the I<PUTVAL> command. When the I<PUTNOTIF> command was
 276 implemented, this behavior was kept for lines which start with an unknown
 277 command for backwards compatibility. This compatibility code has been removed
 278 in I<collectdE<nbsp>5>.
 279
 280 =back
 281
 282 =head1 SEE ALSO
 283
 284 L<collectd(1)>,
 285 L<collectd.conf(5)>,
 286 L<collectd-perl(5)>,
 287 L<collectd-unixsock(5)>,
 288 L<fork(2)>, L<exec(3)>
 289
 290 =head1 AUTHOR
 291
 292 Florian Forster E<lt>octo@verplant.orgE<gt>
 293
 294 =cut