src/plugin.h

   1 #ifndef PLUGIN_H
   2 #define PLUGIN_H
   3
   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  **/
  24
  25 #define DATA_MAX_NAME_LEN 64
  26
  27 #define DS_TYPE_COUNTER 0
  28 #define DS_TYPE_GAUGE   1
  29
  30 #ifndef LOG_ERR
  31 # define LOG_ERR 3
  32 #endif
  33 #ifndef LOG_WARNING
  34 # define LOG_WARNING 4
  35 #endif
  36 #ifndef LOG_NOTICE
  37 # define LOG_NOTICE 5
  38 #endif
  39 #ifndef LOG_INFO
  40 # define LOG_INFO 6
  41 #endif
  42 #ifndef LOG_DEBUG
  43 # define LOG_DEBUG 7
  44 #endif
  45
  46 /*
  47  * Public data types
  48  */
  49 typedef unsigned long long counter_t;
  50 typedef double gauge_t;
  51
  52 union value_u
  53 {
  54         counter_t counter;
  55         gauge_t   gauge;
  56 };
  57 typedef union value_u value_t;
  58
  59 struct value_list_s
  60 {
  61         value_t *values;
  62         int      values_len;
  63         time_t   time;
  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];
  68 };
  69 typedef struct value_list_s value_list_t;
  70
  71 #define VALUE_LIST_INIT { NULL, 0, 0, "localhost", "", "", "" }
  72
  73 struct data_source_s
  74 {
  75         char   name[DATA_MAX_NAME_LEN];
  76         int    type;
  77         double min;
  78         double max;
  79 };
  80 typedef struct data_source_s data_source_t;
  81
  82 struct data_set_s
  83 {
  84         char           type[DATA_MAX_NAME_LEN];
  85         int            ds_num;
  86         data_source_t *ds;
  87 };
  88 typedef struct data_set_s data_set_t;
  89
  90 typedef struct complain_s
  91 {
  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 */
  94 } complain_t;
  95
  96 /*
  97  * NAME
  98  *  plugin_set_dir
  99  *
 100  * DESCRIPTION
 101  *  Sets the current `plugindir'
 102  *
 103  * ARGUMENTS
 104  *  `dir'       Path to the plugin directory
 105  *
 106  * NOTES
 107  *  If `dir' is NULL the compiled in default `PLUGINDIR' is used.
 108  */
 109 void plugin_set_dir (const char *dir);
 110
 111 /*
 112  * NAME
 113  *  plugin_load
 114  *
 115  * DESCRIPTION
 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
 119  *  functions.
 120  *
 121  * ARGUMENTS
 122  *  `type'      Name of the plugin to load.
 123  *
 124  * RETURN VALUE
 125  *  Returns zero upon success, a value greater than zero if no plugin was found
 126  *  and a value below zero if an error occurs.
 127  *
 128  * NOTES
 129  *  No attempt is made to re-load an already loaded module.
 130  */
 131 int  plugin_load (const char *name);
 132
 133 void plugin_init_all (void);
 134 void plugin_read_all (const int *loop);
 135 void plugin_shutdown_all (void);
 136
 137 /*
 138  * The `plugin_register_*' functions are used to make `config', `init',
 139  * `read', `write' and `shutdown' functions known to the plugin
 140  * infrastructure. Also, the data-formats are made public like this.
 141  */
 142 int plugin_register_config (const char *name,
 143                 int (*callback) (const char *key, const char *val),
 144                 const char **keys, int keys_num);
 145 int plugin_register_init (const char *name,
 146                 int (*callback) (void));
 147 int plugin_register_read (const char *name,
 148                 int (*callback) (void));
 149 int plugin_register_write (const char *name,
 150                 int (*callback) (const data_set_t *ds, const value_list_t *vl));
 151 int plugin_register_shutdown (char *name,
 152                 int (*callback) (void));
 153 int plugin_register_data_set (const data_set_t *ds);
 154 int plugin_register_log (char *name,
 155                 void (*callback) (int, const char *));
 156
 157 int plugin_unregister_config (const char *name);
 158 int plugin_unregister_init (const char *name);
 159 int plugin_unregister_read (const char *name);
 160 int plugin_unregister_write (const char *name);
 161 int plugin_unregister_shutdown (const char *name);
 162 int plugin_unregister_data_set (const char *name);
 163 int plugin_unregister_log (const char *name);
 164
 165 /*
 166  * NAME
 167  *  plugin_dispatch_values
 168  *
 169  * DESCRIPTION
 170  *  This function is called by reading processes with the values they've
 171  *  aquired. The function fetches the data-set definition (that has been
 172  *  registered using `plugin_register_data_set') and calls _all_ registered
 173  *  write-functions.
 174  *
 175  * ARGUMENTS
 176  *  `name'      Name/type of the data-set that describe the values in `vl'.
 177  *  `vl'        Value list of the values that have been read by a `read'
 178  *              function.
 179  */
 180 int plugin_dispatch_values (const char *name, const value_list_t *vl);
 181
 182 void plugin_log (int level, const char *format, ...);
 183 #define ERROR(...)   plugin_log (LOG_ERR,     __VA_ARGS__)
 184 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
 185 #define NOTICE(...)  plugin_log (LOG_NOTICE,  __VA_ARGS__)
 186 #define INFO(...)    plugin_log (LOG_INFO,    __VA_ARGS__)
 187 #define DEBUG(...)   plugin_log (LOG_DEBUG,   __VA_ARGS__)
 188
 189 /* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */
 190 void plugin_complain (int level, complain_t *c, const char *format, ...);
 191 void plugin_relief (int level, complain_t *c, const char *format, ...);
 192
 193 const data_set_t *plugin_get_ds (const char *name);
 194
 195 #endif /* PLUGIN_H */