src/plugin.h

   1 #ifndef PLUGIN_H
   2 #define PLUGIN_H
   3 /**
   4  * collectd - src/plugin.h
   5  * Copyright (C) 2005-2008  Florian octo Forster
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; only version 2 of the License is applicable.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  *
  20  * Authors:
  21  *   Florian octo Forster <octo at verplant.org>
  22  *   Sebastian Harl <sh at tokkee.org>
  23  **/
  24
  25 #include "collectd.h"
  26 #include "configfile.h"
  27 #include "meta_data.h"
  28
  29 #define DATA_MAX_NAME_LEN 64
  30
  31 #define DS_TYPE_COUNTER 0
  32 #define DS_TYPE_GAUGE   1
  33
  34 #ifndef LOG_ERR
  35 # define LOG_ERR 3
  36 #endif
  37 #ifndef LOG_WARNING
  38 # define LOG_WARNING 4
  39 #endif
  40 #ifndef LOG_NOTICE
  41 # define LOG_NOTICE 5
  42 #endif
  43 #ifndef LOG_INFO
  44 # define LOG_INFO 6
  45 #endif
  46 #ifndef LOG_DEBUG
  47 # define LOG_DEBUG 7
  48 #endif
  49
  50 #define NOTIF_MAX_MSG_LEN 256
  51
  52 #define NOTIF_FAILURE 1
  53 #define NOTIF_WARNING 2
  54 #define NOTIF_OKAY    4
  55
  56 /*
  57  * Public data types
  58  */
  59 typedef unsigned long long counter_t;
  60 typedef double gauge_t;
  61
  62 union value_u
  63 {
  64         counter_t counter;
  65         gauge_t   gauge;
  66 };
  67 typedef union value_u value_t;
  68
  69 struct value_list_s
  70 {
  71         value_t *values;
  72         int      values_len;
  73         time_t   time;
  74         int      interval;
  75         char     host[DATA_MAX_NAME_LEN];
  76         char     plugin[DATA_MAX_NAME_LEN];
  77         char     plugin_instance[DATA_MAX_NAME_LEN];
  78         char     type[DATA_MAX_NAME_LEN];
  79         char     type_instance[DATA_MAX_NAME_LEN];
  80         meta_data_t *meta;
  81 };
  82 typedef struct value_list_s value_list_t;
  83
  84 #define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "", "", NULL }
  85 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "", NULL }
  86
  87 struct data_source_s
  88 {
  89         char   name[DATA_MAX_NAME_LEN];
  90         int    type;
  91         double min;
  92         double max;
  93 };
  94 typedef struct data_source_s data_source_t;
  95
  96 struct data_set_s
  97 {
  98         char           type[DATA_MAX_NAME_LEN];
  99         int            ds_num;
 100         data_source_t *ds;
 101 };
 102 typedef struct data_set_s data_set_t;
 103
 104 enum notification_meta_type_e
 105 {
 106         NM_TYPE_STRING,
 107         NM_TYPE_SIGNED_INT,
 108         NM_TYPE_UNSIGNED_INT,
 109         NM_TYPE_DOUBLE,
 110         NM_TYPE_BOOLEAN
 111 };
 112
 113 typedef struct notification_meta_s
 114 {
 115         char name[DATA_MAX_NAME_LEN];
 116         enum notification_meta_type_e type;
 117         union
 118         {
 119                 const char *nm_string;
 120                 int64_t nm_signed_int;
 121                 uint64_t nm_unsigned_int;
 122                 double nm_double;
 123                 bool nm_boolean;
 124         } nm_value;
 125         struct notification_meta_s *next;
 126 } notification_meta_t;
 127
 128 typedef struct notification_s
 129 {
 130         int    severity;
 131         time_t time;
 132         char   message[NOTIF_MAX_MSG_LEN];
 133         char   host[DATA_MAX_NAME_LEN];
 134         char   plugin[DATA_MAX_NAME_LEN];
 135         char   plugin_instance[DATA_MAX_NAME_LEN];
 136         char   type[DATA_MAX_NAME_LEN];
 137         char   type_instance[DATA_MAX_NAME_LEN];
 138         notification_meta_t *meta;
 139 } notification_t;
 140
 141 struct user_data_s
 142 {
 143         void *data;
 144         void (*free_func) (void *);
 145 };
 146 typedef struct user_data_s user_data_t;
 147
 148 /*
 149  * Callback types
 150  */
 151 typedef int (*plugin_init_cb) (void);
 152 typedef int (*plugin_read_cb) (user_data_t *);
 153 typedef int (*plugin_write_cb) (const data_set_t *, const value_list_t *,
 154                 user_data_t *);
 155 typedef int (*plugin_flush_cb) (int timeout, const char *identifier,
 156                 user_data_t *);
 157 typedef void (*plugin_log_cb) (int severity, const char *message,
 158                 user_data_t *);
 159 typedef int (*plugin_shutdown_cb) (void);
 160 typedef int (*plugin_notification_cb) (const notification_t *,
 161                 user_data_t *);
 162
 163 /*
 164  * NAME
 165  *  plugin_set_dir
 166  *
 167  * DESCRIPTION
 168  *  Sets the current `plugindir'
 169  *
 170  * ARGUMENTS
 171  *  `dir'       Path to the plugin directory
 172  *
 173  * NOTES
 174  *  If `dir' is NULL the compiled in default `PLUGINDIR' is used.
 175  */
 176 void plugin_set_dir (const char *dir);
 177
 178 /*
 179  * NAME
 180  *  plugin_load
 181  *
 182  * DESCRIPTION
 183  *  Searches the current `plugindir' (see `plugin_set_dir') for the plugin
 184  *  named $type and loads it. Afterwards the plugin's `module_register'
 185  *  function is called, which then calls `plugin_register' to register callback
 186  *  functions.
 187  *
 188  * ARGUMENTS
 189  *  `name'      Name of the plugin to load.
 190  *  `mr'        Types of functions to request from the plugin.
 191  *
 192  * RETURN VALUE
 193  *  Returns zero upon success, a value greater than zero if no plugin was found
 194  *  and a value below zero if an error occurs.
 195  *
 196  * NOTES
 197  *  No attempt is made to re-load an already loaded module.
 198  */
 199 int plugin_load (const char *name);
 200
 201 void plugin_init_all (void);
 202 void plugin_read_all (void);
 203 int plugin_read_all_once (void);
 204 void plugin_shutdown_all (void);
 205
 206 /*
 207  * NAME
 208  *  plugin_write
 209  *
 210  * DESCRIPTION
 211  *  Calls the write function of the given plugin with the provided data set and
 212  *  value list. It differs from `plugin_dispatch_value' in that it does not
 213  *  update the cache, does not do threshold checking, call the chain subsystem
 214  *  and so on. It looks up the requested plugin and invokes the function, end
 215  *  of story.
 216  *
 217  * ARGUMENTS
 218  *  plugin     Name of the plugin. If NULL, the value is sent to all registered
 219  *             write functions.
 220  *  ds         Pointer to the data_set_t structure. If NULL, the data set is
 221  *             looked up according to the `type' member in the `vl' argument.
 222  *  vl         The actual value to be processed. Must not be NULL.
 223  *
 224  * RETURN VALUE
 225  *  Returns zero upon success or non-zero if an error occurred. If `plugin' is
 226  *  NULL and more than one plugin is called, an error is only returned if *all*
 227  *  plugins fail.
 228  *
 229  * NOTES
 230  *  This is the function used by the `write' built-in target. May be used by
 231  *  other target plugins.
 232  */
 233 int plugin_write (const char *plugin,
 234     const data_set_t *ds, const value_list_t *vl);
 235
 236 int plugin_flush (const char *plugin, int timeout, const char *identifier);
 237
 238 /*
 239  * The `plugin_register_*' functions are used to make `config', `init',
 240  * `read', `write' and `shutdown' functions known to the plugin
 241  * infrastructure. Also, the data-formats are made public like this.
 242  */
 243 int plugin_register_config (const char *name,
 244                 int (*callback) (const char *key, const char *val),
 245                 const char **keys, int keys_num);
 246 int plugin_register_complex_config (const char *type,
 247                 int (*callback) (oconfig_item_t *));
 248 int plugin_register_init (const char *name,
 249                 plugin_init_cb callback);
 250 int plugin_register_read (const char *name,
 251                 int (*callback) (void));
 252 int plugin_register_complex_read (const char *name,
 253                 plugin_read_cb callback,
 254                 const struct timespec *interval,
 255                 user_data_t *user_data);
 256 int plugin_register_write (const char *name,
 257                 plugin_write_cb callback, user_data_t *user_data);
 258 int plugin_register_flush (const char *name,
 259                 plugin_flush_cb callback, user_data_t *user_data);
 260 int plugin_register_shutdown (char *name,
 261                 plugin_shutdown_cb callback);
 262 int plugin_register_data_set (const data_set_t *ds);
 263 int plugin_register_log (const char *name,
 264                 plugin_log_cb callback, user_data_t *user_data);
 265 int plugin_register_notification (const char *name,
 266                 plugin_notification_cb callback, user_data_t *user_data);
 267
 268 int plugin_unregister_config (const char *name);
 269 int plugin_unregister_complex_config (const char *name);
 270 int plugin_unregister_init (const char *name);
 271 int plugin_unregister_read (const char *name);
 272 int plugin_unregister_complex_read (const char *name, void **user_data);
 273 int plugin_unregister_write (const char *name);
 274 int plugin_unregister_flush (const char *name);
 275 int plugin_unregister_shutdown (const char *name);
 276 int plugin_unregister_data_set (const char *name);
 277 int plugin_unregister_log (const char *name);
 278 int plugin_unregister_notification (const char *name);
 279
 280
 281 /*
 282  * NAME
 283  *  plugin_dispatch_values
 284  *
 285  * DESCRIPTION
 286  *  This function is called by reading processes with the values they've
 287  *  aquired. The function fetches the data-set definition (that has been
 288  *  registered using `plugin_register_data_set') and calls _all_ registered
 289  *  write-functions.
 290  *
 291  * ARGUMENTS
 292  *  `vl'        Value list of the values that have been read by a `read'
 293  *              function.
 294  */
 295 int plugin_dispatch_values (value_list_t *vl);
 296
 297 int plugin_dispatch_notification (const notification_t *notif);
 298
 299 void plugin_log (int level, const char *format, ...)
 300         __attribute__ ((format(printf,2,3)));
 301
 302 #define ERROR(...)   plugin_log (LOG_ERR,     __VA_ARGS__)
 303 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
 304 #define NOTICE(...)  plugin_log (LOG_NOTICE,  __VA_ARGS__)
 305 #define INFO(...)    plugin_log (LOG_INFO,    __VA_ARGS__)
 306 #if COLLECT_DEBUG
 307 # define DEBUG(...)  plugin_log (LOG_DEBUG,   __VA_ARGS__)
 308 #else /* COLLECT_DEBUG */
 309 # define DEBUG(...)  /* noop */
 310 #endif /* ! COLLECT_DEBUG */
 311
 312 const data_set_t *plugin_get_ds (const char *name);
 313
 314 int plugin_notification_meta_add_string (notification_t *n,
 315     const char *name,
 316     const char *value);
 317 int plugin_notification_meta_add_signed_int (notification_t *n,
 318     const char *name,
 319     int64_t value);
 320 int plugin_notification_meta_add_unsigned_int (notification_t *n,
 321     const char *name,
 322     uint64_t value);
 323 int plugin_notification_meta_add_double (notification_t *n,
 324     const char *name,
 325     double value);
 326 int plugin_notification_meta_add_boolean (notification_t *n,
 327     const char *name,
 328     bool value);
 329
 330 int plugin_notification_meta_copy (notification_t *dst,
 331     const notification_t *src);
 332
 333 int plugin_notification_meta_free (notification_meta_t *n);
 334
 335 #endif /* PLUGIN_H */