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 enum modreg
  50 {
  51         MR_EVERYTHING = 7,
  52         MR_DATASETS   = 1,
  53         MR_READ       = 2,
  54         MR_WRITE      = 4
  55 };
  56 typedef enum modreg modreg_e;
  57
  58 typedef unsigned long long counter_t;
  59 typedef double gauge_t;
  60
  61 union value_u
  62 {
  63         counter_t counter;
  64         gauge_t   gauge;
  65 };
  66 typedef union value_u value_t;
  67
  68 struct value_list_s
  69 {
  70         value_t *values;
  71         int      values_len;
  72         time_t   time;
  73         char     host[DATA_MAX_NAME_LEN];
  74         char     plugin[DATA_MAX_NAME_LEN];
  75         char     plugin_instance[DATA_MAX_NAME_LEN];
  76         char     type_instance[DATA_MAX_NAME_LEN];
  77 };
  78 typedef struct value_list_s value_list_t;
  79
  80 #define VALUE_LIST_INIT { NULL, 0, 0, "localhost", "", "", "" }
  81
  82 struct data_source_s
  83 {
  84         char   name[DATA_MAX_NAME_LEN];
  85         int    type;
  86         double min;
  87         double max;
  88 };
  89 typedef struct data_source_s data_source_t;
  90
  91 struct data_set_s
  92 {
  93         char           type[DATA_MAX_NAME_LEN];
  94         int            ds_num;
  95         data_source_t *ds;
  96 };
  97 typedef struct data_set_s data_set_t;
  98
  99 typedef struct complain_s
 100 {
 101         unsigned int interval; /* how long we wait for reporting this error again */
 102         unsigned int delay;    /* how many more iterations we still need to wait */
 103 } complain_t;
 104
 105 /*
 106  * NAME
 107  *  plugin_set_dir
 108  *
 109  * DESCRIPTION
 110  *  Sets the current `plugindir'
 111  *
 112  * ARGUMENTS
 113  *  `dir'       Path to the plugin directory
 114  *
 115  * NOTES
 116  *  If `dir' is NULL the compiled in default `PLUGINDIR' is used.
 117  */
 118 void plugin_set_dir (const char *dir);
 119
 120 /*
 121  * NAME
 122  *  plugin_load
 123  *
 124  * DESCRIPTION
 125  *  Searches the current `plugindir' (see `plugin_set_dir') for the plugin
 126  *  named $type and loads it. Afterwards the plugin's `module_register'
 127  *  function is called, which then calls `plugin_register' to register callback
 128  *  functions.
 129  *
 130  * ARGUMENTS
 131  *  `name'      Name of the plugin to load.
 132  *  `mr'        Types of functions to request from the plugin.
 133  *
 134  * RETURN VALUE
 135  *  Returns zero upon success, a value greater than zero if no plugin was found
 136  *  and a value below zero if an error occurs.
 137  *
 138  * NOTES
 139  *  No attempt is made to re-load an already loaded module.
 140  */
 141 int plugin_load (const char *name, modreg_e mr);
 142
 143 void plugin_init_all (void);
 144 void plugin_read_all (const int *loop);
 145 void plugin_shutdown_all (void);
 146
 147 /*
 148  * The `plugin_register_*' functions are used to make `config', `init',
 149  * `read', `write' and `shutdown' functions known to the plugin
 150  * infrastructure. Also, the data-formats are made public like this.
 151  */
 152 int plugin_register_config (const char *name,
 153                 int (*callback) (const char *key, const char *val),
 154                 const char **keys, int keys_num);
 155 int plugin_register_init (const char *name,
 156                 int (*callback) (void));
 157 int plugin_register_read (const char *name,
 158                 int (*callback) (void));
 159 int plugin_register_write (const char *name,
 160                 int (*callback) (const data_set_t *ds, const value_list_t *vl));
 161 int plugin_register_shutdown (char *name,
 162                 int (*callback) (void));
 163 int plugin_register_data_set (const data_set_t *ds);
 164 int plugin_register_log (char *name,
 165                 void (*callback) (int, const char *));
 166
 167 int plugin_unregister_config (const char *name);
 168 int plugin_unregister_init (const char *name);
 169 int plugin_unregister_read (const char *name);
 170 int plugin_unregister_write (const char *name);
 171 int plugin_unregister_shutdown (const char *name);
 172 int plugin_unregister_data_set (const char *name);
 173 int plugin_unregister_log (const char *name);
 174
 175 /*
 176  * NAME
 177  *  plugin_dispatch_values
 178  *
 179  * DESCRIPTION
 180  *  This function is called by reading processes with the values they've
 181  *  aquired. The function fetches the data-set definition (that has been
 182  *  registered using `plugin_register_data_set') and calls _all_ registered
 183  *  write-functions.
 184  *
 185  * ARGUMENTS
 186  *  `name'      Name/type of the data-set that describe the values in `vl'.
 187  *  `vl'        Value list of the values that have been read by a `read'
 188  *              function.
 189  */
 190 int plugin_dispatch_values (const char *name, const value_list_t *vl);
 191
 192 void plugin_log (int level, const char *format, ...);
 193 #define ERROR(...)   plugin_log (LOG_ERR,     __VA_ARGS__)
 194 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
 195 #define NOTICE(...)  plugin_log (LOG_NOTICE,  __VA_ARGS__)
 196 #define INFO(...)    plugin_log (LOG_INFO,    __VA_ARGS__)
 197 #define DEBUG(...)   plugin_log (LOG_DEBUG,   __VA_ARGS__)
 198
 199 /* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */
 200 void plugin_complain (int level, complain_t *c, const char *format, ...);
 201 void plugin_relief (int level, complain_t *c, const char *format, ...);
 202
 203 const data_set_t *plugin_get_ds (const char *name);
 204
 205 #endif /* PLUGIN_H */