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