1 #ifndef PLUGIN_H
2 #define PLUGIN_H
4 /**
5 * collectd - src/plugin.h
6 * Copyright (C) 2005,2006 Florian octo Forster
7 *
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.
11 *
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.
16 *
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
20 *
21 * Authors:
22 * Florian octo Forster <octo at verplant.org>
23 **/
25 #define DATA_MAX_NAME_LEN 64
27 #define DS_TYPE_COUNTER 0
28 #define DS_TYPE_GAUGE 1
30 /*
31 * Public data types
32 */
33 typedef unsigned long long counter_t;
34 typedef double gauge_t;
36 union value_u
37 {
38 counter_t counter;
39 gauge_t gauge;
40 };
41 typedef union value_u value_t;
43 struct value_list_s
44 {
45 value_t *values;
46 int values_len;
47 time_t time;
48 char host[DATA_MAX_NAME_LEN];
49 char plugin[DATA_MAX_NAME_LEN];
50 char plugin_instance[DATA_MAX_NAME_LEN];
51 char type_instance[DATA_MAX_NAME_LEN];
52 };
53 typedef struct value_list_s value_list_t;
55 #define VALUE_LIST_INIT { NULL, 0, 0, "localhost", "", "", "" }
57 struct data_source_s
58 {
59 char name[DATA_MAX_NAME_LEN];
60 int type;
61 double min;
62 double max;
63 };
64 typedef struct data_source_s data_source_t;
66 struct data_set_s
67 {
68 char type[DATA_MAX_NAME_LEN];
69 int ds_num;
70 data_source_t *ds;
71 };
72 typedef struct data_set_s data_set_t;
74 typedef struct complain_s
75 {
76 unsigned int interval; /* how long we wait for reporting this error again */
77 unsigned int delay; /* how many more iterations we still need to wait */
78 } complain_t;
80 /*
81 * NAME
82 * plugin_set_dir
83 *
84 * DESCRIPTION
85 * Sets the current `plugindir'
86 *
87 * ARGUMENTS
88 * `dir' Path to the plugin directory
89 *
90 * NOTES
91 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
92 */
93 void plugin_set_dir (const char *dir);
95 /*
96 * NAME
97 * plugin_load
98 *
99 * DESCRIPTION
100 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
101 * named $type and loads it. Afterwards the plugin's `module_register'
102 * function is called, which then calls `plugin_register' to register callback
103 * functions.
104 *
105 * ARGUMENTS
106 * `type' Name of the plugin to load.
107 *
108 * RETURN VALUE
109 * Returns zero upon success, a value greater than zero if no plugin was found
110 * and a value below zero if an error occurs.
111 *
112 * NOTES
113 * No attempt is made to re-load an already loaded module.
114 */
115 int plugin_load (const char *name);
117 void plugin_init_all (void);
118 void plugin_read_all (const int *loop);
119 void plugin_shutdown_all (void);
121 /*
122 * The `plugin_register_*' functions are used to make `config', `init',
123 * `read', `write' and `shutdown' functions known to the plugin
124 * infrastructure. Also, the data-formats are made public like this.
125 */
126 int plugin_register_config (const char *name,
127 int (*callback) (const char *key, const char *val),
128 const char **keys, int keys_num);
129 int plugin_register_init (const char *name,
130 int (*callback) (void));
131 int plugin_register_read (const char *name,
132 int (*callback) (void));
133 int plugin_register_write (const char *name,
134 int (*callback) (const data_set_t *ds, const value_list_t *vl));
135 int plugin_register_shutdown (char *name,
136 int (*callback) (void));
137 int plugin_register_data_set (const data_set_t *ds);
139 /*
140 * NAME
141 * plugin_dispatch_values
142 *
143 * DESCRIPTION
144 * This function is called by reading processes with the values they've
145 * aquired. The function fetches the data-set definition (that has been
146 * registered using `plugin_register_data_set') and calls _all_ registered
147 * write-functions.
148 *
149 * ARGUMENTS
150 * `name' Name/type of the data-set that describe the values in `vl'.
151 * `vl' Value list of the values that have been read by a `read'
152 * function.
153 */
154 int plugin_dispatch_values (const char *name, const value_list_t *vl);
156 /* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */
157 void plugin_complain (int level, complain_t *c, const char *format, ...);
158 void plugin_relief (int level, complain_t *c, const char *format, ...);
160 #endif /* PLUGIN_H */