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