src/plugin.h

   1 #ifndef PLUGIN_H
   2 #define PLUGIN_H
   3 /**
   4  * collectd - src/plugin.h
   5  * Copyright (C) 2005-2010  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 collectd.org>
  22  *   Sebastian Harl <sh at tokkee.org>
  23  **/
  24
  25 #include "collectd.h"
  26 #include "configfile.h"
  27 #include "meta_data.h"
  28 #include "utils_time.h"
  29
  30 #define PLUGIN_FLAGS_GLOBAL 0x0001
  31
  32 #define DATA_MAX_NAME_LEN 64
  33
  34 #define DS_TYPE_COUNTER  0
  35 #define DS_TYPE_GAUGE    1
  36 #define DS_TYPE_DERIVE   2
  37 #define DS_TYPE_ABSOLUTE 3
  38
  39 #define DS_TYPE_TO_STRING(t) (t == DS_TYPE_COUNTER)     ? "counter"  : \
  40                                 (t == DS_TYPE_GAUGE)    ? "gauge"    : \
  41                                 (t == DS_TYPE_DERIVE)   ? "derive"   : \
  42                                 (t == DS_TYPE_ABSOLUTE) ? "absolute" : \
  43                                 "unknown"
  44
  45
  46 #ifndef LOG_ERR
  47 # define LOG_ERR 3
  48 #endif
  49 #ifndef LOG_WARNING
  50 # define LOG_WARNING 4
  51 #endif
  52 #ifndef LOG_NOTICE
  53 # define LOG_NOTICE 5
  54 #endif
  55 #ifndef LOG_INFO
  56 # define LOG_INFO 6
  57 #endif
  58 #ifndef LOG_DEBUG
  59 # define LOG_DEBUG 7
  60 #endif
  61
  62 #define NOTIF_MAX_MSG_LEN 256
  63
  64 #define NOTIF_FAILURE 1
  65 #define NOTIF_WARNING 2
  66 #define NOTIF_OKAY    4
  67
  68 /*
  69  * Public data types
  70  */
  71 struct plugin_loaddata_s
  72 {
  73         cdtime_t interval;
  74 };
  75 typedef struct plugin_loaddata_s plugin_loaddata_t;
  76 static cdtime_t __attribute__((unused)) plugin_interval = 0;
  77
  78 typedef unsigned long long counter_t;
  79 typedef double gauge_t;
  80 typedef int64_t derive_t;
  81 typedef uint64_t absolute_t;
  82
  83 union value_u
  84 {
  85         counter_t  counter;
  86         gauge_t    gauge;
  87         derive_t   derive;
  88         absolute_t absolute;
  89 };
  90 typedef union value_u value_t;
  91
  92 struct value_list_s
  93 {
  94         value_t *values;
  95         int      values_len;
  96         cdtime_t time;
  97         cdtime_t interval;
  98         char     host[DATA_MAX_NAME_LEN];
  99         char     plugin[DATA_MAX_NAME_LEN];
 100         char     plugin_instance[DATA_MAX_NAME_LEN];
 101         char     type[DATA_MAX_NAME_LEN];
 102         char     type_instance[DATA_MAX_NAME_LEN];
 103         meta_data_t *meta;
 104 };
 105 typedef struct value_list_s value_list_t;
 106
 107 #define VALUE_LIST_INIT(interval) { NULL, 0, 0, (interval), "localhost", "", "", "", "", NULL }
 108 #define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "", NULL }
 109
 110 struct data_source_s
 111 {
 112         char   name[DATA_MAX_NAME_LEN];
 113         int    type;
 114         double min;
 115         double max;
 116 };
 117 typedef struct data_source_s data_source_t;
 118
 119 struct data_set_s
 120 {
 121         char           type[DATA_MAX_NAME_LEN];
 122         int            ds_num;
 123         data_source_t *ds;
 124 };
 125 typedef struct data_set_s data_set_t;
 126
 127 enum notification_meta_type_e
 128 {
 129         NM_TYPE_STRING,
 130         NM_TYPE_SIGNED_INT,
 131         NM_TYPE_UNSIGNED_INT,
 132         NM_TYPE_DOUBLE,
 133         NM_TYPE_BOOLEAN
 134 };
 135
 136 typedef struct notification_meta_s
 137 {
 138         char name[DATA_MAX_NAME_LEN];
 139         enum notification_meta_type_e type;
 140         union
 141         {
 142                 const char *nm_string;
 143                 int64_t nm_signed_int;
 144                 uint64_t nm_unsigned_int;
 145                 double nm_double;
 146                 _Bool nm_boolean;
 147         } nm_value;
 148         struct notification_meta_s *next;
 149 } notification_meta_t;
 150
 151 typedef struct notification_s
 152 {
 153         int    severity;
 154         cdtime_t time;
 155         char   message[NOTIF_MAX_MSG_LEN];
 156         char   host[DATA_MAX_NAME_LEN];
 157         char   plugin[DATA_MAX_NAME_LEN];
 158         char   plugin_instance[DATA_MAX_NAME_LEN];
 159         char   type[DATA_MAX_NAME_LEN];
 160         char   type_instance[DATA_MAX_NAME_LEN];
 161         notification_meta_t *meta;
 162 } notification_t;
 163
 164 struct user_data_s
 165 {
 166         void *data;
 167         void (*free_func) (void *);
 168 };
 169 typedef struct user_data_s user_data_t;
 170
 171 /*
 172  * Callback types
 173  */
 174 typedef int (*plugin_init_cb) (void);
 175 typedef int (*plugin_read_cb) (user_data_t *);
 176 typedef int (*plugin_write_cb) (const data_set_t *, const value_list_t *,
 177                 user_data_t *);
 178 typedef int (*plugin_flush_cb) (cdtime_t timeout, const char *identifier,
 179                 user_data_t *);
 180 /* "missing" callback. Returns less than zero on failure, zero if other
 181  * callbacks should be called, greater than zero if no more callbacks should be
 182  * called. */
 183 typedef int (*plugin_missing_cb) (const value_list_t *, user_data_t *);
 184 typedef void (*plugin_log_cb) (int severity, const char *message,
 185                 user_data_t *);
 186 typedef int (*plugin_shutdown_cb) (void);
 187 typedef int (*plugin_notification_cb) (const notification_t *,
 188                 user_data_t *);
 189
 190 /*
 191  * NAME
 192  *  plugin_set_dir
 193  *
 194  * DESCRIPTION
 195  *  Sets the current `plugindir'
 196  *
 197  * ARGUMENTS
 198  *  `dir'       Path to the plugin directory
 199  *
 200  * NOTES
 201  *  If `dir' is NULL the compiled in default `PLUGINDIR' is used.
 202  */
 203 void plugin_set_dir (const char *dir);
 204
 205 /*
 206  * NAME
 207  *  plugin_load
 208  *
 209  * DESCRIPTION
 210  *  Searches the current `plugindir' (see `plugin_set_dir') for the plugin
 211  *  named $type and loads it. Afterwards the plugin's `module_register'
 212  *  function is called, which then calls `plugin_register' to register callback
 213  *  functions.
 214  *
 215  * ARGUMENTS
 216  *  `name'      Name of the plugin to load.
 217  *  `flags'     Hints on how to handle this plugin.
 218  *  `data'      Additional arguments to pass to the plugin.
 219  *
 220  * RETURN VALUE
 221  *  Returns zero upon success, a value greater than zero if no plugin was found
 222  *  and a value below zero if an error occurs.
 223  *
 224  * NOTES
 225  *  No attempt is made to re-load an already loaded module.
 226  */
 227 int plugin_load (const char *name, uint32_t flags, plugin_loaddata_t *data);
 228
 229 /*
 230  * NAME
 231  *  PLUGIN_INIT_INTERVAL
 232  *
 233  * DESCRIPTION
 234  *  Initialize the plugin specific interval settings.
 235  *
 236  * ARGUMENTS
 237  *  `data'      Data provided by LoadPlugin, like custom interval settings.
 238  */
 239 #define PLUGIN_INIT_INTERVAL(data) \
 240         do { \
 241                 if ((data)->interval != 0) \
 242                         plugin_interval = (data)->interval; \
 243         } while (0)
 244
 245 void plugin_init_all (void);
 246 void plugin_read_all (void);
 247 int plugin_read_all_once (void);
 248 void plugin_shutdown_all (void);
 249
 250 /*
 251  * NAME
 252  *  plugin_write
 253  *
 254  * DESCRIPTION
 255  *  Calls the write function of the given plugin with the provided data set and
 256  *  value list. It differs from `plugin_dispatch_value' in that it does not
 257  *  update the cache, does not do threshold checking, call the chain subsystem
 258  *  and so on. It looks up the requested plugin and invokes the function, end
 259  *  of story.
 260  *
 261  * ARGUMENTS
 262  *  plugin     Name of the plugin. If NULL, the value is sent to all registered
 263  *             write functions.
 264  *  ds         Pointer to the data_set_t structure. If NULL, the data set is
 265  *             looked up according to the `type' member in the `vl' argument.
 266  *  vl         The actual value to be processed. Must not be NULL.
 267  *
 268  * RETURN VALUE
 269  *  Returns zero upon success or non-zero if an error occurred. If `plugin' is
 270  *  NULL and more than one plugin is called, an error is only returned if *all*
 271  *  plugins fail.
 272  *
 273  * NOTES
 274  *  This is the function used by the `write' built-in target. May be used by
 275  *  other target plugins.
 276  */
 277 int plugin_write (const char *plugin,
 278     const data_set_t *ds, const value_list_t *vl);
 279
 280 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier);
 281
 282 /*
 283  * The `plugin_register_*' functions are used to make `config', `init',
 284  * `read', `write' and `shutdown' functions known to the plugin
 285  * infrastructure. Also, the data-formats are made public like this.
 286  */
 287 int plugin_register_config (const char *name,
 288                 int (*callback) (const char *key, const char *val),
 289                 const char **keys, int keys_num);
 290 int plugin_register_complex_config (const char *type,
 291                 int (*callback) (oconfig_item_t *));
 292 int plugin_register_init (const char *name,
 293                 plugin_init_cb callback);
 294 int plugin_register_read (const char *name,
 295                 int (*callback) (void), cdtime_t interval);
 296 /* "user_data" will be freed automatically, unless
 297  * "plugin_register_complex_read" returns an error (non-zero). */
 298 int plugin_register_complex_read (const char *group, const char *name,
 299                 plugin_read_cb callback,
 300                 const struct timespec *interval,
 301                 user_data_t *user_data);
 302 int plugin_register_write (const char *name,
 303                 plugin_write_cb callback, user_data_t *user_data);
 304 int plugin_register_flush (const char *name,
 305                 plugin_flush_cb callback, user_data_t *user_data);
 306 int plugin_register_missing (const char *name,
 307                 plugin_missing_cb callback, user_data_t *user_data);
 308 int plugin_register_shutdown (const char *name,
 309                 plugin_shutdown_cb callback);
 310 int plugin_register_data_set (const data_set_t *ds);
 311 int plugin_register_log (const char *name,
 312                 plugin_log_cb callback, user_data_t *user_data);
 313 int plugin_register_notification (const char *name,
 314                 plugin_notification_cb callback, user_data_t *user_data);
 315
 316 int plugin_unregister_config (const char *name);
 317 int plugin_unregister_complex_config (const char *name);
 318 int plugin_unregister_init (const char *name);
 319 int plugin_unregister_read (const char *name);
 320 int plugin_unregister_read_group (const char *group);
 321 int plugin_unregister_write (const char *name);
 322 int plugin_unregister_flush (const char *name);
 323 int plugin_unregister_missing (const char *name);
 324 int plugin_unregister_shutdown (const char *name);
 325 int plugin_unregister_data_set (const char *name);
 326 int plugin_unregister_log (const char *name);
 327 int plugin_unregister_notification (const char *name);
 328
 329
 330 /*
 331  * NAME
 332  *  plugin_dispatch_values
 333  *
 334  * DESCRIPTION
 335  *  This function is called by reading processes with the values they've
 336  *  aquired. The function fetches the data-set definition (that has been
 337  *  registered using `plugin_register_data_set') and calls _all_ registered
 338  *  write-functions.
 339  *
 340  * ARGUMENTS
 341  *  `vl'        Value list of the values that have been read by a `read'
 342  *              function.
 343  */
 344 int plugin_dispatch_values (value_list_t *vl);
 345 int plugin_dispatch_missing (const value_list_t *vl);
 346
 347 int plugin_dispatch_notification (const notification_t *notif);
 348
 349 void plugin_log (int level, const char *format, ...)
 350         __attribute__ ((format(printf,2,3)));
 351
 352 #define ERROR(...)   plugin_log (LOG_ERR,     __VA_ARGS__)
 353 #define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__)
 354 #define NOTICE(...)  plugin_log (LOG_NOTICE,  __VA_ARGS__)
 355 #define INFO(...)    plugin_log (LOG_INFO,    __VA_ARGS__)
 356 #if COLLECT_DEBUG
 357 # define DEBUG(...)  plugin_log (LOG_DEBUG,   __VA_ARGS__)
 358 #else /* COLLECT_DEBUG */
 359 # define DEBUG(...)  /* noop */
 360 #endif /* ! COLLECT_DEBUG */
 361
 362 const data_set_t *plugin_get_ds (const char *name);
 363
 364 int plugin_notification_meta_add_string (notification_t *n,
 365     const char *name,
 366     const char *value);
 367 int plugin_notification_meta_add_signed_int (notification_t *n,
 368     const char *name,
 369     int64_t value);
 370 int plugin_notification_meta_add_unsigned_int (notification_t *n,
 371     const char *name,
 372     uint64_t value);
 373 int plugin_notification_meta_add_double (notification_t *n,
 374     const char *name,
 375     double value);
 376 int plugin_notification_meta_add_boolean (notification_t *n,
 377     const char *name,
 378     _Bool value);
 379
 380 int plugin_notification_meta_copy (notification_t *dst,
 381     const notification_t *src);
 382
 383 int plugin_notification_meta_free (notification_meta_t *n);
 384
 385 #endif /* PLUGIN_H */