Debian Codegraph @

src/collectd-exec.pod

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