Merge branch 'collectd-4.10' into collectd-5.0
[collectd.git] / src / plugin.h
1 #ifndef PLUGIN_H
2 #define PLUGIN_H
3 /**
4  * collectd - src/plugin.h
5  * Copyright (C) 2005-2010  Florian octo Forster
6  *
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.
10  *
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.
15  *
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
19  *
20  * Authors:
21  *   Florian octo Forster <octo at collectd.org>
22  *   Sebastian Harl <sh at tokkee.org>
23  **/
24
25 #include "collectd.h"
26 #include "configfile.h"
27 #include "meta_data.h"
28 #include "utils_time.h"
29
30 #define PLUGIN_FLAGS_GLOBAL 0x0001
31
32 #define DATA_MAX_NAME_LEN 64
33
34 #define DS_TYPE_COUNTER  0
35 #define DS_TYPE_GAUGE    1
36 #define DS_TYPE_DERIVE   2
37 #define DS_TYPE_ABSOLUTE 3
38
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" : \
43                                 "unknown"
44
45
46 #ifndef LOG_ERR
47 # define LOG_ERR 3
48 #endif
49 #ifndef LOG_WARNING
50 # define LOG_WARNING 4
51 #endif
52 #ifndef LOG_NOTICE
53 # define LOG_NOTICE 5
54 #endif
55 #ifndef LOG_INFO
56 # define LOG_INFO 6
57 #endif
58 #ifndef LOG_DEBUG
59 # define LOG_DEBUG 7
60 #endif
61
62 #define NOTIF_MAX_MSG_LEN 256
63
64 #define NOTIF_FAILURE 1
65 #define NOTIF_WARNING 2
66 #define NOTIF_OKAY    4
67
68 /*
69  * Public data types
70  */
71 typedef unsigned long long counter_t;
72 typedef double gauge_t;
73 typedef int64_t derive_t;
74 typedef uint64_t absolute_t;
75
76 union value_u
77 {
78         counter_t  counter;
79         gauge_t    gauge;
80         derive_t   derive;
81         absolute_t absolute;
82 };
83 typedef union value_u value_t;
84
85 struct value_list_s
86 {
87         value_t *values;
88         int      values_len;
89         cdtime_t time;
90         cdtime_t interval;
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];
96         meta_data_t *meta;
97 };
98 typedef struct value_list_s value_list_t;
99
100 #define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "", "", NULL }
101 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "", NULL }
102
103 struct data_source_s
104 {
105         char   name[DATA_MAX_NAME_LEN];
106         int    type;
107         double min;
108         double max;
109 };
110 typedef struct data_source_s data_source_t;
111
112 struct data_set_s
113 {
114         char           type[DATA_MAX_NAME_LEN];
115         int            ds_num;
116         data_source_t *ds;
117 };
118 typedef struct data_set_s data_set_t;
119
120 enum notification_meta_type_e
121 {
122         NM_TYPE_STRING,
123         NM_TYPE_SIGNED_INT,
124         NM_TYPE_UNSIGNED_INT,
125         NM_TYPE_DOUBLE,
126         NM_TYPE_BOOLEAN
127 };
128
129 typedef struct notification_meta_s
130 {
131         char name[DATA_MAX_NAME_LEN];
132         enum notification_meta_type_e type;
133         union
134         {
135                 const char *nm_string;
136                 int64_t nm_signed_int;
137                 uint64_t nm_unsigned_int;
138                 double nm_double;
139                 _Bool nm_boolean;
140         } nm_value;
141         struct notification_meta_s *next;
142 } notification_meta_t;
143
144 typedef struct notification_s
145 {
146         int    severity;
147         cdtime_t time;
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;
155 } notification_t;
156
157 struct user_data_s
158 {
159         void *data;
160         void (*free_func) (void *);
161 };
162 typedef struct user_data_s user_data_t;
163
164 /*
165  * Callback types
166  */
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 *,
170                 user_data_t *);
171 typedef int (*plugin_flush_cb) (cdtime_t timeout, const char *identifier,
172                 user_data_t *);
173 /* "missing" callback. Returns less than zero on failure, zero if other
174  * callbacks should be called, greater than zero if no more callbacks should be
175  * called. */
176 typedef int (*plugin_missing_cb) (const value_list_t *, user_data_t *);
177 typedef void (*plugin_log_cb) (int severity, const char *message,
178                 user_data_t *);
179 typedef int (*plugin_shutdown_cb) (void);
180 typedef int (*plugin_notification_cb) (const notification_t *,
181                 user_data_t *);
182
183 /*
184  * NAME
185  *  plugin_set_dir
186  *
187  * DESCRIPTION
188  *  Sets the current `plugindir'
189  *
190  * ARGUMENTS
191  *  `dir'       Path to the plugin directory
192  *
193  * NOTES
194  *  If `dir' is NULL the compiled in default `PLUGINDIR' is used.
195  */
196 void plugin_set_dir (const char *dir);
197
198 /*
199  * NAME
200  *  plugin_load
201  *
202  * DESCRIPTION
203  *  Searches the current `plugindir' (see `plugin_set_dir') for the plugin
204  *  named $type and loads it. Afterwards the plugin's `module_register'
205  *  function is called, which then calls `plugin_register' to register callback
206  *  functions.
207  *
208  * ARGUMENTS
209  *  `name'      Name of the plugin to load.
210  *  `flags'     Hints on how to handle this plugin.
211  *
212  * RETURN VALUE
213  *  Returns zero upon success, a value greater than zero if no plugin was found
214  *  and a value below zero if an error occurs.
215  *
216  * NOTES
217  *  No attempt is made to re-load an already loaded module.
218  */
219 int plugin_load (const char *name, uint32_t flags);
220
221 void plugin_init_all (void);
222 void plugin_read_all (void);
223 int plugin_read_all_once (void);
224 void plugin_shutdown_all (void);
225
226 /*
227  * NAME
228  *  plugin_write
229  *
230  * DESCRIPTION
231  *  Calls the write function of the given plugin with the provided data set and
232  *  value list. It differs from `plugin_dispatch_value' in that it does not
233  *  update the cache, does not do threshold checking, call the chain subsystem
234  *  and so on. It looks up the requested plugin and invokes the function, end
235  *  of story.
236  *
237  * ARGUMENTS
238  *  plugin     Name of the plugin. If NULL, the value is sent to all registered
239  *             write functions.
240  *  ds         Pointer to the data_set_t structure. If NULL, the data set is
241  *             looked up according to the `type' member in the `vl' argument.
242  *  vl         The actual value to be processed. Must not be NULL.
243  *
244  * RETURN VALUE
245  *  Returns zero upon success or non-zero if an error occurred. If `plugin' is
246  *  NULL and more than one plugin is called, an error is only returned if *all*
247  *  plugins fail.
248  *
249  * NOTES
250  *  This is the function used by the `write' built-in target. May be used by
251  *  other target plugins.
252  */
253 int plugin_write (const char *plugin,
254     const data_set_t *ds, const value_list_t *vl);
255
256 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier);
257
258 /*
259  * The `plugin_register_*' functions are used to make `config', `init',
260  * `read', `write' and `shutdown' functions known to the plugin
261  * infrastructure. Also, the data-formats are made public like this.
262  */
263 int plugin_register_config (const char *name,
264                 int (*callback) (const char *key, const char *val),
265                 const char **keys, int keys_num);
266 int plugin_register_complex_config (const char *type,
267                 int (*callback) (oconfig_item_t *));
268 int plugin_register_init (const char *name,
269                 plugin_init_cb callback);
270 int plugin_register_read (const char *name,
271                 int (*callback) (void));
272 /* "user_data" will be freed automatically, unless
273  * "plugin_register_complex_read" returns an error (non-zero). */
274 int plugin_register_complex_read (const char *group, const char *name,
275                 plugin_read_cb callback,
276                 const struct timespec *interval,
277                 user_data_t *user_data);
278 int plugin_register_write (const char *name,
279                 plugin_write_cb callback, user_data_t *user_data);
280 int plugin_register_flush (const char *name,
281                 plugin_flush_cb callback, user_data_t *user_data);
282 int plugin_register_missing (const char *name,
283                 plugin_missing_cb callback, user_data_t *user_data);
284 int plugin_register_shutdown (const char *name,
285                 plugin_shutdown_cb callback);
286 int plugin_register_data_set (const data_set_t *ds);
287 int plugin_register_log (const char *name,
288                 plugin_log_cb callback, user_data_t *user_data);
289 int plugin_register_notification (const char *name,
290                 plugin_notification_cb callback, user_data_t *user_data);
291
292 int plugin_unregister_config (const char *name);
293 int plugin_unregister_complex_config (const char *name);
294 int plugin_unregister_init (const char *name);
295 int plugin_unregister_read (const char *name);
296 int plugin_unregister_read_group (const char *group);
297 int plugin_unregister_write (const char *name);
298 int plugin_unregister_flush (const char *name);
299 int plugin_unregister_missing (const char *name);
300 int plugin_unregister_shutdown (const char *name);
301 int plugin_unregister_data_set (const char *name);
302 int plugin_unregister_log (const char *name);
303 int plugin_unregister_notification (const char *name);
304
305
306 /*
307  * NAME
308  *  plugin_dispatch_values
309  *
310  * DESCRIPTION
311  *  This function is called by reading processes with the values they've
312  *  aquired. The function fetches the data-set definition (that has been
313  *  registered using `plugin_register_data_set') and calls _all_ registered
314  *  write-functions.
315  *
316  * ARGUMENTS
317  *  `vl'        Value list of the values that have been read by a `read'
318  *              function.
319  */
320 int plugin_dispatch_values (value_list_t *vl);
321 int plugin_dispatch_missing (const value_list_t *vl);
322
323 int plugin_dispatch_notification (const notification_t *notif);
324
325 void plugin_log (int level, const char *format, ...)
326         __attribute__ ((format(printf,2,3)));
327
328 #define ERROR(...)   plugin_log (LOG_ERR,     __VA_ARGS__)
329 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
330 #define NOTICE(...)  plugin_log (LOG_NOTICE,  __VA_ARGS__)
331 #define INFO(...)    plugin_log (LOG_INFO,    __VA_ARGS__)
332 #if COLLECT_DEBUG
333 # define DEBUG(...)  plugin_log (LOG_DEBUG,   __VA_ARGS__)
334 #else /* COLLECT_DEBUG */
335 # define DEBUG(...)  /* noop */
336 #endif /* ! COLLECT_DEBUG */
337
338 const data_set_t *plugin_get_ds (const char *name);
339
340 int plugin_notification_meta_add_string (notification_t *n,
341     const char *name,
342     const char *value);
343 int plugin_notification_meta_add_signed_int (notification_t *n,
344     const char *name,
345     int64_t value);
346 int plugin_notification_meta_add_unsigned_int (notification_t *n,
347     const char *name,
348     uint64_t value);
349 int plugin_notification_meta_add_double (notification_t *n,
350     const char *name,
351     double value);
352 int plugin_notification_meta_add_boolean (notification_t *n,
353     const char *name,
354     _Bool value);
355
356 int plugin_notification_meta_copy (notification_t *dst,
357     const notification_t *src);
358
359 int plugin_notification_meta_free (notification_meta_t *n);
360
361 #endif /* PLUGIN_H */