X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fplugin.h;h=83c21094eee789112d9eca42fceb7b4dca2dbedc;hb=7e5df1a2c6611bd4ac9fb8ac4b78106f9139ae6e;hp=8749327ab8cc900b9c6030c4a64c5d213e922d7f;hpb=c1e47ad7b5e5e889fb86250f714b299e4bf8819f;p=collectd.git diff --git a/src/plugin.h b/src/plugin.h index 8749327a..83c21094 100644 --- a/src/plugin.h +++ b/src/plugin.h @@ -1,11 +1,13 @@ +#ifndef PLUGIN_H +#define PLUGIN_H + /** * collectd - src/plugin.h - * Copyright (C) 2005 Florian octo Forster + * Copyright (C) 2005,2006 Florian octo Forster * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the - * Free Software Foundation; either version 2 of the License, or (at your - * option) any later version. + * Free Software Foundation; only version 2 of the License is applicable. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of @@ -20,8 +22,76 @@ * Florian octo Forster **/ -#ifndef PLUGIN_H -#define PLUGIN_H +#define DATA_MAX_NAME_LEN 64 + +#define DS_TYPE_COUNTER 0 +#define DS_TYPE_GAUGE 1 + +#ifndef LOG_ERR +# define LOG_ERR 3 +#endif +#ifndef LOG_WARNING +# define LOG_WARNING 4 +#endif +#ifndef LOG_NOTICE +# define LOG_NOTICE 5 +#endif +#ifndef LOG_INFO +# define LOG_INFO 6 +#endif +#ifndef LOG_DEBUG +# define LOG_DEBUG 7 +#endif + +/* + * Public data types + */ +typedef unsigned long long counter_t; +typedef double gauge_t; + +union value_u +{ + counter_t counter; + gauge_t gauge; +}; +typedef union value_u value_t; + +struct value_list_s +{ + value_t *values; + int values_len; + time_t time; + char host[DATA_MAX_NAME_LEN]; + char plugin[DATA_MAX_NAME_LEN]; + char plugin_instance[DATA_MAX_NAME_LEN]; + char type_instance[DATA_MAX_NAME_LEN]; +}; +typedef struct value_list_s value_list_t; + +#define VALUE_LIST_INIT { NULL, 0, 0, "localhost", "", "", "" } + +struct data_source_s +{ + char name[DATA_MAX_NAME_LEN]; + int type; + double min; + double max; +}; +typedef struct data_source_s data_source_t; + +struct data_set_s +{ + char type[DATA_MAX_NAME_LEN]; + int ds_num; + data_source_t *ds; +}; +typedef struct data_set_s data_set_t; + +typedef struct complain_s +{ + unsigned int interval; /* how long we wait for reporting this error again */ + unsigned int delay; /* how many more iterations we still need to wait */ +} complain_t; /* * NAME @@ -36,35 +106,7 @@ * NOTES * If `dir' is NULL the compiled in default `PLUGINDIR' is used. */ -void plugin_set_dir (char *dir); - -/* - * NAME - * plugin_count - * - * DESCRIPTION - * trivial - * - * RETURN VALUE - * The number of currently loaded plugins - */ -int plugin_count (void); - -/* - * NAME - * plugin_exists - * - * DESCRIPTION - * trivial - * - * ARGUMENTS - * `type' Name of the plugin. - * - * RETURN VALUE - * Returns non-zero if a plugin with the name $type is found and zero - * otherwise. - */ -int plugin_exists (char *type); +void plugin_set_dir (const char *dir); /* * NAME @@ -77,7 +119,8 @@ int plugin_exists (char *type); * functions. * * ARGUMENTS - * `type' Name of the plugin to load. + * `name' Name of the plugin to load. + * `mr' Types of functions to request from the plugin. * * RETURN VALUE * Returns zero upon success, a value greater than zero if no plugin was found @@ -86,20 +129,68 @@ int plugin_exists (char *type); * NOTES * No attempt is made to re-load an already loaded module. */ -int plugin_load (const char *type); +int plugin_load (const char *name); -int plugin_load_all (char *dir); void plugin_init_all (void); -void plugin_read_all (void); +void plugin_read_all (const int *loop); +void plugin_shutdown_all (void); + +/* + * The `plugin_register_*' functions are used to make `config', `init', + * `read', `write' and `shutdown' functions known to the plugin + * infrastructure. Also, the data-formats are made public like this. + */ +int plugin_register_config (const char *name, + int (*callback) (const char *key, const char *val), + const char **keys, int keys_num); +int plugin_register_init (const char *name, + int (*callback) (void)); +int plugin_register_read (const char *name, + int (*callback) (void)); +int plugin_register_write (const char *name, + int (*callback) (const data_set_t *ds, const value_list_t *vl)); +int plugin_register_shutdown (char *name, + int (*callback) (void)); +int plugin_register_data_set (const data_set_t *ds); +int plugin_register_log (char *name, + void (*callback) (int, const char *)); + +int plugin_unregister_config (const char *name); +int plugin_unregister_init (const char *name); +int plugin_unregister_read (const char *name); +int plugin_unregister_write (const char *name); +int plugin_unregister_shutdown (const char *name); +int plugin_unregister_data_set (const char *name); +int plugin_unregister_log (const char *name); + +/* + * NAME + * plugin_dispatch_values + * + * DESCRIPTION + * This function is called by reading processes with the values they've + * aquired. The function fetches the data-set definition (that has been + * registered using `plugin_register_data_set') and calls _all_ registered + * write-functions. + * + * ARGUMENTS + * `name' Name/type of the data-set that describe the values in `vl'. + * `vl' Value list of the values that have been read by a `read' + * function. + */ +int plugin_dispatch_values (const char *name, value_list_t *vl); + +void plugin_log (int level, const char *format, ...); +#define ERROR(...) plugin_log (LOG_ERR, __VA_ARGS__) +#define WARNING(...) plugin_log (LOG_WARNING, __VA_ARGS__) +#define NOTICE(...) plugin_log (LOG_NOTICE, __VA_ARGS__) +#define INFO(...) plugin_log (LOG_INFO, __VA_ARGS__) +#define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__) -void plugin_register (char *type, - void (*init) (void), - void (*read) (void), - void (*write) (char *, char *, char *)); +/* TODO: Move plugin_{complain,relief} into `utils_complain.[ch]'. -octo */ +void plugin_complain (int level, complain_t *c, const char *format, ...); +void plugin_relief (int level, complain_t *c, const char *format, ...); -#ifdef HAVE_LIBRRD -void plugin_write (char *host, char *type, char *inst, char *val); -#endif /* HAVE_LIBRRD */ -void plugin_submit (char *type, char *inst, char *val); +const data_set_t *plugin_get_ds (const char *name); #endif /* PLUGIN_H */