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