1 /**
2 * collectd - src/plugin.h
3 * Copyright (C) 2005-2014 Florian octo Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 * Sebastian Harl <sh at tokkee.org>
26 **/
28 #ifndef PLUGIN_H
29 #define PLUGIN_H
31 #include "collectd.h"
32 #include "configfile.h"
33 #include "meta_data.h"
34 #include "utils_time.h"
36 #define PLUGIN_FLAGS_GLOBAL 0x0001
38 #define DATA_MAX_NAME_LEN 64
40 #define DS_TYPE_COUNTER 0
41 #define DS_TYPE_GAUGE 1
42 #define DS_TYPE_DERIVE 2
43 #define DS_TYPE_ABSOLUTE 3
45 #define DS_TYPE_TO_STRING(t) (t == DS_TYPE_COUNTER) ? "counter" : \
46 (t == DS_TYPE_GAUGE) ? "gauge" : \
47 (t == DS_TYPE_DERIVE) ? "derive" : \
48 (t == DS_TYPE_ABSOLUTE) ? "absolute" : \
49 "unknown"
52 #ifndef LOG_ERR
53 # define LOG_ERR 3
54 #endif
55 #ifndef LOG_WARNING
56 # define LOG_WARNING 4
57 #endif
58 #ifndef LOG_NOTICE
59 # define LOG_NOTICE 5
60 #endif
61 #ifndef LOG_INFO
62 # define LOG_INFO 6
63 #endif
64 #ifndef LOG_DEBUG
65 # define LOG_DEBUG 7
66 #endif
68 #define NOTIF_MAX_MSG_LEN 256
70 #define NOTIF_FAILURE 1
71 #define NOTIF_WARNING 2
72 #define NOTIF_OKAY 4
74 #define plugin_interval (plugin_get_ctx().interval)
76 /*
77 * Public data types
78 */
79 typedef unsigned long long counter_t;
80 typedef double gauge_t;
81 typedef int64_t derive_t;
82 typedef uint64_t absolute_t;
84 union value_u
85 {
86 counter_t counter;
87 gauge_t gauge;
88 derive_t derive;
89 absolute_t absolute;
90 };
91 typedef union value_u value_t;
93 struct value_list_s
94 {
95 value_t *values;
96 int values_len;
97 cdtime_t time;
98 cdtime_t interval;
99 char host[DATA_MAX_NAME_LEN];
100 char plugin[DATA_MAX_NAME_LEN];
101 char plugin_instance[DATA_MAX_NAME_LEN];
102 char type[DATA_MAX_NAME_LEN];
103 char type_instance[DATA_MAX_NAME_LEN];
104 meta_data_t *meta;
105 };
106 typedef struct value_list_s value_list_t;
108 #define VALUE_LIST_INIT { NULL, 0, 0, plugin_get_interval (), \
109 "localhost", "", "", "", "", NULL }
110 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "", NULL }
112 struct data_source_s
113 {
114 char name[DATA_MAX_NAME_LEN];
115 int type;
116 double min;
117 double max;
118 };
119 typedef struct data_source_s data_source_t;
121 struct data_set_s
122 {
123 char type[DATA_MAX_NAME_LEN];
124 int ds_num;
125 data_source_t *ds;
126 };
127 typedef struct data_set_s data_set_t;
129 enum notification_meta_type_e
130 {
131 NM_TYPE_STRING,
132 NM_TYPE_SIGNED_INT,
133 NM_TYPE_UNSIGNED_INT,
134 NM_TYPE_DOUBLE,
135 NM_TYPE_BOOLEAN
136 };
138 typedef struct notification_meta_s
139 {
140 char name[DATA_MAX_NAME_LEN];
141 enum notification_meta_type_e type;
142 union
143 {
144 const char *nm_string;
145 int64_t nm_signed_int;
146 uint64_t nm_unsigned_int;
147 double nm_double;
148 _Bool nm_boolean;
149 } nm_value;
150 struct notification_meta_s *next;
151 } notification_meta_t;
153 typedef struct notification_s
154 {
155 int severity;
156 cdtime_t time;
157 char message[NOTIF_MAX_MSG_LEN];
158 char host[DATA_MAX_NAME_LEN];
159 char plugin[DATA_MAX_NAME_LEN];
160 char plugin_instance[DATA_MAX_NAME_LEN];
161 char type[DATA_MAX_NAME_LEN];
162 char type_instance[DATA_MAX_NAME_LEN];
163 notification_meta_t *meta;
164 } notification_t;
166 struct user_data_s
167 {
168 void *data;
169 void (*free_func) (void *);
170 };
171 typedef struct user_data_s user_data_t;
173 struct plugin_ctx_s
174 {
175 cdtime_t interval;
176 };
177 typedef struct plugin_ctx_s plugin_ctx_t;
179 /*
180 * Callback types
181 */
182 typedef int (*plugin_init_cb) (void);
183 typedef int (*plugin_read_cb) (user_data_t *);
184 typedef int (*plugin_write_cb) (const data_set_t *, const value_list_t *,
185 user_data_t *);
186 typedef int (*plugin_flush_cb) (cdtime_t timeout, const char *identifier,
187 user_data_t *);
188 /* "missing" callback. Returns less than zero on failure, zero if other
189 * callbacks should be called, greater than zero if no more callbacks should be
190 * called. */
191 typedef int (*plugin_missing_cb) (const value_list_t *, user_data_t *);
192 typedef void (*plugin_log_cb) (int severity, const char *message,
193 user_data_t *);
194 typedef int (*plugin_shutdown_cb) (void);
195 typedef int (*plugin_notification_cb) (const notification_t *,
196 user_data_t *);
198 /*
199 * NAME
200 * plugin_set_dir
201 *
202 * DESCRIPTION
203 * Sets the current `plugindir'
204 *
205 * ARGUMENTS
206 * `dir' Path to the plugin directory
207 *
208 * NOTES
209 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
210 */
211 void plugin_set_dir (const char *dir);
213 /*
214 * NAME
215 * plugin_load
216 *
217 * DESCRIPTION
218 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
219 * named $type and loads it. Afterwards the plugin's `module_register'
220 * function is called, which then calls `plugin_register' to register callback
221 * functions.
222 *
223 * ARGUMENTS
224 * `name' Name of the plugin to load.
225 * `flags' Hints on how to handle this plugin.
226 *
227 * RETURN VALUE
228 * Returns zero upon success, a value greater than zero if no plugin was found
229 * and a value below zero if an error occurs.
230 *
231 * NOTES
232 * Re-loading an already loaded module is detected and zero is returned in
233 * this case.
234 */
235 int plugin_load (const char *name, uint32_t flags);
237 void plugin_init_all (void);
238 void plugin_read_all (void);
239 int plugin_read_all_once (void);
240 void plugin_shutdown_all (void);
242 /*
243 * NAME
244 * plugin_write
245 *
246 * DESCRIPTION
247 * Calls the write function of the given plugin with the provided data set and
248 * value list. It differs from `plugin_dispatch_value' in that it does not
249 * update the cache, does not do threshold checking, call the chain subsystem
250 * and so on. It looks up the requested plugin and invokes the function, end
251 * of story.
252 *
253 * ARGUMENTS
254 * plugin Name of the plugin. If NULL, the value is sent to all registered
255 * write functions.
256 * ds Pointer to the data_set_t structure. If NULL, the data set is
257 * looked up according to the `type' member in the `vl' argument.
258 * vl The actual value to be processed. Must not be NULL.
259 *
260 * RETURN VALUE
261 * Returns zero upon success or non-zero if an error occurred. If `plugin' is
262 * NULL and more than one plugin is called, an error is only returned if *all*
263 * plugins fail.
264 *
265 * NOTES
266 * This is the function used by the `write' built-in target. May be used by
267 * other target plugins.
268 */
269 int plugin_write (const char *plugin,
270 const data_set_t *ds, const value_list_t *vl);
272 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier);
274 /*
275 * The `plugin_register_*' functions are used to make `config', `init',
276 * `read', `write' and `shutdown' functions known to the plugin
277 * infrastructure. Also, the data-formats are made public like this.
278 */
279 int plugin_register_config (const char *name,
280 int (*callback) (const char *key, const char *val),
281 const char **keys, int keys_num);
282 int plugin_register_complex_config (const char *type,
283 int (*callback) (oconfig_item_t *));
284 int plugin_register_init (const char *name,
285 plugin_init_cb callback);
286 int plugin_register_read (const char *name,
287 int (*callback) (void));
288 /* "user_data" will be freed automatically, unless
289 * "plugin_register_complex_read" returns an error (non-zero). */
290 int plugin_register_complex_read (const char *group, const char *name,
291 plugin_read_cb callback,
292 const struct timespec *interval,
293 user_data_t *user_data);
294 int plugin_register_write (const char *name,
295 plugin_write_cb callback, user_data_t *user_data);
296 int plugin_register_flush (const char *name,
297 plugin_flush_cb callback, user_data_t *user_data);
298 int plugin_register_missing (const char *name,
299 plugin_missing_cb callback, user_data_t *user_data);
300 int plugin_register_shutdown (const char *name,
301 plugin_shutdown_cb callback);
302 int plugin_register_data_set (const data_set_t *ds);
303 int plugin_register_log (const char *name,
304 plugin_log_cb callback, user_data_t *user_data);
305 int plugin_register_notification (const char *name,
306 plugin_notification_cb callback, user_data_t *user_data);
308 int plugin_unregister_config (const char *name);
309 int plugin_unregister_complex_config (const char *name);
310 int plugin_unregister_init (const char *name);
311 int plugin_unregister_read (const char *name);
312 int plugin_unregister_read_group (const char *group);
313 int plugin_unregister_write (const char *name);
314 int plugin_unregister_flush (const char *name);
315 int plugin_unregister_missing (const char *name);
316 int plugin_unregister_shutdown (const char *name);
317 int plugin_unregister_data_set (const char *name);
318 int plugin_unregister_log (const char *name);
319 int plugin_unregister_notification (const char *name);
322 /*
323 * NAME
324 * plugin_dispatch_values
325 *
326 * DESCRIPTION
327 * This function is called by reading processes with the values they've
328 * aquired. The function fetches the data-set definition (that has been
329 * registered using `plugin_register_data_set') and calls _all_ registered
330 * write-functions.
331 *
332 * ARGUMENTS
333 * `vl' Value list of the values that have been read by a `read'
334 * function.
335 */
336 int plugin_dispatch_values (value_list_t const *vl);
338 /*
339 * NAME
340 * plugin_dispatch_multivalue
341 *
342 * SYNOPSIS
343 * plugin_dispatch_multivalue (vl, 1,
344 * "free", 42.0,
345 * "used", 58.0,
346 * NULL);
347 *
348 * DESCRIPTION
349 * Takes a list of type instances and values and dispatches that in a batch,
350 * making sure that all values have the same time stamp. If "store_percentage"
351 * is set to true, the "type" is set to "percent" and a percentage is
352 * calculated and dispatched, rather than the absolute values. Values that are
353 * NaN are dispatched as NaN and will not influence the total.
354 *
355 * The variadic arguments is a list of type_instance / gauge pairs, that are
356 * interpreted as type "char const *" and "gauge_t". The last argument must be
357 * a NULL pointer to signal end-of-list.
358 *
359 * RETURNS
360 * The number of values it failed to dispatch (zero on success).
361 */
362 __attribute__((sentinel))
363 int plugin_dispatch_multivalue (value_list_t const *vl,
364 _Bool store_percentage, ...);
366 int plugin_dispatch_missing (const value_list_t *vl);
368 int plugin_dispatch_notification (const notification_t *notif);
370 void plugin_log (int level, const char *format, ...)
371 __attribute__ ((format(printf,2,3)));
373 /* These functions return the parsed severity or less than zero on failure. */
374 int parse_log_severity (const char *severity);
375 int parse_notif_severity (const char *severity);
377 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
378 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
379 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
380 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
381 #if COLLECT_DEBUG
382 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
383 #else /* COLLECT_DEBUG */
384 # define DEBUG(...) /* noop */
385 #endif /* ! COLLECT_DEBUG */
387 const data_set_t *plugin_get_ds (const char *name);
389 int plugin_notification_meta_add_string (notification_t *n,
390 const char *name,
391 const char *value);
392 int plugin_notification_meta_add_signed_int (notification_t *n,
393 const char *name,
394 int64_t value);
395 int plugin_notification_meta_add_unsigned_int (notification_t *n,
396 const char *name,
397 uint64_t value);
398 int plugin_notification_meta_add_double (notification_t *n,
399 const char *name,
400 double value);
401 int plugin_notification_meta_add_boolean (notification_t *n,
402 const char *name,
403 _Bool value);
405 int plugin_notification_meta_copy (notification_t *dst,
406 const notification_t *src);
408 int plugin_notification_meta_free (notification_meta_t *n);
410 /*
411 * Plugin context management.
412 */
414 void plugin_init_ctx (void);
416 plugin_ctx_t plugin_get_ctx (void);
417 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx);
419 /*
420 * NAME
421 * plugin_get_interval
422 *
423 * DESCRIPTION
424 * This function returns the current value of the plugin's interval. The
425 * return value will be strictly greater than zero in all cases. If
426 * everything else fails, it will fall back to 10 seconds.
427 */
428 cdtime_t plugin_get_interval (void);
430 /*
431 * Context-aware thread management.
432 */
434 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
435 void *(*start_routine) (void *), void *arg);
437 #endif /* PLUGIN_H */