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