5 * collectd - src/plugin.h
6 * Copyright (C) 2005,2006 Florian octo Forster
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; only version 2 of the License is applicable.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Florian octo Forster <octo at verplant.org>
25 #define DATA_MAX_NAME_LEN 64
27 #define DS_TYPE_COUNTER 0
28 #define DS_TYPE_GAUGE 1
34 # define LOG_WARNING 4
49 typedef unsigned long long counter_t;
50 typedef double gauge_t;
57 typedef union value_u value_t;
64 char host[DATA_MAX_NAME_LEN];
65 char plugin[DATA_MAX_NAME_LEN];
66 char plugin_instance[DATA_MAX_NAME_LEN];
67 char type_instance[DATA_MAX_NAME_LEN];
69 typedef struct value_list_s value_list_t;
71 #define VALUE_LIST_INIT { NULL, 0, 0, "localhost", "", "", "" }
75 char name[DATA_MAX_NAME_LEN];
80 typedef struct data_source_s data_source_t;
84 char type[DATA_MAX_NAME_LEN];
88 typedef struct data_set_s data_set_t;
90 typedef struct complain_s
92 unsigned int interval; /* how long we wait for reporting this error again */
93 unsigned int delay; /* how many more iterations we still need to wait */
101 * Sets the current `plugindir'
104 * `dir' Path to the plugin directory
107 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
109 void plugin_set_dir (const char *dir);
116 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
117 * named $type and loads it. Afterwards the plugin's `module_register'
118 * function is called, which then calls `plugin_register' to register callback
122 * `name' Name of the plugin to load.
123 * `mr' Types of functions to request from the plugin.
126 * Returns zero upon success, a value greater than zero if no plugin was found
127 * and a value below zero if an error occurs.
130 * No attempt is made to re-load an already loaded module.
132 int plugin_load (const char *name);
134 void plugin_init_all (void);
135 void plugin_read_all (const int *loop);
136 void plugin_shutdown_all (void);
139 * The `plugin_register_*' functions are used to make `config', `init',
140 * `read', `write' and `shutdown' functions known to the plugin
141 * infrastructure. Also, the data-formats are made public like this.
143 int plugin_register_config (const char *name,
144 int (*callback) (const char *key, const char *val),
145 const char **keys, int keys_num);
146 int plugin_register_init (const char *name,
147 int (*callback) (void));
148 int plugin_register_read (const char *name,
149 int (*callback) (void));
150 int plugin_register_write (const char *name,
151 int (*callback) (const data_set_t *ds, const value_list_t *vl));
152 int plugin_register_shutdown (char *name,
153 int (*callback) (void));
154 int plugin_register_data_set (const data_set_t *ds);
155 int plugin_register_log (char *name,
156 void (*callback) (int, const char *));
158 int plugin_unregister_config (const char *name);
159 int plugin_unregister_init (const char *name);
160 int plugin_unregister_read (const char *name);
161 int plugin_unregister_write (const char *name);
162 int plugin_unregister_shutdown (const char *name);
163 int plugin_unregister_data_set (const char *name);
164 int plugin_unregister_log (const char *name);
168 * plugin_dispatch_values
171 * This function is called by reading processes with the values they've
172 * aquired. The function fetches the data-set definition (that has been
173 * registered using `plugin_register_data_set') and calls _all_ registered
177 * `name' Name/type of the data-set that describe the values in `vl'.
178 * `vl' Value list of the values that have been read by a `read'
181 int plugin_dispatch_values (const char *name, value_list_t *vl);
183 void plugin_log (int level, const char *format, ...);
184 #define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__)
185 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
186 #define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__)
187 #define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__)
188 #define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__)
190 /* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */
191 void plugin_complain (int level, complain_t *c, const char *format, ...);
192 void plugin_relief (int level, complain_t *c, const char *format, ...);
194 const data_set_t *plugin_get_ds (const char *name);
196 #endif /* PLUGIN_H */