2 * collectd - src/daemon/plugin.h
3 * Copyright (C) 2005-2014 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
25 * Sebastian Harl <sh at tokkee.org>
33 #include "configfile.h"
34 #include "meta_data.h"
35 #include "utils_time.h"
39 #define PLUGIN_FLAGS_GLOBAL 0x0001
41 #ifndef DATA_MAX_NAME_LEN
42 # define DATA_MAX_NAME_LEN 128
45 #define DS_TYPE_COUNTER 0
46 #define DS_TYPE_GAUGE 1
47 #define DS_TYPE_DERIVE 2
48 #define DS_TYPE_ABSOLUTE 3
50 #define DS_TYPE_TO_STRING(t) (t == DS_TYPE_COUNTER) ? "counter" : \
51 (t == DS_TYPE_GAUGE) ? "gauge" : \
52 (t == DS_TYPE_DERIVE) ? "derive" : \
53 (t == DS_TYPE_ABSOLUTE) ? "absolute" : \
61 # define LOG_WARNING 4
73 #define NOTIF_MAX_MSG_LEN 256
75 #define NOTIF_FAILURE 1
76 #define NOTIF_WARNING 2
79 #define plugin_interval (plugin_get_ctx().interval)
84 typedef unsigned long long counter_t;
85 typedef double gauge_t;
86 typedef int64_t derive_t;
87 typedef uint64_t absolute_t;
96 typedef union value_u value_t;
104 char host[DATA_MAX_NAME_LEN];
105 char plugin[DATA_MAX_NAME_LEN];
106 char plugin_instance[DATA_MAX_NAME_LEN];
107 char type[DATA_MAX_NAME_LEN];
108 char type_instance[DATA_MAX_NAME_LEN];
111 typedef struct value_list_s value_list_t;
113 #define VALUE_LIST_INIT { NULL, 0, 0, plugin_get_interval (), \
114 "localhost", "", "", "", "", NULL }
115 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "", NULL }
119 char name[DATA_MAX_NAME_LEN];
124 typedef struct data_source_s data_source_t;
128 char type[DATA_MAX_NAME_LEN];
132 typedef struct data_set_s data_set_t;
134 enum notification_meta_type_e
138 NM_TYPE_UNSIGNED_INT,
143 typedef struct notification_meta_s
145 char name[DATA_MAX_NAME_LEN];
146 enum notification_meta_type_e type;
149 const char *nm_string;
150 int64_t nm_signed_int;
151 uint64_t nm_unsigned_int;
155 struct notification_meta_s *next;
156 } notification_meta_t;
158 typedef struct notification_s
162 char message[NOTIF_MAX_MSG_LEN];
163 char host[DATA_MAX_NAME_LEN];
164 char plugin[DATA_MAX_NAME_LEN];
165 char plugin_instance[DATA_MAX_NAME_LEN];
166 char type[DATA_MAX_NAME_LEN];
167 char type_instance[DATA_MAX_NAME_LEN];
168 notification_meta_t *meta;
174 void (*free_func) (void *);
176 typedef struct user_data_s user_data_t;
181 cdtime_t flush_interval;
182 cdtime_t flush_timeout;
184 typedef struct plugin_ctx_s plugin_ctx_t;
189 typedef int (*plugin_init_cb) (void);
190 typedef int (*plugin_read_cb) (user_data_t *);
191 typedef int (*plugin_write_cb) (const data_set_t *, const value_list_t *,
193 typedef int (*plugin_flush_cb) (cdtime_t timeout, const char *identifier,
195 /* "missing" callback. Returns less than zero on failure, zero if other
196 * callbacks should be called, greater than zero if no more callbacks should be
198 typedef int (*plugin_missing_cb) (const value_list_t *, user_data_t *);
199 typedef void (*plugin_log_cb) (int severity, const char *message,
201 typedef int (*plugin_shutdown_cb) (void);
202 typedef int (*plugin_notification_cb) (const notification_t *,
210 * Sets the current `plugindir'
213 * `dir' Path to the plugin directory
216 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
218 void plugin_set_dir (const char *dir);
225 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
226 * named $type and loads it. Afterwards the plugin's `module_register'
227 * function is called, which then calls `plugin_register' to register callback
231 * `name' Name of the plugin to load.
232 * `flags' Hints on how to handle this plugin.
235 * Returns zero upon success, a value greater than zero if no plugin was found
236 * and a value below zero if an error occurs.
239 * Re-loading an already loaded module is detected and zero is returned in
242 int plugin_load (const char *name, uint32_t flags);
244 int plugin_init_all (void);
245 void plugin_read_all (void);
246 int plugin_read_all_once (void);
247 int plugin_shutdown_all (void);
254 * Calls the write function of the given plugin with the provided data set and
255 * value list. It differs from `plugin_dispatch_value' in that it does not
256 * update the cache, does not do threshold checking, call the chain subsystem
257 * and so on. It looks up the requested plugin and invokes the function, end
261 * plugin Name of the plugin. If NULL, the value is sent to all registered
263 * ds Pointer to the data_set_t structure. If NULL, the data set is
264 * looked up according to the `type' member in the `vl' argument.
265 * vl The actual value to be processed. Must not be NULL.
268 * Returns zero upon success or non-zero if an error occurred. If `plugin' is
269 * NULL and more than one plugin is called, an error is only returned if *all*
273 * This is the function used by the `write' built-in target. May be used by
274 * other target plugins.
276 int plugin_write (const char *plugin,
277 const data_set_t *ds, const value_list_t *vl);
279 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier);
282 * The `plugin_register_*' functions are used to make `config', `init',
283 * `read', `write' and `shutdown' functions known to the plugin
284 * infrastructure. Also, the data-formats are made public like this.
286 int plugin_register_config (const char *name,
287 int (*callback) (const char *key, const char *val),
288 const char **keys, int keys_num);
289 int plugin_register_complex_config (const char *type,
290 int (*callback) (oconfig_item_t *));
291 int plugin_register_init (const char *name,
292 plugin_init_cb callback);
293 int plugin_register_read (const char *name,
294 int (*callback) (void));
295 /* "user_data" will be freed automatically, unless
296 * "plugin_register_complex_read" returns an error (non-zero). */
297 int plugin_register_complex_read (const char *group, const char *name,
298 plugin_read_cb callback,
300 user_data_t *user_data);
301 int plugin_register_write (const char *name,
302 plugin_write_cb callback, user_data_t *user_data);
303 int plugin_register_flush (const char *name,
304 plugin_flush_cb callback, user_data_t *user_data);
305 int plugin_register_missing (const char *name,
306 plugin_missing_cb callback, user_data_t *user_data);
307 int plugin_register_shutdown (const char *name,
308 plugin_shutdown_cb callback);
309 int plugin_register_data_set (const data_set_t *ds);
310 int plugin_register_log (const char *name,
311 plugin_log_cb callback, user_data_t *user_data);
312 int plugin_register_notification (const char *name,
313 plugin_notification_cb callback, user_data_t *user_data);
315 int plugin_unregister_config (const char *name);
316 int plugin_unregister_complex_config (const char *name);
317 int plugin_unregister_init (const char *name);
318 int plugin_unregister_read (const char *name);
319 int plugin_unregister_read_group (const char *group);
320 int plugin_unregister_write (const char *name);
321 int plugin_unregister_flush (const char *name);
322 int plugin_unregister_missing (const char *name);
323 int plugin_unregister_shutdown (const char *name);
324 int plugin_unregister_data_set (const char *name);
325 int plugin_unregister_log (const char *name);
326 int plugin_unregister_notification (const char *name);
330 * plugin_log_available_writers
333 * This function can be called to output a list of _all_ registered
334 * writers to the logfacility.
335 * Since some writers dynamically build their name it can be hard for
336 * the configuring person to know it. This function will fill this gap.
338 void plugin_log_available_writers (void);
342 * plugin_dispatch_values
345 * This function is called by reading processes with the values they've
346 * aquired. The function fetches the data-set definition (that has been
347 * registered using `plugin_register_data_set') and calls _all_ registered
351 * `vl' Value list of the values that have been read by a `read'
354 int plugin_dispatch_values (value_list_t const *vl);
358 * plugin_dispatch_multivalue
361 * plugin_dispatch_multivalue (vl, 1, DS_TYPE_GAUGE,
367 * Takes a list of type instances and values and dispatches that in a batch,
368 * making sure that all values have the same time stamp. If "store_percentage"
369 * is set to true, the "type" is set to "percent" and a percentage is
370 * calculated and dispatched, rather than the absolute values. Values that are
371 * NaN are dispatched as NaN and will not influence the total.
373 * The variadic arguments is a list of type_instance / type pairs, that are
374 * interpreted as type "char const *" and type, encoded by their corresponding
377 * - "gauge_t" when "DS_TYPE_GAUGE"
378 * - "absolute_t" when "DS_TYPE_ABSOLUTE"
379 * - "derive_t" when "DS_TYPE_DERIVE"
380 * - "counter_t" when "DS_TYPE_COUNTER"
382 * The last argument must be
383 * a NULL pointer to signal end-of-list.
386 * The number of values it failed to dispatch (zero on success).
388 __attribute__((sentinel))
389 int plugin_dispatch_multivalue (value_list_t const *vl,
390 _Bool store_percentage, int store_type, ...);
392 int plugin_dispatch_missing (const value_list_t *vl);
394 int plugin_dispatch_notification (const notification_t *notif);
396 void plugin_log (int level, const char *format, ...)
397 __attribute__ ((format(printf,2,3)));
399 /* These functions return the parsed severity or less than zero on failure. */
400 int parse_log_severity (const char *severity);
401 int parse_notif_severity (const char *severity);
403 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
404 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
405 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
406 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
408 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
409 #else /* COLLECT_DEBUG */
410 # define DEBUG(...) /* noop */
411 #endif /* ! COLLECT_DEBUG */
413 const data_set_t *plugin_get_ds (const char *name);
415 int plugin_notification_meta_add_string (notification_t *n,
418 int plugin_notification_meta_add_signed_int (notification_t *n,
421 int plugin_notification_meta_add_unsigned_int (notification_t *n,
424 int plugin_notification_meta_add_double (notification_t *n,
427 int plugin_notification_meta_add_boolean (notification_t *n,
431 int plugin_notification_meta_copy (notification_t *dst,
432 const notification_t *src);
434 int plugin_notification_meta_free (notification_meta_t *n);
437 * Plugin context management.
440 void plugin_init_ctx (void);
442 plugin_ctx_t plugin_get_ctx (void);
443 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx);
447 * plugin_get_interval
450 * This function returns the current value of the plugin's interval. The
451 * return value will be strictly greater than zero in all cases. If
452 * everything else fails, it will fall back to 10 seconds.
454 cdtime_t plugin_get_interval (void);
457 * Context-aware thread management.
460 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
461 void *(*start_routine) (void *), void *arg);
464 * Plugins need to implement this
467 void module_register (void);
469 #endif /* PLUGIN_H */