4 * collectd - src/plugin.h
5 * Copyright (C) 2005-2008 Florian octo Forster
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Florian octo Forster <octo at verplant.org>
22 * Sebastian Harl <sh at tokkee.org>
26 #include "configfile.h"
27 #include "meta_data.h"
28 #include "utils_time.h"
30 #define PLUGIN_FLAGS_GLOBAL 0x0001
32 #define DATA_MAX_NAME_LEN 64
34 #define DS_TYPE_COUNTER 0
35 #define DS_TYPE_GAUGE 1
36 #define DS_TYPE_DERIVE 2
37 #define DS_TYPE_ABSOLUTE 3
39 #define DS_TYPE_TO_STRING(t) (t == DS_TYPE_COUNTER) ? "counter" : \
40 (t == DS_TYPE_GAUGE) ? "gauge" : \
41 (t == DS_TYPE_DERIVE) ? "derive" : \
42 (t == DS_TYPE_ABSOLUTE) ? "absolute" : \
50 # define LOG_WARNING 4
62 #define NOTIF_MAX_MSG_LEN 256
64 #define NOTIF_FAILURE 1
65 #define NOTIF_WARNING 2
71 typedef unsigned long long counter_t;
72 typedef double gauge_t;
73 typedef int64_t derive_t;
74 typedef uint64_t absolute_t;
83 typedef union value_u value_t;
91 char host[DATA_MAX_NAME_LEN];
92 char plugin[DATA_MAX_NAME_LEN];
93 char plugin_instance[DATA_MAX_NAME_LEN];
94 char type[DATA_MAX_NAME_LEN];
95 char type_instance[DATA_MAX_NAME_LEN];
98 typedef struct value_list_s value_list_t;
100 #define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "", "", NULL }
101 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "", NULL }
105 char name[DATA_MAX_NAME_LEN];
110 typedef struct data_source_s data_source_t;
114 char type[DATA_MAX_NAME_LEN];
118 typedef struct data_set_s data_set_t;
120 enum notification_meta_type_e
124 NM_TYPE_UNSIGNED_INT,
129 typedef struct notification_meta_s
131 char name[DATA_MAX_NAME_LEN];
132 enum notification_meta_type_e type;
135 const char *nm_string;
136 int64_t nm_signed_int;
137 uint64_t nm_unsigned_int;
141 struct notification_meta_s *next;
142 } notification_meta_t;
144 typedef struct notification_s
148 char message[NOTIF_MAX_MSG_LEN];
149 char host[DATA_MAX_NAME_LEN];
150 char plugin[DATA_MAX_NAME_LEN];
151 char plugin_instance[DATA_MAX_NAME_LEN];
152 char type[DATA_MAX_NAME_LEN];
153 char type_instance[DATA_MAX_NAME_LEN];
154 notification_meta_t *meta;
160 void (*free_func) (void *);
162 typedef struct user_data_s user_data_t;
167 typedef int (*plugin_init_cb) (void);
168 typedef int (*plugin_read_cb) (user_data_t *);
169 typedef int (*plugin_write_cb) (const data_set_t *, const value_list_t *,
171 typedef int (*plugin_flush_cb) (cdtime_t timeout, const char *identifier,
173 typedef void (*plugin_log_cb) (int severity, const char *message,
175 typedef int (*plugin_shutdown_cb) (void);
176 typedef int (*plugin_notification_cb) (const notification_t *,
184 * Sets the current `plugindir'
187 * `dir' Path to the plugin directory
190 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
192 void plugin_set_dir (const char *dir);
199 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
200 * named $type and loads it. Afterwards the plugin's `module_register'
201 * function is called, which then calls `plugin_register' to register callback
205 * `name' Name of the plugin to load.
206 * `flags' Hints on how to handle this plugin.
209 * Returns zero upon success, a value greater than zero if no plugin was found
210 * and a value below zero if an error occurs.
213 * No attempt is made to re-load an already loaded module.
215 int plugin_load (const char *name, uint32_t flags);
217 void plugin_init_all (void);
218 void plugin_read_all (void);
219 int plugin_read_all_once (void);
220 void plugin_shutdown_all (void);
227 * Calls the write function of the given plugin with the provided data set and
228 * value list. It differs from `plugin_dispatch_value' in that it does not
229 * update the cache, does not do threshold checking, call the chain subsystem
230 * and so on. It looks up the requested plugin and invokes the function, end
234 * plugin Name of the plugin. If NULL, the value is sent to all registered
236 * ds Pointer to the data_set_t structure. If NULL, the data set is
237 * looked up according to the `type' member in the `vl' argument.
238 * vl The actual value to be processed. Must not be NULL.
241 * Returns zero upon success or non-zero if an error occurred. If `plugin' is
242 * NULL and more than one plugin is called, an error is only returned if *all*
246 * This is the function used by the `write' built-in target. May be used by
247 * other target plugins.
249 int plugin_write (const char *plugin,
250 const data_set_t *ds, const value_list_t *vl);
252 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier);
255 * The `plugin_register_*' functions are used to make `config', `init',
256 * `read', `write' and `shutdown' functions known to the plugin
257 * infrastructure. Also, the data-formats are made public like this.
259 int plugin_register_config (const char *name,
260 int (*callback) (const char *key, const char *val),
261 const char **keys, int keys_num);
262 int plugin_register_complex_config (const char *type,
263 int (*callback) (oconfig_item_t *));
264 int plugin_register_init (const char *name,
265 plugin_init_cb callback);
266 int plugin_register_read (const char *name,
267 int (*callback) (void));
268 int plugin_register_complex_read (const char *group, const char *name,
269 plugin_read_cb callback,
270 const struct timespec *interval,
271 user_data_t *user_data);
272 int plugin_register_write (const char *name,
273 plugin_write_cb callback, user_data_t *user_data);
274 int plugin_register_flush (const char *name,
275 plugin_flush_cb callback, user_data_t *user_data);
276 int plugin_register_shutdown (char *name,
277 plugin_shutdown_cb callback);
278 int plugin_register_data_set (const data_set_t *ds);
279 int plugin_register_log (const char *name,
280 plugin_log_cb callback, user_data_t *user_data);
281 int plugin_register_notification (const char *name,
282 plugin_notification_cb callback, user_data_t *user_data);
284 int plugin_unregister_config (const char *name);
285 int plugin_unregister_complex_config (const char *name);
286 int plugin_unregister_init (const char *name);
287 int plugin_unregister_read (const char *name);
288 int plugin_unregister_read_group (const char *group);
289 int plugin_unregister_write (const char *name);
290 int plugin_unregister_flush (const char *name);
291 int plugin_unregister_shutdown (const char *name);
292 int plugin_unregister_data_set (const char *name);
293 int plugin_unregister_log (const char *name);
294 int plugin_unregister_notification (const char *name);
299 * plugin_dispatch_values
302 * This function is called by reading processes with the values they've
303 * aquired. The function fetches the data-set definition (that has been
304 * registered using `plugin_register_data_set') and calls _all_ registered
308 * `vl' Value list of the values that have been read by a `read'
311 int plugin_dispatch_values (value_list_t *vl);
313 int plugin_dispatch_notification (const notification_t *notif);
315 void plugin_log (int level, const char *format, ...)
316 __attribute__ ((format(printf,2,3)));
318 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
319 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
320 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
321 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
323 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
324 #else /* COLLECT_DEBUG */
325 # define DEBUG(...) /* noop */
326 #endif /* ! COLLECT_DEBUG */
328 const data_set_t *plugin_get_ds (const char *name);
330 int plugin_notification_meta_add_string (notification_t *n,
333 int plugin_notification_meta_add_signed_int (notification_t *n,
336 int plugin_notification_meta_add_unsigned_int (notification_t *n,
339 int plugin_notification_meta_add_double (notification_t *n,
342 int plugin_notification_meta_add_boolean (notification_t *n,
346 int plugin_notification_meta_copy (notification_t *dst,
347 const notification_t *src);
349 int plugin_notification_meta_free (notification_meta_t *n);
351 #endif /* PLUGIN_H */