src/plugin.h

   1 #ifndef PLUGIN_H
   2 #define PLUGIN_H
   3
   4 /**
   5  * collectd - src/plugin.h
   6  * Copyright (C) 2005,2006  Florian octo Forster
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2 of the License, or (at your
  11  * option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  21  *
  22  * Authors:
  23  *   Florian octo Forster <octo at verplant.org>
  24  **/
  25
  26 #define DATA_MAX_NAME_LEN 64
  27
  28 #define DS_TYPE_COUNTER 0
  29 #define DS_TYPE_GAUGE   1
  30
  31 /*
  32  * Public data types
  33  */
  34 typedef unsigned long long counter_t;
  35 typedef double gauge_t;
  36
  37 union value_u
  38 {
  39         counter_t counter;
  40         gauge_t   gauge;
  41 };
  42 typedef union value_u value_t;
  43
  44 struct value_list_s
  45 {
  46         value_t *values;
  47         int      values_len;
  48         char     host[DATA_MAX_NAME_LEN];
  49         char     plugin[DATA_MAX_NAME_LEN];
  50         char     plugin_instance[DATA_MAX_NAME_LEN];
  51         char     type_instance[DATA_MAX_NAME_LEN];
  52 };
  53 typedef struct value_list_s value_list_t;
  54
  55 struct data_source_s
  56 {
  57         char   name[DATA_MAX_NAME_LEN];
  58         int    type;
  59         double min;
  60         double max;
  61 };
  62 typedef struct data_source_s data_source_t;
  63
  64 struct data_set_s
  65 {
  66         char           type[DATA_MAX_NAME_LEN];
  67         int            ds_num;
  68         data_source_t *ds;
  69 };
  70 typedef struct data_set_s data_set_t;
  71
  72 typedef struct complain_s
  73 {
  74         unsigned int interval; /* how long we wait for reporting this error again */
  75         unsigned int delay;    /* how many more iterations we still need to wait */
  76 } complain_t;
  77
  78 /*
  79  * NAME
  80  *  plugin_set_dir
  81  *
  82  * DESCRIPTION
  83  *  Sets the current `plugindir'
  84  *
  85  * ARGUMENTS
  86  *  `dir'       Path to the plugin directory
  87  *
  88  * NOTES
  89  *  If `dir' is NULL the compiled in default `PLUGINDIR' is used.
  90  */
  91 void plugin_set_dir (const char *dir);
  92
  93 /*
  94  * NAME
  95  *  plugin_load
  96  *
  97  * DESCRIPTION
  98  *  Searches the current `plugindir' (see `plugin_set_dir') for the plugin
  99  *  named $type and loads it. Afterwards the plugin's `module_register'
 100  *  function is called, which then calls `plugin_register' to register callback
 101  *  functions.
 102  *
 103  * ARGUMENTS
 104  *  `type'      Name of the plugin to load.
 105  *
 106  * RETURN VALUE
 107  *  Returns zero upon success, a value greater than zero if no plugin was found
 108  *  and a value below zero if an error occurs.
 109  *
 110  * NOTES
 111  *  No attempt is made to re-load an already loaded module.
 112  */
 113 int  plugin_load (const char *name);
 114
 115 void plugin_init_all (void);
 116 void plugin_read_all (const int *loop);
 117 void plugin_shutdown_all (void);
 118
 119 /*
 120  * The `plugin_register_*' functions are used to make `config', `init',
 121  * `read', `write' and `shutdown' functions known to the plugin
 122  * infrastructure. Also, the data-formats are made public like this.
 123  */
 124 int plugin_register_config (const char *name,
 125                 int (*callback) (const char *key, const char *val),
 126                 const char **keys, int keys_num);
 127 int plugin_register_init (const char *name,
 128                 int (*callback) (void));
 129 int plugin_register_read (const char *name,
 130                 int (*callback) (void));
 131 int plugin_register_write (const char *name,
 132                 int (*callback) (const data_set_t *ds, const value_list_t *vl));
 133 int plugin_register_shutdown (char *name,
 134                 int (*callback) (void));
 135 int plugin_register_data_set (const data_set_t *ds);
 136
 137 /*
 138  * NAME
 139  *  plugin_dispatch_values
 140  *
 141  * DESCRIPTION
 142  *  This function is called by reading processes with the values they've
 143  *  aquired. The function fetches the data-set definition (that has been
 144  *  registered using `plugin_register_data_set') and calls _all_ registered
 145  *  write-functions.
 146  *
 147  * ARGUMENTS
 148  *  `name'      Name/type of the data-set that describe the values in `vl'.
 149  *  `vl'        Value list of the values that have been read by a `read'
 150  *              function.
 151  */
 152 int plugin_dispatch_values (const char *name, const value_list_t *vl);
 153
 154 /* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */
 155 void plugin_complain (int level, complain_t *c, const char *format, ...);
 156 void plugin_relief (int level, complain_t *c, const char *format, ...);
 157
 158 #endif /* PLUGIN_H */