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"
29 #define DATA_MAX_NAME_LEN 64
31 #define DS_TYPE_COUNTER 0
32 #define DS_TYPE_GAUGE 1
33 #define DS_TYPE_DERIVE 2
34 #define DS_TYPE_ABSOLUTE 3
36 #define DS_TYPE_TO_STRING(t) (t == DS_TYPE_COUNTER) ? "counter" : \
37 (t == DS_TYPE_GAUGE) ? "gauge" : \
38 (t == DS_TYPE_DERIVE) ? "derive" : \
39 (t == DS_TYPE_ABSOLUTE) ? "absolute" : \
47 # define LOG_WARNING 4
59 #define NOTIF_MAX_MSG_LEN 256
61 #define NOTIF_FAILURE 1
62 #define NOTIF_WARNING 2
68 typedef unsigned long long counter_t;
69 typedef double gauge_t;
70 typedef int64_t derive_t;
71 typedef uint64_t absolute_t;
80 typedef union value_u value_t;
88 char host[DATA_MAX_NAME_LEN];
89 char plugin[DATA_MAX_NAME_LEN];
90 char plugin_instance[DATA_MAX_NAME_LEN];
91 char type[DATA_MAX_NAME_LEN];
92 char type_instance[DATA_MAX_NAME_LEN];
95 typedef struct value_list_s value_list_t;
97 #define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "", "", NULL }
98 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "", NULL }
102 char name[DATA_MAX_NAME_LEN];
107 typedef struct data_source_s data_source_t;
111 char type[DATA_MAX_NAME_LEN];
115 typedef struct data_set_s data_set_t;
117 enum notification_meta_type_e
121 NM_TYPE_UNSIGNED_INT,
126 typedef struct notification_meta_s
128 char name[DATA_MAX_NAME_LEN];
129 enum notification_meta_type_e type;
132 const char *nm_string;
133 int64_t nm_signed_int;
134 uint64_t nm_unsigned_int;
138 struct notification_meta_s *next;
139 } notification_meta_t;
141 typedef struct notification_s
145 char message[NOTIF_MAX_MSG_LEN];
146 char host[DATA_MAX_NAME_LEN];
147 char plugin[DATA_MAX_NAME_LEN];
148 char plugin_instance[DATA_MAX_NAME_LEN];
149 char type[DATA_MAX_NAME_LEN];
150 char type_instance[DATA_MAX_NAME_LEN];
151 notification_meta_t *meta;
157 void (*free_func) (void *);
159 typedef struct user_data_s user_data_t;
164 typedef int (*plugin_init_cb) (void);
165 typedef int (*plugin_read_cb) (user_data_t *);
166 typedef int (*plugin_write_cb) (const data_set_t *, const value_list_t *,
168 typedef int (*plugin_flush_cb) (int timeout, const char *identifier,
170 typedef void (*plugin_log_cb) (int severity, const char *message,
172 typedef int (*plugin_shutdown_cb) (void);
173 typedef int (*plugin_notification_cb) (const notification_t *,
181 * Sets the current `plugindir'
184 * `dir' Path to the plugin directory
187 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
189 void plugin_set_dir (const char *dir);
196 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
197 * named $type and loads it. Afterwards the plugin's `module_register'
198 * function is called, which then calls `plugin_register' to register callback
202 * `name' Name of the plugin to load.
203 * `mr' Types of functions to request from the plugin.
206 * Returns zero upon success, a value greater than zero if no plugin was found
207 * and a value below zero if an error occurs.
210 * No attempt is made to re-load an already loaded module.
212 int plugin_load (const char *name);
214 void plugin_init_all (void);
215 void plugin_read_all (void);
216 int plugin_read_all_once (void);
217 void plugin_shutdown_all (void);
224 * Calls the write function of the given plugin with the provided data set and
225 * value list. It differs from `plugin_dispatch_value' in that it does not
226 * update the cache, does not do threshold checking, call the chain subsystem
227 * and so on. It looks up the requested plugin and invokes the function, end
231 * plugin Name of the plugin. If NULL, the value is sent to all registered
233 * ds Pointer to the data_set_t structure. If NULL, the data set is
234 * looked up according to the `type' member in the `vl' argument.
235 * vl The actual value to be processed. Must not be NULL.
238 * Returns zero upon success or non-zero if an error occurred. If `plugin' is
239 * NULL and more than one plugin is called, an error is only returned if *all*
243 * This is the function used by the `write' built-in target. May be used by
244 * other target plugins.
246 int plugin_write (const char *plugin,
247 const data_set_t *ds, const value_list_t *vl);
249 int plugin_flush (const char *plugin, int timeout, const char *identifier);
252 * The `plugin_register_*' functions are used to make `config', `init',
253 * `read', `write' and `shutdown' functions known to the plugin
254 * infrastructure. Also, the data-formats are made public like this.
256 int plugin_register_config (const char *name,
257 int (*callback) (const char *key, const char *val),
258 const char **keys, int keys_num);
259 int plugin_register_complex_config (const char *type,
260 int (*callback) (oconfig_item_t *));
261 int plugin_register_init (const char *name,
262 plugin_init_cb callback);
263 int plugin_register_read (const char *name,
264 int (*callback) (void));
265 int plugin_register_complex_read (const char *name,
266 plugin_read_cb callback,
267 const struct timespec *interval,
268 user_data_t *user_data);
269 int plugin_register_write (const char *name,
270 plugin_write_cb callback, user_data_t *user_data);
271 int plugin_register_flush (const char *name,
272 plugin_flush_cb callback, user_data_t *user_data);
273 int plugin_register_shutdown (char *name,
274 plugin_shutdown_cb callback);
275 int plugin_register_data_set (const data_set_t *ds);
276 int plugin_register_log (const char *name,
277 plugin_log_cb callback, user_data_t *user_data);
278 int plugin_register_notification (const char *name,
279 plugin_notification_cb callback, user_data_t *user_data);
281 int plugin_unregister_config (const char *name);
282 int plugin_unregister_complex_config (const char *name);
283 int plugin_unregister_init (const char *name);
284 int plugin_unregister_read (const char *name);
285 int plugin_unregister_complex_read (const char *name, void **user_data);
286 int plugin_unregister_write (const char *name);
287 int plugin_unregister_flush (const char *name);
288 int plugin_unregister_shutdown (const char *name);
289 int plugin_unregister_data_set (const char *name);
290 int plugin_unregister_log (const char *name);
291 int plugin_unregister_notification (const char *name);
296 * plugin_dispatch_values
299 * This function is called by reading processes with the values they've
300 * aquired. The function fetches the data-set definition (that has been
301 * registered using `plugin_register_data_set') and calls _all_ registered
305 * `vl' Value list of the values that have been read by a `read'
308 int plugin_dispatch_values (value_list_t *vl);
310 int plugin_dispatch_notification (const notification_t *notif);
312 void plugin_log (int level, const char *format, ...)
313 __attribute__ ((format(printf,2,3)));
315 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
316 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
317 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
318 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
320 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
321 #else /* COLLECT_DEBUG */
322 # define DEBUG(...) /* noop */
323 #endif /* ! COLLECT_DEBUG */
325 const data_set_t *plugin_get_ds (const char *name);
327 int plugin_notification_meta_add_string (notification_t *n,
330 int plugin_notification_meta_add_signed_int (notification_t *n,
333 int plugin_notification_meta_add_unsigned_int (notification_t *n,
336 int plugin_notification_meta_add_double (notification_t *n,
339 int plugin_notification_meta_add_boolean (notification_t *n,
343 int plugin_notification_meta_copy (notification_t *dst,
344 const notification_t *src);
346 int plugin_notification_meta_free (notification_meta_t *n);
348 #endif /* PLUGIN_H */