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"
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) \
46 (t == DS_TYPE_COUNTER) \
48 : (t == DS_TYPE_GAUGE) \
50 : (t == DS_TYPE_DERIVE) \
52 : (t == DS_TYPE_ABSOLUTE) ? "absolute" : "unknown"
70 #define NOTIF_MAX_MSG_LEN 256
72 #define NOTIF_FAILURE 1
73 #define NOTIF_WARNING 2
76 #define plugin_interval (plugin_get_ctx().interval)
84 char *plugin_instance;
88 typedef struct identifier_s identifier_t;
90 typedef unsigned long long counter_t;
91 typedef double gauge_t;
92 typedef int64_t derive_t;
93 typedef uint64_t absolute_t;
101 typedef union value_u value_t;
103 struct value_list_s {
108 char host[DATA_MAX_NAME_LEN];
109 char plugin[DATA_MAX_NAME_LEN];
110 char plugin_instance[DATA_MAX_NAME_LEN];
111 char type[DATA_MAX_NAME_LEN];
112 char type_instance[DATA_MAX_NAME_LEN];
115 typedef struct value_list_s value_list_t;
117 #define VALUE_LIST_INIT \
118 { .values = NULL, .meta = NULL }
120 struct data_source_s {
121 char name[DATA_MAX_NAME_LEN];
126 typedef struct data_source_s data_source_t;
129 char type[DATA_MAX_NAME_LEN];
133 typedef struct data_set_s data_set_t;
135 enum notification_meta_type_e {
138 NM_TYPE_UNSIGNED_INT,
143 typedef struct notification_meta_s {
144 char name[DATA_MAX_NAME_LEN];
145 enum notification_meta_type_e type;
147 const char *nm_string;
148 int64_t nm_signed_int;
149 uint64_t nm_unsigned_int;
153 struct notification_meta_s *next;
154 } notification_meta_t;
156 typedef struct notification_s {
159 char message[NOTIF_MAX_MSG_LEN];
160 char host[DATA_MAX_NAME_LEN];
161 char plugin[DATA_MAX_NAME_LEN];
162 char plugin_instance[DATA_MAX_NAME_LEN];
163 char type[DATA_MAX_NAME_LEN];
164 char type_instance[DATA_MAX_NAME_LEN];
165 notification_meta_t *meta;
170 void (*free_func)(void *);
172 typedef struct user_data_s user_data_t;
174 struct plugin_ctx_s {
177 cdtime_t flush_interval;
178 cdtime_t flush_timeout;
180 typedef struct plugin_ctx_s plugin_ctx_t;
185 typedef int (*plugin_init_cb)(void);
186 typedef int (*plugin_read_cb)(user_data_t *);
187 typedef int (*plugin_write_cb)(const data_set_t *, const value_list_t *,
189 typedef int (*plugin_flush_cb)(cdtime_t timeout, const char *identifier,
191 /* "missing" callback. Returns less than zero on failure, zero if other
192 * callbacks should be called, greater than zero if no more callbacks should be
194 typedef int (*plugin_missing_cb)(const value_list_t *, user_data_t *);
195 typedef void (*plugin_log_cb)(int severity, const char *message, user_data_t *);
196 typedef int (*plugin_shutdown_cb)(void);
197 typedef int (*plugin_notification_cb)(const notification_t *, user_data_t *);
203 * Sets the current `plugindir'
206 * `dir' Path to the plugin directory
209 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
211 void plugin_set_dir(const char *dir);
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
224 * `name' Name of the plugin to load.
225 * `global' Make this plugins symbols available for other shared libraries.
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.
232 * Re-loading an already loaded module is detected and zero is returned in
235 int plugin_load(const char *name, bool global);
237 int plugin_init_all(void);
238 void plugin_read_all(void);
239 int plugin_read_all_once(void);
240 int plugin_shutdown_all(void);
247 * Calls the write function of the given plugin with the provided data set and
248 * value list. It differs from `plugin_dispatch_values' 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
254 * plugin Name of the plugin. If NULL, the value is sent to all registered
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.
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*
266 * This is the function used by the `write' built-in target. May be used by
267 * other target plugins.
269 int plugin_write(const char *plugin, const data_set_t *ds,
270 const value_list_t *vl);
272 int plugin_flush(const char *plugin, cdtime_t timeout, const char *identifier);
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.
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, plugin_init_cb callback);
285 int plugin_register_read(const char *name, int (*callback)(void));
286 /* "user_data" will be freed automatically, unless
287 * "plugin_register_complex_read" returns an error (non-zero). */
288 int plugin_register_complex_read(const char *group, const char *name,
289 plugin_read_cb callback, cdtime_t interval,
290 user_data_t const *user_data);
291 int plugin_register_write(const char *name, plugin_write_cb callback,
292 user_data_t const *user_data);
293 int plugin_register_flush(const char *name, plugin_flush_cb callback,
294 user_data_t const *user_data);
295 int plugin_register_missing(const char *name, plugin_missing_cb callback,
296 user_data_t const *user_data);
297 int plugin_register_shutdown(const char *name, plugin_shutdown_cb callback);
298 int plugin_register_data_set(const data_set_t *ds);
299 int plugin_register_log(const char *name, plugin_log_cb callback,
300 user_data_t const *user_data);
301 int plugin_register_notification(const char *name,
302 plugin_notification_cb callback,
303 user_data_t const *user_data);
305 int plugin_unregister_config(const char *name);
306 int plugin_unregister_complex_config(const char *name);
307 int plugin_unregister_init(const char *name);
308 int plugin_unregister_read(const char *name);
309 int plugin_unregister_read_group(const char *group);
310 int plugin_unregister_write(const char *name);
311 int plugin_unregister_flush(const char *name);
312 int plugin_unregister_missing(const char *name);
313 int plugin_unregister_shutdown(const char *name);
314 int plugin_unregister_data_set(const char *name);
315 int plugin_unregister_log(const char *name);
316 int plugin_unregister_notification(const char *name);
320 * plugin_log_available_writers
323 * This function can be called to output a list of _all_ registered
324 * writers to the logfacility.
325 * Since some writers dynamically build their name it can be hard for
326 * the configuring person to know it. This function will fill this gap.
328 void plugin_log_available_writers(void);
332 * plugin_dispatch_values
335 * This function is called by reading processes with the values they've
336 * aquired. The function fetches the data-set definition (that has been
337 * registered using `plugin_register_data_set') and calls _all_ registered
341 * `vl' Value list of the values that have been read by a `read'
344 int plugin_dispatch_values(value_list_t const *vl);
348 * plugin_dispatch_multivalue
351 * plugin_dispatch_multivalue (vl, true, DS_TYPE_GAUGE,
357 * Takes a list of type instances and values and dispatches that in a batch,
358 * making sure that all values have the same time stamp. If "store_percentage"
359 * is set to true, the "type" is set to "percent" and a percentage is
360 * calculated and dispatched, rather than the absolute values. Values that are
361 * NaN are dispatched as NaN and will not influence the total.
363 * The variadic arguments is a list of type_instance / type pairs, that are
364 * interpreted as type "char const *" and type, encoded by their corresponding
367 * - "gauge_t" when "DS_TYPE_GAUGE"
368 * - "absolute_t" when "DS_TYPE_ABSOLUTE"
369 * - "derive_t" when "DS_TYPE_DERIVE"
370 * - "counter_t" when "DS_TYPE_COUNTER"
372 * The last argument must be
373 * a NULL pointer to signal end-of-list.
376 * The number of values it failed to dispatch (zero on success).
378 __attribute__((sentinel)) int plugin_dispatch_multivalue(value_list_t const *vl,
379 bool store_percentage,
380 int store_type, ...);
382 int plugin_dispatch_missing(const value_list_t *vl);
384 int plugin_dispatch_notification(const notification_t *notif);
386 void plugin_log(int level, const char *format, ...)
387 __attribute__((format(printf, 2, 3)));
389 /* These functions return the parsed severity or less than zero on failure. */
390 int parse_log_severity(const char *severity);
391 int parse_notif_severity(const char *severity);
393 #define ERROR(...) plugin_log(LOG_ERR, __VA_ARGS__)
394 #define WARNING(...) plugin_log(LOG_WARNING, __VA_ARGS__)
395 #define NOTICE(...) plugin_log(LOG_NOTICE, __VA_ARGS__)
396 #define INFO(...) plugin_log(LOG_INFO, __VA_ARGS__)
398 #define DEBUG(...) plugin_log(LOG_DEBUG, __VA_ARGS__)
399 #else /* COLLECT_DEBUG */
400 #define DEBUG(...) /* noop */
401 #endif /* ! COLLECT_DEBUG */
403 /* This will log messages, prefixed by plugin name */
404 void daemon_log(int level, const char *format, ...)
405 __attribute__((format(printf, 2, 3)));
407 #define P_ERROR(...) daemon_log(LOG_ERR, __VA_ARGS__)
408 #define P_WARNING(...) daemon_log(LOG_WARNING, __VA_ARGS__)
409 #define P_NOTICE(...) daemon_log(LOG_NOTICE, __VA_ARGS__)
410 #define P_INFO(...) daemon_log(LOG_INFO, __VA_ARGS__)
412 const data_set_t *plugin_get_ds(const char *name);
414 int plugin_notification_meta_add_string(notification_t *n, const char *name,
416 int plugin_notification_meta_add_signed_int(notification_t *n, const char *name,
418 int plugin_notification_meta_add_unsigned_int(notification_t *n,
419 const char *name, uint64_t value);
420 int plugin_notification_meta_add_double(notification_t *n, const char *name,
422 int plugin_notification_meta_add_boolean(notification_t *n, const char *name,
425 int plugin_notification_meta_copy(notification_t *dst,
426 const notification_t *src);
428 int plugin_notification_meta_free(notification_meta_t *n);
431 * Plugin context management.
434 void plugin_init_ctx(void);
436 plugin_ctx_t plugin_get_ctx(void);
437 plugin_ctx_t plugin_set_ctx(plugin_ctx_t ctx);
441 * plugin_get_interval
444 * This function returns the current value of the plugin's interval. The
445 * return value will be strictly greater than zero in all cases. If
446 * everything else fails, it will fall back to 10 seconds.
448 cdtime_t plugin_get_interval(void);
451 * Context-aware thread management.
454 int plugin_thread_create(pthread_t *thread, const pthread_attr_t *attr,
455 void *(*start_routine)(void *), void *arg,
459 * Plugins need to implement this
462 void module_register(void);
464 #endif /* PLUGIN_H */