f66ed3e22e476694fa8e03f6f76cdec9080478c7
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 /*
56 * Public data types
57 */
58 typedef unsigned long long counter_t;
59 typedef double gauge_t;
61 union value_u
62 {
63 counter_t counter;
64 gauge_t gauge;
65 };
66 typedef union value_u value_t;
68 struct value_list_s
69 {
70 value_t *values;
71 int values_len;
72 time_t time;
73 int interval;
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];
79 };
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", "", "", "", "" }
85 struct data_source_s
86 {
87 char name[DATA_MAX_NAME_LEN];
88 int type;
89 double min;
90 double max;
91 };
92 typedef struct data_source_s data_source_t;
94 struct data_set_s
95 {
96 char type[DATA_MAX_NAME_LEN];
97 int ds_num;
98 data_source_t *ds;
99 };
100 typedef struct data_set_s data_set_t;
102 enum notification_meta_type_e
103 {
104 NM_TYPE_STRING,
105 NM_TYPE_SIGNED_INT,
106 NM_TYPE_UNSIGNED_INT,
107 NM_TYPE_DOUBLE,
108 NM_TYPE_BOOLEAN
109 };
111 typedef struct notification_meta_s
112 {
113 char name[DATA_MAX_NAME_LEN];
114 enum notification_meta_type_e type;
115 union
116 {
117 const char *value_string;
118 int64_t value_signed_int;
119 uint64_t value_unsigned_int;
120 double value_double;
121 bool value_boolean;
122 };
123 struct notification_meta_s *next;
124 } notification_meta_t;
126 typedef struct notification_s
127 {
128 int severity;
129 time_t time;
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;
137 } notification_t;
139 /*
140 * NAME
141 * plugin_set_dir
142 *
143 * DESCRIPTION
144 * Sets the current `plugindir'
145 *
146 * ARGUMENTS
147 * `dir' Path to the plugin directory
148 *
149 * NOTES
150 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
151 */
152 void plugin_set_dir (const char *dir);
154 /*
155 * NAME
156 * plugin_load
157 *
158 * DESCRIPTION
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
162 * functions.
163 *
164 * ARGUMENTS
165 * `name' Name of the plugin to load.
166 * `mr' Types of functions to request from the plugin.
167 *
168 * RETURN VALUE
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.
171 *
172 * NOTES
173 * No attempt is made to re-load an already loaded module.
174 */
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 void plugin_flush_all (int timeout);
182 int plugin_flush (const char *plugin, int timeout, const char *identifier);
184 /*
185 * The `plugin_register_*' functions are used to make `config', `init',
186 * `read', `write' and `shutdown' functions known to the plugin
187 * infrastructure. Also, the data-formats are made public like this.
188 */
189 int plugin_register_config (const char *name,
190 int (*callback) (const char *key, const char *val),
191 const char **keys, int keys_num);
192 int plugin_register_complex_config (const char *type,
193 int (*callback) (oconfig_item_t *));
194 int plugin_register_init (const char *name,
195 int (*callback) (void));
196 int plugin_register_read (const char *name,
197 int (*callback) (void));
198 int plugin_register_write (const char *name,
199 int (*callback) (const data_set_t *ds, const value_list_t *vl));
200 int plugin_register_flush (const char *name,
201 int (*callback) (const int timeout, const char *identifier));
202 int plugin_register_shutdown (char *name,
203 int (*callback) (void));
204 int plugin_register_data_set (const data_set_t *ds);
205 int plugin_register_log (char *name,
206 void (*callback) (int, const char *));
207 int plugin_register_notification (const char *name,
208 int (*callback) (const notification_t *notif));
210 int plugin_unregister_config (const char *name);
211 int plugin_unregister_complex_config (const char *name);
212 int plugin_unregister_init (const char *name);
213 int plugin_unregister_read (const char *name);
214 int plugin_unregister_write (const char *name);
215 int plugin_unregister_flush (const char *name);
216 int plugin_unregister_shutdown (const char *name);
217 int plugin_unregister_data_set (const char *name);
218 int plugin_unregister_log (const char *name);
219 int plugin_unregister_notification (const char *name);
222 /*
223 * NAME
224 * plugin_dispatch_values
225 *
226 * DESCRIPTION
227 * This function is called by reading processes with the values they've
228 * aquired. The function fetches the data-set definition (that has been
229 * registered using `plugin_register_data_set') and calls _all_ registered
230 * write-functions.
231 *
232 * ARGUMENTS
233 * `vl' Value list of the values that have been read by a `read'
234 * function.
235 */
236 int plugin_dispatch_values (value_list_t *vl);
238 int plugin_dispatch_notification (const notification_t *notif);
240 void plugin_log (int level, const char *format, ...)
241 __attribute__ ((format(printf,2,3)));
243 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
244 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
245 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
246 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
247 #if COLLECT_DEBUG
248 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
249 #else /* COLLECT_DEBUG */
250 # define DEBUG(...) /* noop */
251 #endif /* ! COLLECT_DEBUG */
253 const data_set_t *plugin_get_ds (const char *name);
255 int plugin_notification_meta_add_string (notification_t *n,
256 const char *name,
257 const char *value);
258 int plugin_notification_meta_add_signed_int (notification_t *n,
259 const char *name,
260 int64_t value);
261 int plugin_notification_meta_add_unsigned_int (notification_t *n,
262 const char *name,
263 uint64_t value);
264 int plugin_notification_meta_add_double (notification_t *n,
265 const char *name,
266 double value);
267 int plugin_notification_meta_add_boolean (notification_t *n,
268 const char *name,
269 bool value);
271 int plugin_notification_meta_copy (notification_t *dst,
272 const notification_t *src);
274 int plugin_notification_meta_free (notification_t *n);
276 #endif /* PLUGIN_H */