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 char host[DATA_MAX_NAME_LEN];
48 char plugin[DATA_MAX_NAME_LEN];
49 char plugin_instance[DATA_MAX_NAME_LEN];
50 char type_instance[DATA_MAX_NAME_LEN];
51 };
52 typedef struct value_list_s value_list_t;
54 struct data_source_s
55 {
56 char name[DATA_MAX_NAME_LEN];
57 int type;
58 double min;
59 double max;
60 };
61 typedef struct data_source_s data_source_t;
63 struct data_set_s
64 {
65 char type[DATA_MAX_NAME_LEN];
66 int ds_num;
67 data_source_t *ds;
68 };
69 typedef struct data_set_s data_set_t;
71 typedef struct complain_s
72 {
73 unsigned int interval; /* how long we wait for reporting this error again */
74 unsigned int delay; /* how many more iterations we still need to wait */
75 } complain_t;
77 /*
78 * NAME
79 * plugin_set_dir
80 *
81 * DESCRIPTION
82 * Sets the current `plugindir'
83 *
84 * ARGUMENTS
85 * `dir' Path to the plugin directory
86 *
87 * NOTES
88 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
89 */
90 void plugin_set_dir (const char *dir);
92 /*
93 * NAME
94 * plugin_load
95 *
96 * DESCRIPTION
97 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
98 * named $type and loads it. Afterwards the plugin's `module_register'
99 * function is called, which then calls `plugin_register' to register callback
100 * functions.
101 *
102 * ARGUMENTS
103 * `type' Name of the plugin to load.
104 *
105 * RETURN VALUE
106 * Returns zero upon success, a value greater than zero if no plugin was found
107 * and a value below zero if an error occurs.
108 *
109 * NOTES
110 * No attempt is made to re-load an already loaded module.
111 */
112 int plugin_load (const char *name);
114 void plugin_init_all (void);
115 void plugin_read_all (const int *loop);
116 void plugin_shutdown_all (void);
118 /*
119 * The `plugin_register_*' functions are used to make `config', `init',
120 * `read', `write' and `shutdown' functions known to the plugin
121 * infrastructure. Also, the data-formats are made public like this.
122 */
123 int plugin_register_config (const char *name,
124 int (*callback) (const char *key, const char *val),
125 const char **keys, int keys_num);
126 int plugin_register_init (const char *name,
127 int (*callback) (void));
128 int plugin_register_read (const char *name,
129 int (*callback) (void));
130 int plugin_register_write (const char *name,
131 int (*callback) (const data_set_t *ds, const value_list_t *vl));
132 int plugin_register_shutdown (char *name,
133 int (*callback) (void));
134 int plugin_register_data_set (const data_set_t *ds);
136 /*
137 * NAME
138 * plugin_dispatch_values
139 *
140 * DESCRIPTION
141 * This function is called by reading processes with the values they've
142 * aquired. The function fetches the data-set definition (that has been
143 * registered using `plugin_register_data_set') and calls _all_ registered
144 * write-functions.
145 *
146 * ARGUMENTS
147 * `name' Name/type of the data-set that describe the values in `vl'.
148 * `vl' Value list of the values that have been read by a `read'
149 * function.
150 */
151 int plugin_dispatch_values (const char *name, const value_list_t *vl);
153 /* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */
154 void plugin_complain (int level, complain_t *c, const char *format, ...);
155 void plugin_relief (int level, complain_t *c, const char *format, ...);
157 #endif /* PLUGIN_H */