2 * /usr/share/doc/collectd/examples/myplugin.c
4 * A plugin template for collectd.
6 * Written by Sebastian Harl <sh@tokkee.org>
8 * This is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License as published by the Free
10 * Software Foundation; only version 2 of the License is applicable.
15 * - plugins are executed in parallel, thus, thread-safe
16 * functions need to be used
17 * - each of the functions below (except module_register)
27 #ifndef __USE_ISOC99 /* required for NAN */
28 # define DISABLE_ISOC99 1
29 # define __USE_ISOC99 1
30 #endif /* !defined(__USE_ISOC99) */
33 # undef DISABLE_ISOC99
35 #endif /* DISABLE_ISOC99 */
39 #endif /* ! HAVE_CONFIG */
41 #include <collectd/collectd.h>
43 #include <collectd/common.h>
44 #include <collectd/plugin.h>
47 * data source definition:
48 * - name of the data source
49 * - type of the data source (DS_TYPE_GAUGE, DS_TYPE_COUNTER)
50 * - minimum allowed value
51 * - maximum allowed value
53 static data_source_t dsrc[1] =
55 { "my_ds", DS_TYPE_GAUGE, 0, NAN }
59 * data set definition:
60 * - name of the data set
61 * - number of data sources
62 * - list of data sources
64 * NOTE: If you're defining a custom data-set, you have to make that known to
65 * any servers as well. Else, the server is not able to store values using the
66 * type defined by that data-set.
67 * It is strongly recommended to use one of the types and data-sets
68 * pre-defined in the types.db file.
70 static data_set_t ds =
72 "myplugin", STATIC_ARRAY_SIZE (dsrc), dsrc
76 * This function is called once upon startup to initialize the plugin.
78 static int my_init (void)
80 /* open sockets, initialize data structures, ... */
82 /* A return value != 0 indicates an error and causes the plugin to be
85 } /* static int my_init (void) */
88 * This function is called in regular intervalls to collect the data.
90 static int my_read (void)
92 value_t values[1]; /* the size of this list should equal the number of
94 value_list_t vl = VALUE_LIST_INIT;
96 /* do the magic to read the data */
97 values[0].gauge = random ();
101 vl.time = time (NULL);
102 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
103 sstrncpy (vl.plugin, "myplugin", sizeof (vl.plugin));
105 /* it is strongly recommended to use a type defined in the types.db file
106 * instead of a custom type */
107 sstrncpy (vl.type, "myplugin", sizeof (vl.type));
108 /* optionally set vl.plugin_instance and vl.type_instance to reasonable
109 * values (default: "") */
111 /* dispatch the values to collectd which passes them on to all registered
113 plugin_dispatch_values (&vl);
115 /* A return value != 0 indicates an error and the plugin will be skipped
116 * for an increasing amount of time. */
118 } /* static int my_read (void) */
121 * This function is called after values have been dispatched to collectd.
123 static int my_write (const data_set_t *ds, const value_list_t *vl,
126 char name[1024] = "";
129 if (ds->ds_num != vl->values_len) {
130 plugin_log (LOG_WARNING, "DS number does not match values length");
134 /* get the default base filename for the output file - depending on the
135 * provided values this will be something like
136 * <host>/<plugin>[-<plugin_type>]/<instance>[-<instance_type>] */
137 if (0 != format_name (name, 1024, vl->host, vl->plugin,
138 vl->plugin_instance, ds->type, vl->type_instance))
141 for (i = 0; i < ds->ds_num; ++i) {
142 /* do the magic to output the data */
143 printf ("%s (%s) at %i: ", name,
144 (ds->ds->type == DS_TYPE_GAUGE) ? "GAUGE" : "COUNTER",
147 if (ds->ds->type == DS_TYPE_GAUGE)
148 printf ("%f\n", vl->values[i].gauge);
150 printf ("%lld\n", vl->values[i].counter);
153 } /* static int my_write (data_set_t *, value_list_t *) */
156 * This function is called when plugin_log () has been used.
158 static void my_log (int severity, const char *msg, user_data_t *ud)
160 printf ("LOG: %i - %s\n", severity, msg);
162 } /* static void my_log (int, const char *) */
165 * This function is called when plugin_dispatch_notification () has been used.
167 static int my_notify (const notification_t *notif, user_data_t *ud)
169 char time_str[32] = "";
170 struct tm *tm = NULL;
174 if (NULL == (tm = localtime (¬if->time)))
177 n = strftime (time_str, 32, "%F %T", tm);
181 printf ("NOTIF (%s): %i - ", time_str, notif->severity);
183 if ('\0' != *notif->host)
184 printf ("%s: ", notif->host);
186 if ('\0' != *notif->plugin)
187 printf ("%s: ", notif->plugin);
189 if ('\0' != *notif->plugin_instance)
190 printf ("%s: ", notif->plugin_instance);
192 if ('\0' != *notif->type)
193 printf ("%s: ", notif->type);
195 if ('\0' != *notif->type_instance)
196 printf ("%s: ", notif->type_instance);
198 printf ("%s\n", notif->message);
200 } /* static int my_notify (notification_t *) */
203 * This function is called before shutting down collectd.
205 static int my_shutdown (void)
207 /* close sockets, free data structures, ... */
209 } /* static int my_shutdown (void) */
212 * This function is called after loading the plugin to register it with
215 void module_register (void)
217 plugin_register_log ("myplugin", my_log, /* user data */ NULL);
218 plugin_register_notification ("myplugin", my_notify,
219 /* user data */ NULL);
220 plugin_register_data_set (&ds);
221 plugin_register_read ("myplugin", my_read);
222 plugin_register_init ("myplugin", my_init);
223 plugin_register_write ("myplugin", my_write, /* user data */ NULL);
224 plugin_register_shutdown ("myplugin", my_shutdown);
226 } /* void module_register (void) */