b90811cf93cc5c98e99fc090e588a28bce18dc63
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 **/
25 #include "collectd.h"
26 #include "configfile.h"
28 #define DATA_MAX_NAME_LEN 64
30 #define DS_TYPE_COUNTER 0
31 #define DS_TYPE_GAUGE 1
33 #ifndef LOG_ERR
34 # define LOG_ERR 3
35 #endif
36 #ifndef LOG_WARNING
37 # define LOG_WARNING 4
38 #endif
39 #ifndef LOG_NOTICE
40 # define LOG_NOTICE 5
41 #endif
42 #ifndef LOG_INFO
43 # define LOG_INFO 6
44 #endif
45 #ifndef LOG_DEBUG
46 # define LOG_DEBUG 7
47 #endif
49 #define NOTIF_MAX_MSG_LEN 256
51 #define NOTIF_FAILURE 1
52 #define NOTIF_WARNING 2
53 #define NOTIF_OKAY 4
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)
60 /*
61 * Public data types
62 */
63 typedef unsigned long long counter_t;
64 typedef double gauge_t;
66 union value_u
67 {
68 counter_t counter;
69 gauge_t gauge;
70 };
71 typedef union value_u value_t;
73 struct value_list_s
74 {
75 value_t *values;
76 int values_len;
77 time_t time;
78 int interval;
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];
84 };
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", "", "", "", "" }
90 struct data_source_s
91 {
92 char name[DATA_MAX_NAME_LEN];
93 int type;
94 double min;
95 double max;
96 };
97 typedef struct data_source_s data_source_t;
99 struct data_set_s
100 {
101 char type[DATA_MAX_NAME_LEN];
102 int ds_num;
103 data_source_t *ds;
104 };
105 typedef struct data_set_s data_set_t;
107 enum notification_meta_type_e
108 {
109 NM_TYPE_STRING,
110 NM_TYPE_SIGNED_INT,
111 NM_TYPE_UNSIGNED_INT,
112 NM_TYPE_DOUBLE,
113 NM_TYPE_BOOLEAN
114 };
116 typedef struct notification_meta_s
117 {
118 char name[DATA_MAX_NAME_LEN];
119 enum notification_meta_type_e type;
120 union
121 {
122 const char *value_string;
123 int64_t value_signed_int;
124 uint64_t value_unsigned_int;
125 double value_double;
126 bool value_boolean;
127 };
128 struct notification_meta_s *next;
129 } notification_meta_t;
131 typedef struct notification_s
132 {
133 int severity;
134 time_t time;
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;
142 } notification_t;
144 /*
145 * NAME
146 * plugin_set_dir
147 *
148 * DESCRIPTION
149 * Sets the current `plugindir'
150 *
151 * ARGUMENTS
152 * `dir' Path to the plugin directory
153 *
154 * NOTES
155 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
156 */
157 void plugin_set_dir (const char *dir);
159 /*
160 * NAME
161 * plugin_load
162 *
163 * DESCRIPTION
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
167 * functions.
168 *
169 * ARGUMENTS
170 * `name' Name of the plugin to load.
171 * `mr' Types of functions to request from the plugin.
172 *
173 * RETURN VALUE
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.
176 *
177 * NOTES
178 * No attempt is made to re-load an already loaded module.
179 */
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);
186 int plugin_flush (const char *plugin, int timeout, const char *identifier);
188 /*
189 * The `plugin_register_*' functions are used to make `config', `init',
190 * `read', `write' and `shutdown' functions known to the plugin
191 * infrastructure. Also, the data-formats are made public like this.
192 */
193 int plugin_register_config (const char *name,
194 int (*callback) (const char *key, const char *val),
195 const char **keys, int keys_num);
196 int plugin_register_complex_config (const char *type,
197 int (*callback) (oconfig_item_t *));
198 int plugin_register_init (const char *name,
199 int (*callback) (void));
200 int plugin_register_read (const char *name,
201 int (*callback) (void));
202 int plugin_register_write (const char *name,
203 int (*callback) (const data_set_t *ds, const value_list_t *vl));
204 int plugin_register_filter (const char *name,
205 int (*callback) (const data_set_t *ds, value_list_t *vl));
206 int plugin_register_flush (const char *name,
207 int (*callback) (const int timeout, const char *identifier));
208 int plugin_register_shutdown (char *name,
209 int (*callback) (void));
210 int plugin_register_data_set (const data_set_t *ds);
211 int plugin_register_log (char *name,
212 void (*callback) (int, const char *));
213 int plugin_register_notification (const char *name,
214 int (*callback) (const notification_t *notif));
216 int plugin_unregister_config (const char *name);
217 int plugin_unregister_complex_config (const char *name);
218 int plugin_unregister_init (const char *name);
219 int plugin_unregister_read (const char *name);
220 int plugin_unregister_write (const char *name);
221 int plugin_unregister_filter (const char *name);
222 int plugin_unregister_flush (const char *name);
223 int plugin_unregister_shutdown (const char *name);
224 int plugin_unregister_data_set (const char *name);
225 int plugin_unregister_log (const char *name);
226 int plugin_unregister_notification (const char *name);
229 /*
230 * NAME
231 * plugin_dispatch_values
232 *
233 * DESCRIPTION
234 * This function is called by reading processes with the values they've
235 * aquired. The function fetches the data-set definition (that has been
236 * registered using `plugin_register_data_set') and calls _all_ registered
237 * write-functions.
238 *
239 * ARGUMENTS
240 * `vl' Value list of the values that have been read by a `read'
241 * function.
242 */
243 int plugin_dispatch_values (value_list_t *vl);
245 int plugin_dispatch_notification (const notification_t *notif);
247 void plugin_log (int level, const char *format, ...)
248 __attribute__ ((format(printf,2,3)));
250 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
251 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
252 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
253 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
254 #if COLLECT_DEBUG
255 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
256 #else /* COLLECT_DEBUG */
257 # define DEBUG(...) /* noop */
258 #endif /* ! COLLECT_DEBUG */
260 const data_set_t *plugin_get_ds (const char *name);
262 int plugin_notification_meta_add_string (notification_t *n,
263 const char *name,
264 const char *value);
265 int plugin_notification_meta_add_signed_int (notification_t *n,
266 const char *name,
267 int64_t value);
268 int plugin_notification_meta_add_unsigned_int (notification_t *n,
269 const char *name,
270 uint64_t value);
271 int plugin_notification_meta_add_double (notification_t *n,
272 const char *name,
273 double value);
274 int plugin_notification_meta_add_boolean (notification_t *n,
275 const char *name,
276 bool value);
278 int plugin_notification_meta_copy (notification_t *dst,
279 const notification_t *src);
281 int plugin_notification_meta_free (notification_t *n);
283 #endif /* PLUGIN_H */