611fa572507db6a4222095c62f04b00ab17569cd
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; either version 2 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 * Authors:
23 * Florian octo Forster <octo at verplant.org>
24 **/
26 #define DATA_MAX_NAME_LEN 64
28 #define DS_TYPE_COUNTER 0
29 #define DS_TYPE_GAUGE 1
31 /*
32 * Public data types
33 */
34 typedef unsigned long long counter_t;
35 typedef double gauge_t;
37 union value_u
38 {
39 counter_t counter;
40 gauge_t gauge;
41 };
42 typedef union value_u value_t;
44 struct value_list_s
45 {
46 value_t *values;
47 int values_len;
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 struct data_source_s
56 {
57 char name[DATA_MAX_NAME_LEN];
58 int type;
59 double min;
60 double max;
61 };
62 typedef struct data_source_s data_source_t;
64 struct data_set_s
65 {
66 char type[DATA_MAX_NAME_LEN];
67 int ds_num;
68 data_source_t *ds;
69 char *filename;
70 };
71 typedef struct data_set_s data_set_t;
73 typedef struct complain_s
74 {
75 unsigned int interval; /* how long we wait for reporting this error again */
76 unsigned int delay; /* how many more iterations we still need to wait */
77 } complain_t;
79 /*
80 * NAME
81 * plugin_set_dir
82 *
83 * DESCRIPTION
84 * Sets the current `plugindir'
85 *
86 * ARGUMENTS
87 * `dir' Path to the plugin directory
88 *
89 * NOTES
90 * If `dir' is NULL the compiled in default `PLUGINDIR' is used.
91 */
92 void plugin_set_dir (const char *dir);
94 /*
95 * NAME
96 * plugin_load
97 *
98 * DESCRIPTION
99 * Searches the current `plugindir' (see `plugin_set_dir') for the plugin
100 * named $type and loads it. Afterwards the plugin's `module_register'
101 * function is called, which then calls `plugin_register' to register callback
102 * functions.
103 *
104 * ARGUMENTS
105 * `type' Name of the plugin to load.
106 *
107 * RETURN VALUE
108 * Returns zero upon success, a value greater than zero if no plugin was found
109 * and a value below zero if an error occurs.
110 *
111 * NOTES
112 * No attempt is made to re-load an already loaded module.
113 */
114 int plugin_load (const char *name);
116 void plugin_init_all (void);
117 void plugin_read_all (const int *loop);
118 void plugin_shutdown_all (void);
120 /*
121 * The `plugin_register_*' functions are used to make `config', `init',
122 * `read', `write' and `shutdown' functions known to the plugin
123 * infrastructure. Also, the data-formats are made public like this.
124 */
125 int plugin_register_config (const char *name,
126 int (*callback) (const char *key, const char *val),
127 const char **keys, int keys_num);
128 int plugin_register_init (const char *name,
129 int (*callback) (void));
130 int plugin_register_read (const char *name,
131 int (*callback) (void));
132 int plugin_register_write (const char *name,
133 int (*callback) (const data_set_t *ds, const value_list_t *vl));
134 int plugin_register_shutdown (char *name,
135 int (*callback) (void));
136 int plugin_register_data_set (const data_set_t *ds);
138 /*
139 * NAME
140 * plugin_dispatch_values
141 *
142 * DESCRIPTION
143 * This function is called by reading processes with the values they've
144 * aquired. The function fetches the data-set definition (that has been
145 * registered using `plugin_register_data_set') and calls _all_ registered
146 * write-functions.
147 *
148 * ARGUMENTS
149 * `name' Name/type of the data-set that describe the values in `vl'.
150 * `vl' Value list of the values that have been read by a `read'
151 * function.
152 */
153 int plugin_dispatch_values (const char *name, const value_list_t *vl);
155 /* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */
156 void plugin_complain (int level, complain_t *c, const char *format, ...);
157 void plugin_relief (int level, complain_t *c, const char *format, ...);
159 #endif /* PLUGIN_H */