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