X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fplugin.h;h=83c21094eee789112d9eca42fceb7b4dca2dbedc;hb=7c1daa25ff1888a979e8bc53aba28b8cbd6c6e0a;hp=93bf0294c913d0e587e07b06a3b8085a2f46f507;hpb=ae8e8fdb8913818a33e9bf139c55fbe448c3a105;p=collectd.git diff --git a/src/plugin.h b/src/plugin.h index 93bf0294..ac389c6a 100644 --- a/src/plugin.h +++ b/src/plugin.h @@ -1,14 +1,12 @@ #ifndef PLUGIN_H #define PLUGIN_H - /** * collectd - src/plugin.h - * Copyright (C) 2005,2006 Florian octo Forster + * Copyright (C) 2005-2008 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 @@ -21,13 +19,39 @@ * * Authors: * Florian octo Forster + * Sebastian Harl **/ +#include "collectd.h" +#include "configfile.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 + +#define NOTIF_MAX_MSG_LEN 256 + +#define NOTIF_FAILURE 1 +#define NOTIF_WARNING 2 +#define NOTIF_OKAY 4 + /* * Public data types */ @@ -45,12 +69,19 @@ struct value_list_s { value_t *values; int values_len; + time_t time; + int interval; + char host[DATA_MAX_NAME_LEN]; char plugin[DATA_MAX_NAME_LEN]; char plugin_instance[DATA_MAX_NAME_LEN]; + char type[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, interval_g, "localhost", "", "", "", "" } +#define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "" } + struct data_source_s { char name[DATA_MAX_NAME_LEN]; @@ -65,15 +96,20 @@ struct data_set_s char type[DATA_MAX_NAME_LEN]; int ds_num; data_source_t *ds; - char *filename; }; typedef struct data_set_s data_set_t; -typedef struct complain_s +typedef struct notification_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; + int severity; + time_t time; + char message[NOTIF_MAX_MSG_LEN]; + char host[DATA_MAX_NAME_LEN]; + char plugin[DATA_MAX_NAME_LEN]; + char plugin_instance[DATA_MAX_NAME_LEN]; + char type[DATA_MAX_NAME_LEN]; + char type_instance[DATA_MAX_NAME_LEN]; +} notification_t; /* * NAME @@ -101,7 +137,8 @@ void plugin_set_dir (const char *dir); * 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 @@ -110,12 +147,16 @@ void plugin_set_dir (const char *dir); * NOTES * No attempt is made to re-load an already loaded module. */ -int plugin_load (const char *name); +int plugin_load (const char *name); void plugin_init_all (void); -void plugin_read_all (const int *loop); +void plugin_read_all (void); void plugin_shutdown_all (void); +void plugin_flush_all (int timeout); +int plugin_flush_one (int timeout, const char *name); +int plugin_flush (const char *plugin, int timeout, const char *identifier); + /* * The `plugin_register_*' functions are used to make `config', `init', * `read', `write' and `shutdown' functions known to the plugin @@ -124,15 +165,35 @@ void plugin_shutdown_all (void); int plugin_register_config (const char *name, int (*callback) (const char *key, const char *val), const char **keys, int keys_num); +int plugin_register_complex_config (const char *type, + int (*callback) (oconfig_item_t *)); 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_flush (const char *name, + int (*callback) (const int timeout, const char *identifier)); 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_register_notification (const char *name, + int (*callback) (const notification_t *notif)); + +int plugin_unregister_config (const char *name); +int plugin_unregister_complex_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_flush (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); +int plugin_unregister_notification (const char *name); + /* * NAME @@ -145,14 +206,24 @@ int plugin_register_data_set (const data_set_t *ds); * 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, const value_list_t *vl); - -/* 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, ...); +int plugin_dispatch_values (value_list_t *vl); + +int plugin_dispatch_notification (const notification_t *notif); + +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__) +#if COLLECT_DEBUG +# define DEBUG(...) plugin_log (LOG_DEBUG, __VA_ARGS__) +#else /* COLLECT_DEBUG */ +# define DEBUG(...) /* noop */ +#endif /* ! COLLECT_DEBUG */ + +const data_set_t *plugin_get_ds (const char *name); #endif /* PLUGIN_H */