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
55 #define FILTER_NOWRITE 1
56 #define FILTER_NOTHRESHOLD_CHECK 2
57 /* FILTER_IGNORE has to equal the bitwise or of all other filter flags */
58 #define FILTER_IGNORE (FILTER_NOWRITE | FILTER_NOTHRESHOLD_CHECK)
63 typedef unsigned long long counter_t;
64 typedef double gauge_t;
71 typedef union value_u value_t;
79 char host[DATA_MAX_NAME_LEN];
80 char plugin[DATA_MAX_NAME_LEN];
81 char plugin_instance[DATA_MAX_NAME_LEN];
82 char type[DATA_MAX_NAME_LEN];
83 char type_instance[DATA_MAX_NAME_LEN];
85 typedef struct value_list_s value_list_t;
87 #define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "", "" }
88 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "" }
92 char name[DATA_MAX_NAME_LEN];
97 typedef struct data_source_s data_source_t;
101 char type[DATA_MAX_NAME_LEN];
105 typedef struct data_set_s data_set_t;
107 enum notification_meta_type_e
111 NM_TYPE_UNSIGNED_INT,
116 typedef struct notification_meta_s
118 char name[DATA_MAX_NAME_LEN];
119 enum notification_meta_type_e type;
122 const char *value_string;
123 int64_t value_signed_int;
124 uint64_t value_unsigned_int;
128 struct notification_meta_s *next;
129 } notification_meta_t;
131 typedef struct notification_s
135 char message[NOTIF_MAX_MSG_LEN];
136 char host[DATA_MAX_NAME_LEN];
137 char plugin[DATA_MAX_NAME_LEN];
138 char plugin_instance[DATA_MAX_NAME_LEN];
139 char type[DATA_MAX_NAME_LEN];
140 char type_instance[DATA_MAX_NAME_LEN];
141 notification_meta_t *meta;
149 * Sets the current `plugindir'
152 * `dir' Path to the plugin directory
155 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
157 void plugin_set_dir (const char *dir);
164 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
165 * named $type and loads it. Afterwards the plugin's `module_register'
166 * function is called, which then calls `plugin_register' to register callback
170 * `name' Name of the plugin to load.
171 * `mr' Types of functions to request from the plugin.
174 * Returns zero upon success, a value greater than zero if no plugin was found
175 * and a value below zero if an error occurs.
178 * No attempt is made to re-load an already loaded module.
180 int plugin_load (const char *name);
182 void plugin_init_all (void);
183 void plugin_read_all (void);
184 void plugin_shutdown_all (void);
191 * Calls the write function of the given plugin with the provided data set and
192 * value list. It differs from `plugin_dispatch_value' in that it does not
193 * update the cache, does no do threshold checking, call the chain subsystem
194 * and so on. It looks up the requested plugin and invokes the function, end
198 * plugin Name of the plugin. If NULL, the value is sent to all registered
200 * ds Pointer to the data_set_t structure. If NULL, the data set is
201 * looked up according to the `type' member in the `vl' argument.
202 * vl The actual value to be processes. Must not be NULL.
205 * Returns zero upon success or non-zero if an error occurred. If `plugin' is
206 * NULL and more than one plugin is called, an error is only returned if *all*
210 * This is the function used by the `write' built-in target. May be used by
211 * other target plugins.
213 int plugin_write (const char *plugin,
214 const data_set_t *ds, const value_list_t *vl);
216 int plugin_flush (const char *plugin, int timeout, const char *identifier);
219 * The `plugin_register_*' functions are used to make `config', `init',
220 * `read', `write' and `shutdown' functions known to the plugin
221 * infrastructure. Also, the data-formats are made public like this.
223 int plugin_register_config (const char *name,
224 int (*callback) (const char *key, const char *val),
225 const char **keys, int keys_num);
226 int plugin_register_complex_config (const char *type,
227 int (*callback) (oconfig_item_t *));
228 int plugin_register_init (const char *name,
229 int (*callback) (void));
230 int plugin_register_read (const char *name,
231 int (*callback) (void));
232 int plugin_register_write (const char *name,
233 int (*callback) (const data_set_t *ds, const value_list_t *vl));
234 int plugin_register_filter (const char *name,
235 int (*callback) (const data_set_t *ds, value_list_t *vl));
236 int plugin_register_flush (const char *name,
237 int (*callback) (const int timeout, const char *identifier));
238 int plugin_register_shutdown (char *name,
239 int (*callback) (void));
240 int plugin_register_data_set (const data_set_t *ds);
241 int plugin_register_log (char *name,
242 void (*callback) (int, const char *));
243 int plugin_register_notification (const char *name,
244 int (*callback) (const notification_t *notif));
246 int plugin_unregister_config (const char *name);
247 int plugin_unregister_complex_config (const char *name);
248 int plugin_unregister_init (const char *name);
249 int plugin_unregister_read (const char *name);
250 int plugin_unregister_write (const char *name);
251 int plugin_unregister_filter (const char *name);
252 int plugin_unregister_flush (const char *name);
253 int plugin_unregister_shutdown (const char *name);
254 int plugin_unregister_data_set (const char *name);
255 int plugin_unregister_log (const char *name);
256 int plugin_unregister_notification (const char *name);
261 * plugin_dispatch_values
264 * This function is called by reading processes with the values they've
265 * aquired. The function fetches the data-set definition (that has been
266 * registered using `plugin_register_data_set') and calls _all_ registered
270 * `vl' Value list of the values that have been read by a `read'
273 int plugin_dispatch_values (value_list_t *vl);
275 int plugin_dispatch_notification (const notification_t *notif);
277 void plugin_log (int level, const char *format, ...)
278 __attribute__ ((format(printf,2,3)));
280 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
281 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
282 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
283 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
285 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
286 #else /* COLLECT_DEBUG */
287 # define DEBUG(...) /* noop */
288 #endif /* ! COLLECT_DEBUG */
290 const data_set_t *plugin_get_ds (const char *name);
292 int plugin_notification_meta_add_string (notification_t *n,
295 int plugin_notification_meta_add_signed_int (notification_t *n,
298 int plugin_notification_meta_add_unsigned_int (notification_t *n,
301 int plugin_notification_meta_add_double (notification_t *n,
304 int plugin_notification_meta_add_boolean (notification_t *n,
308 int plugin_notification_meta_copy (notification_t *dst,
309 const notification_t *src);
311 int plugin_notification_meta_free (notification_t *n);
313 #endif /* PLUGIN_H */