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