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