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 *value_string;
118 int64_t value_signed_int;
119 uint64_t value_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;
144 * Sets the current `plugindir'
147 * `dir' Path to the plugin directory
150 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
152 void plugin_set_dir (const char *dir);
159 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
160 * named $type and loads it. Afterwards the plugin's `module_register'
161 * function is called, which then calls `plugin_register' to register callback
165 * `name' Name of the plugin to load.
166 * `mr' Types of functions to request from the plugin.
169 * Returns zero upon success, a value greater than zero if no plugin was found
170 * and a value below zero if an error occurs.
173 * No attempt is made to re-load an already loaded module.
175 int plugin_load (const char *name);
177 void plugin_init_all (void);
178 void plugin_read_all (void);
179 void plugin_shutdown_all (void);
181 int plugin_flush (const char *plugin, int timeout, const char *identifier);
184 * The `plugin_register_*' functions are used to make `config', `init',
185 * `read', `write' and `shutdown' functions known to the plugin
186 * infrastructure. Also, the data-formats are made public like this.
188 int plugin_register_config (const char *name,
189 int (*callback) (const char *key, const char *val),
190 const char **keys, int keys_num);
191 int plugin_register_complex_config (const char *type,
192 int (*callback) (oconfig_item_t *));
193 int plugin_register_init (const char *name,
194 int (*callback) (void));
195 int plugin_register_read (const char *name,
196 int (*callback) (void));
197 int plugin_register_write (const char *name,
198 int (*callback) (const data_set_t *ds, const value_list_t *vl));
199 int plugin_register_flush (const char *name,
200 int (*callback) (const int timeout, const char *identifier));
201 int plugin_register_shutdown (char *name,
202 int (*callback) (void));
203 int plugin_register_data_set (const data_set_t *ds);
204 int plugin_register_log (char *name,
205 void (*callback) (int, const char *));
206 int plugin_register_notification (const char *name,
207 int (*callback) (const notification_t *notif));
209 int plugin_unregister_config (const char *name);
210 int plugin_unregister_complex_config (const char *name);
211 int plugin_unregister_init (const char *name);
212 int plugin_unregister_read (const char *name);
213 int plugin_unregister_write (const char *name);
214 int plugin_unregister_flush (const char *name);
215 int plugin_unregister_shutdown (const char *name);
216 int plugin_unregister_data_set (const char *name);
217 int plugin_unregister_log (const char *name);
218 int plugin_unregister_notification (const char *name);
223 * plugin_dispatch_values
226 * This function is called by reading processes with the values they've
227 * aquired. The function fetches the data-set definition (that has been
228 * registered using `plugin_register_data_set') and calls _all_ registered
232 * `vl' Value list of the values that have been read by a `read'
235 int plugin_dispatch_values (value_list_t *vl);
237 int plugin_dispatch_notification (const notification_t *notif);
239 void plugin_log (int level, const char *format, ...)
240 __attribute__ ((format(printf,2,3)));
242 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
243 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
244 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
245 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
247 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
248 #else /* COLLECT_DEBUG */
249 # define DEBUG(...) /* noop */
250 #endif /* ! COLLECT_DEBUG */
252 const data_set_t *plugin_get_ds (const char *name);
254 int plugin_notification_meta_add_string (notification_t *n,
257 int plugin_notification_meta_add_signed_int (notification_t *n,
260 int plugin_notification_meta_add_unsigned_int (notification_t *n,
263 int plugin_notification_meta_add_double (notification_t *n,
266 int plugin_notification_meta_add_boolean (notification_t *n,
270 int plugin_notification_meta_copy (notification_t *dst,
271 const notification_t *src);
273 int plugin_notification_meta_free (notification_t *n);
275 #endif /* PLUGIN_H */