1 #ifndef PLUGIN_H
2 #define PLUGIN_H
3 /**
4 * collectd - src/plugin.h
5 * Copyright (C) 2005-2007 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 **/
24 #include "collectd.h"
25 #include "configfile.h"
27 #define DATA_MAX_NAME_LEN 64
29 #define DS_TYPE_COUNTER 0
30 #define DS_TYPE_GAUGE 1
32 #ifndef LOG_ERR
33 # define LOG_ERR 3
34 #endif
35 #ifndef LOG_WARNING
36 # define LOG_WARNING 4
37 #endif
38 #ifndef LOG_NOTICE
39 # define LOG_NOTICE 5
40 #endif
41 #ifndef LOG_INFO
42 # define LOG_INFO 6
43 #endif
44 #ifndef LOG_DEBUG
45 # define LOG_DEBUG 7
46 #endif
48 #define NOTIF_MAX_MSG_LEN 256
50 #define NOTIF_FAILURE 1
51 #define NOTIF_WARNING 2
52 #define NOTIF_OKAY 4
54 /*
55 * Public data types
56 */
57 typedef unsigned long long counter_t;
58 typedef double gauge_t;
60 union value_u
61 {
62 counter_t counter;
63 gauge_t gauge;
64 };
65 typedef union value_u value_t;
67 struct value_list_s
68 {
69 value_t *values;
70 int values_len;
71 time_t time;
72 int interval;
73 char host[DATA_MAX_NAME_LEN];
74 char plugin[DATA_MAX_NAME_LEN];
75 char plugin_instance[DATA_MAX_NAME_LEN];
76 char type_instance[DATA_MAX_NAME_LEN];
77 };
78 typedef struct value_list_s value_list_t;
80 #define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "" }
81 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "" }
83 struct data_source_s
84 {
85 char name[DATA_MAX_NAME_LEN];
86 int type;
87 double min;
88 double max;
89 };
90 typedef struct data_source_s data_source_t;
92 struct data_set_s
93 {
94 char type[DATA_MAX_NAME_LEN];
95 int ds_num;
96 data_source_t *ds;
97 };
98 typedef struct data_set_s data_set_t;
100 typedef struct complain_s
101 {
102 unsigned int interval; /* how long we wait for reporting this error again */
103 unsigned int delay; /* how many more iterations we still need to wait */
104 } complain_t;
106 typedef struct notification_s
107 {
108 int severity;
109 char message[NOTIF_MAX_MSG_LEN];
110 time_t time;
111 char host[DATA_MAX_NAME_LEN];
112 } notification_t;
114 /*
115 * NAME
116 * plugin_set_dir
117 *
118 * DESCRIPTION
119 * Sets the current `plugindir'
120 *
121 * ARGUMENTS
122 * `dir' Path to the plugin directory
123 *
124 * NOTES
125 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
126 */
127 void plugin_set_dir (const char *dir);
129 /*
130 * NAME
131 * plugin_load
132 *
133 * DESCRIPTION
134 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
135 * named $type and loads it. Afterwards the plugin's `module_register'
136 * function is called, which then calls `plugin_register' to register callback
137 * functions.
138 *
139 * ARGUMENTS
140 * `name' Name of the plugin to load.
141 * `mr' Types of functions to request from the plugin.
142 *
143 * RETURN VALUE
144 * Returns zero upon success, a value greater than zero if no plugin was found
145 * and a value below zero if an error occurs.
146 *
147 * NOTES
148 * No attempt is made to re-load an already loaded module.
149 */
150 int plugin_load (const char *name);
152 void plugin_init_all (void);
153 void plugin_read_all (const int *loop);
154 void plugin_shutdown_all (void);
156 /*
157 * The `plugin_register_*' functions are used to make `config', `init',
158 * `read', `write' and `shutdown' functions known to the plugin
159 * infrastructure. Also, the data-formats are made public like this.
160 */
161 int plugin_register_config (const char *name,
162 int (*callback) (const char *key, const char *val),
163 const char **keys, int keys_num);
164 int plugin_register_complex_config (const char *type,
165 int (*callback) (oconfig_item_t *));
166 int plugin_register_init (const char *name,
167 int (*callback) (void));
168 int plugin_register_read (const char *name,
169 int (*callback) (void));
170 int plugin_register_write (const char *name,
171 int (*callback) (const data_set_t *ds, const value_list_t *vl));
172 int plugin_register_shutdown (char *name,
173 int (*callback) (void));
174 int plugin_register_data_set (const data_set_t *ds);
175 int plugin_register_log (char *name,
176 void (*callback) (int, const char *));
177 int plugin_register_notification (const char *name,
178 int (*callback) (const notification_t *notif));
180 int plugin_unregister_config (const char *name);
181 int plugin_unregister_complex_config (const char *name);
182 int plugin_unregister_init (const char *name);
183 int plugin_unregister_read (const char *name);
184 int plugin_unregister_write (const char *name);
185 int plugin_unregister_shutdown (const char *name);
186 int plugin_unregister_data_set (const char *name);
187 int plugin_unregister_log (const char *name);
188 int plugin_unregister_notification (const char *name);
191 /*
192 * NAME
193 * plugin_dispatch_values
194 *
195 * DESCRIPTION
196 * This function is called by reading processes with the values they've
197 * aquired. The function fetches the data-set definition (that has been
198 * registered using `plugin_register_data_set') and calls _all_ registered
199 * write-functions.
200 *
201 * ARGUMENTS
202 * `name' Name/type of the data-set that describe the values in `vl'.
203 * `vl' Value list of the values that have been read by a `read'
204 * function.
205 */
206 int plugin_dispatch_values (const char *name, value_list_t *vl);
208 int plugin_dispatch_notification (const notification_t *notif);
210 void plugin_log (int level, const char *format, ...);
211 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
212 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
213 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
214 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
215 #if COLLECT_DEBUG
216 # define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
217 #else /* COLLECT_DEBUG */
218 # define DEBUG(...) /* noop */
219 #endif /* ! COLLECT_DEBUG */
221 /* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */
222 void plugin_complain (int level, complain_t *c, const char *format, ...);
223 void plugin_relief (int level, complain_t *c, const char *format, ...);
225 const data_set_t *plugin_get_ds (const char *name);
227 #endif /* PLUGIN_H */