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"
28 #define DATA_MAX_NAME_LEN 64
30 #define DS_TYPE_COUNTER 0
31 #define DS_TYPE_GAUGE 1
37 # define LOG_WARNING 4
49 #define NOTIF_MAX_MSG_LEN 256
51 #define NOTIF_FAILURE 1
52 #define NOTIF_WARNING 2
58 typedef unsigned long long counter_t;
59 typedef double gauge_t;
66 typedef union value_u value_t;
74 char host[DATA_MAX_NAME_LEN];
75 char plugin[DATA_MAX_NAME_LEN];
76 char plugin_instance[DATA_MAX_NAME_LEN];
77 char type[DATA_MAX_NAME_LEN];
78 char type_instance[DATA_MAX_NAME_LEN];
80 typedef struct value_list_s value_list_t;
82 #define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "", "" }
83 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "" }
87 char name[DATA_MAX_NAME_LEN];
92 typedef struct data_source_s data_source_t;
96 char type[DATA_MAX_NAME_LEN];
100 typedef struct data_set_s data_set_t;
102 enum notification_meta_type_e
106 NM_TYPE_UNSIGNED_INT,
111 typedef struct notification_meta_s
113 char name[DATA_MAX_NAME_LEN];
114 enum notification_meta_type_e type;
117 const char *nm_string;
118 int64_t nm_signed_int;
119 uint64_t nm_unsigned_int;
123 struct notification_meta_s *next;
124 } notification_meta_t;
126 typedef struct notification_s
130 char message[NOTIF_MAX_MSG_LEN];
131 char host[DATA_MAX_NAME_LEN];
132 char plugin[DATA_MAX_NAME_LEN];
133 char plugin_instance[DATA_MAX_NAME_LEN];
134 char type[DATA_MAX_NAME_LEN];
135 char type_instance[DATA_MAX_NAME_LEN];
136 notification_meta_t *meta;
142 void (*free_func) (void *);
144 typedef struct user_data_s user_data_t;
149 typedef int (*plugin_init_cb) (void);
150 typedef int (*plugin_read_cb) (user_data_t *);
151 typedef int (*plugin_write_cb) (const data_set_t *, const value_list_t *,
153 typedef int (*plugin_flush_cb) (int timeout, const char *identifier,
155 typedef void (*plugin_log_cb) (int severity, const char *message,
157 typedef int (*plugin_shutdown_cb) (void);
158 typedef int (*plugin_notification_cb) (const notification_t *,
166 * Sets the current `plugindir'
169 * `dir' Path to the plugin directory
172 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
174 void plugin_set_dir (const char *dir);
181 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
182 * named $type and loads it. Afterwards the plugin's `module_register'
183 * function is called, which then calls `plugin_register' to register callback
187 * `name' Name of the plugin to load.
188 * `mr' Types of functions to request from the plugin.
191 * Returns zero upon success, a value greater than zero if no plugin was found
192 * and a value below zero if an error occurs.
195 * No attempt is made to re-load an already loaded module.
197 int plugin_load (const char *name);
199 void plugin_init_all (void);
200 void plugin_read_all (void);
201 int plugin_read_all_once (void);
202 void plugin_shutdown_all (void);
209 * Calls the write function of the given plugin with the provided data set and
210 * value list. It differs from `plugin_dispatch_value' in that it does not
211 * update the cache, does not do threshold checking, call the chain subsystem
212 * and so on. It looks up the requested plugin and invokes the function, end
216 * plugin Name of the plugin. If NULL, the value is sent to all registered
218 * ds Pointer to the data_set_t structure. If NULL, the data set is
219 * looked up according to the `type' member in the `vl' argument.
220 * vl The actual value to be processed. Must not be NULL.
223 * Returns zero upon success or non-zero if an error occurred. If `plugin' is
224 * NULL and more than one plugin is called, an error is only returned if *all*
228 * This is the function used by the `write' built-in target. May be used by
229 * other target plugins.
231 int plugin_write (const char *plugin,
232 const data_set_t *ds, const value_list_t *vl);
234 int plugin_flush (const char *plugin, int timeout, const char *identifier);
237 * The `plugin_register_*' functions are used to make `config', `init',
238 * `read', `write' and `shutdown' functions known to the plugin
239 * infrastructure. Also, the data-formats are made public like this.
241 int plugin_register_config (const char *name,
242 int (*callback) (const char *key, const char *val),
243 const char **keys, int keys_num);
244 int plugin_register_complex_config (const char *type,
245 int (*callback) (oconfig_item_t *));
246 int plugin_register_init (const char *name,
247 plugin_init_cb callback);
248 int plugin_register_read (const char *name,
249 int (*callback) (void));
250 int plugin_register_complex_read (const char *name,
251 plugin_read_cb callback, user_data_t *user_data);
252 int plugin_register_write (const char *name,
253 plugin_write_cb callback, user_data_t *user_data);
254 int plugin_register_flush (const char *name,
255 plugin_flush_cb callback, user_data_t *user_data);
256 int plugin_register_shutdown (char *name,
257 plugin_shutdown_cb callback);
258 int plugin_register_data_set (const data_set_t *ds);
259 int plugin_register_log (const char *name,
260 plugin_log_cb callback, user_data_t *user_data);
261 int plugin_register_notification (const char *name,
262 plugin_notification_cb callback, user_data_t *user_data);
264 int plugin_unregister_config (const char *name);
265 int plugin_unregister_complex_config (const char *name);
266 int plugin_unregister_init (const char *name);
267 int plugin_unregister_read (const char *name);
268 int plugin_unregister_complex_read (const char *name, void **user_data);
269 int plugin_unregister_write (const char *name);
270 int plugin_unregister_flush (const char *name);
271 int plugin_unregister_shutdown (const char *name);
272 int plugin_unregister_data_set (const char *name);
273 int plugin_unregister_log (const char *name);
274 int plugin_unregister_notification (const char *name);
279 * plugin_dispatch_values
282 * This function is called by reading processes with the values they've
283 * aquired. The function fetches the data-set definition (that has been
284 * registered using `plugin_register_data_set') and calls _all_ registered
288 * `vl' Value list of the values that have been read by a `read'
291 int plugin_dispatch_values (value_list_t *vl);
293 int plugin_dispatch_notification (const notification_t *notif);
295 void plugin_log (int level, const char *format, ...)
296 __attribute__ ((format(printf,2,3)));
298 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
299 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
300 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
301 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
303 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
304 #else /* COLLECT_DEBUG */
305 # define DEBUG(...) /* noop */
306 #endif /* ! COLLECT_DEBUG */
308 const data_set_t *plugin_get_ds (const char *name);
310 int plugin_notification_meta_add_string (notification_t *n,
313 int plugin_notification_meta_add_signed_int (notification_t *n,
316 int plugin_notification_meta_add_unsigned_int (notification_t *n,
319 int plugin_notification_meta_add_double (notification_t *n,
322 int plugin_notification_meta_add_boolean (notification_t *n,
326 int plugin_notification_meta_copy (notification_t *dst,
327 const notification_t *src);
329 int plugin_notification_meta_free (notification_meta_t *n);
331 #endif /* PLUGIN_H */