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