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_instance[DATA_MAX_NAME_LEN];
78 };
79 typedef struct value_list_s value_list_t;
81 #define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "" }
82 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "" }
84 struct data_source_s
85 {
86 char name[DATA_MAX_NAME_LEN];
87 int type;
88 double min;
89 double max;
90 };
91 typedef struct data_source_s data_source_t;
93 struct data_set_s
94 {
95 char type[DATA_MAX_NAME_LEN];
96 int ds_num;
97 data_source_t *ds;
98 };
99 typedef struct data_set_s data_set_t;
101 typedef struct notification_s
102 {
103 int severity;
104 time_t time;
105 char message[NOTIF_MAX_MSG_LEN];
106 char host[DATA_MAX_NAME_LEN];
107 char plugin[DATA_MAX_NAME_LEN];
108 char plugin_instance[DATA_MAX_NAME_LEN];
109 char type[DATA_MAX_NAME_LEN];
110 char type_instance[DATA_MAX_NAME_LEN];
111 } notification_t;
113 /*
114 * NAME
115 * plugin_set_dir
116 *
117 * DESCRIPTION
118 * Sets the current `plugindir'
119 *
120 * ARGUMENTS
121 * `dir' Path to the plugin directory
122 *
123 * NOTES
124 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
125 */
126 void plugin_set_dir (const char *dir);
128 /*
129 * NAME
130 * plugin_load
131 *
132 * DESCRIPTION
133 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
134 * named $type and loads it. Afterwards the plugin's `module_register'
135 * function is called, which then calls `plugin_register' to register callback
136 * functions.
137 *
138 * ARGUMENTS
139 * `name' Name of the plugin to load.
140 * `mr' Types of functions to request from the plugin.
141 *
142 * RETURN VALUE
143 * Returns zero upon success, a value greater than zero if no plugin was found
144 * and a value below zero if an error occurs.
145 *
146 * NOTES
147 * No attempt is made to re-load an already loaded module.
148 */
149 int plugin_load (const char *name);
151 void plugin_init_all (void);
152 void plugin_read_all (void);
153 void plugin_flush_all (int timeout);
154 void plugin_shutdown_all (void);
156 int plugin_flush_one (int timeout, const char *name);
158 /*
159 * The `plugin_register_*' functions are used to make `config', `init',
160 * `read', `write' and `shutdown' functions known to the plugin
161 * infrastructure. Also, the data-formats are made public like this.
162 */
163 int plugin_register_config (const char *name,
164 int (*callback) (const char *key, const char *val),
165 const char **keys, int keys_num);
166 int plugin_register_complex_config (const char *type,
167 int (*callback) (oconfig_item_t *));
168 int plugin_register_init (const char *name,
169 int (*callback) (void));
170 int plugin_register_read (const char *name,
171 int (*callback) (void));
172 int plugin_register_write (const char *name,
173 int (*callback) (const data_set_t *ds, const value_list_t *vl));
174 int plugin_register_flush (const char *name,
175 int (*callback) (const int));
176 int plugin_register_shutdown (char *name,
177 int (*callback) (void));
178 int plugin_register_data_set (const data_set_t *ds);
179 int plugin_register_log (char *name,
180 void (*callback) (int, const char *));
181 int plugin_register_notification (const char *name,
182 int (*callback) (const notification_t *notif));
184 int plugin_unregister_config (const char *name);
185 int plugin_unregister_complex_config (const char *name);
186 int plugin_unregister_init (const char *name);
187 int plugin_unregister_read (const char *name);
188 int plugin_unregister_write (const char *name);
189 int plugin_unregister_flush (const char *name);
190 int plugin_unregister_shutdown (const char *name);
191 int plugin_unregister_data_set (const char *name);
192 int plugin_unregister_log (const char *name);
193 int plugin_unregister_notification (const char *name);
196 /*
197 * NAME
198 * plugin_dispatch_values
199 *
200 * DESCRIPTION
201 * This function is called by reading processes with the values they've
202 * aquired. The function fetches the data-set definition (that has been
203 * registered using `plugin_register_data_set') and calls _all_ registered
204 * write-functions.
205 *
206 * ARGUMENTS
207 * `name' Name/type of the data-set that describe the values in `vl'.
208 * `vl' Value list of the values that have been read by a `read'
209 * function.
210 */
211 int plugin_dispatch_values (const char *name, value_list_t *vl);
213 int plugin_dispatch_notification (const notification_t *notif);
215 void plugin_log (int level, const char *format, ...);
216 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
217 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
218 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
219 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
220 #if COLLECT_DEBUG
221 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
222 #else /* COLLECT_DEBUG */
223 # define DEBUG(...) /* noop */
224 #endif /* ! COLLECT_DEBUG */
226 const data_set_t *plugin_get_ds (const char *name);
228 #endif /* PLUGIN_H */