1 /**
2 * collectd - src/memcachec.c
3 * Copyright (C) 2009 Doug MacEachern
4 * Copyright (C) 2006-2009 Florian octo Forster
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 *
19 * Authors:
20 * Doug MacEachern <Doug.MacEachern at hyperic.com>
21 * Florian octo Forster <octo at collectd.org>
22 **/
24 #include "collectd.h"
25 #include "common.h"
26 #include "plugin.h"
27 #include "configfile.h"
28 #include "utils_match.h"
30 #include <libmemcached/memcached.h>
32 /*
33 * Data types
34 */
35 struct web_match_s;
36 typedef struct web_match_s web_match_t;
37 struct web_match_s /* {{{ */
38 {
39 char *regex;
40 char *exclude_regex;
41 int dstype;
42 char *type;
43 char *instance;
45 cu_match_t *match;
47 web_match_t *next;
48 }; /* }}} */
50 struct web_page_s;
51 typedef struct web_page_s web_page_t;
52 struct web_page_s /* {{{ */
53 {
54 char *instance;
56 char *server;
57 char *key;
59 memcached_st *memc;
60 char *buffer;
62 web_match_t *matches;
64 web_page_t *next;
65 }; /* }}} */
67 /*
68 * Global variables;
69 */
70 static web_page_t *pages_g = NULL;
72 /*
73 * Private functions
74 */
75 static void cmc_web_match_free (web_match_t *wm) /* {{{ */
76 {
77 if (wm == NULL)
78 return;
80 sfree (wm->regex);
81 sfree (wm->type);
82 sfree (wm->instance);
83 match_destroy (wm->match);
84 cmc_web_match_free (wm->next);
85 sfree (wm);
86 } /* }}} void cmc_web_match_free */
88 static void cmc_web_page_free (web_page_t *wp) /* {{{ */
89 {
90 if (wp == NULL)
91 return;
93 if (wp->memc != NULL)
94 memcached_free(wp->memc);
95 wp->memc = NULL;
97 sfree (wp->instance);
98 sfree (wp->server);
99 sfree (wp->key);
100 sfree (wp->buffer);
102 cmc_web_match_free (wp->matches);
103 cmc_web_page_free (wp->next);
104 sfree (wp);
105 } /* }}} void cmc_web_page_free */
107 static int cmc_page_init_memc (web_page_t *wp) /* {{{ */
108 {
109 memcached_server_st *server;
111 wp->memc = memcached_create(NULL);
112 if (wp->memc == NULL)
113 {
114 ERROR ("memcachec plugin: memcached_create failed.");
115 return (-1);
116 }
118 server = memcached_servers_parse (wp->server);
119 memcached_server_push (wp->memc, server);
120 memcached_server_list_free (server);
122 return (0);
123 } /* }}} int cmc_page_init_memc */
125 static int cmc_config_add_string (const char *name, char **dest, /* {{{ */
126 oconfig_item_t *ci)
127 {
128 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
129 {
130 WARNING ("memcachec plugin: `%s' needs exactly one string argument.", name);
131 return (-1);
132 }
134 sfree (*dest);
135 *dest = strdup (ci->values[0].value.string);
136 if (*dest == NULL)
137 return (-1);
139 return (0);
140 } /* }}} int cmc_config_add_string */
142 static int cmc_config_add_match_dstype (int *dstype_ret, /* {{{ */
143 oconfig_item_t *ci)
144 {
145 int dstype;
147 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
148 {
149 WARNING ("memcachec plugin: `DSType' needs exactly one string argument.");
150 return (-1);
151 }
153 if (strncasecmp ("Gauge", ci->values[0].value.string,
154 strlen ("Gauge")) == 0)
155 {
156 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
157 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
158 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
159 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
160 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
161 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
162 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
163 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
164 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
165 else
166 dstype = 0;
167 }
168 else if (strncasecmp ("Counter", ci->values[0].value.string,
169 strlen ("Counter")) == 0)
170 {
171 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
172 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
173 dstype |= UTILS_MATCH_CF_COUNTER_SET;
174 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
175 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
176 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
177 dstype |= UTILS_MATCH_CF_COUNTER_INC;
178 else
179 dstype = 0;
180 }
181 else
182 {
183 dstype = 0;
184 }
186 if (dstype == 0)
187 {
188 WARNING ("memcachec plugin: `%s' is not a valid argument to `DSType'.",
189 ci->values[0].value.string);
190 return (-1);
191 }
193 *dstype_ret = dstype;
194 return (0);
195 } /* }}} int cmc_config_add_match_dstype */
197 static int cmc_config_add_match (web_page_t *page, /* {{{ */
198 oconfig_item_t *ci)
199 {
200 web_match_t *match;
201 int status;
202 int i;
204 if (ci->values_num != 0)
205 {
206 WARNING ("memcachec plugin: Ignoring arguments for the `Match' block.");
207 }
209 match = (web_match_t *) malloc (sizeof (*match));
210 if (match == NULL)
211 {
212 ERROR ("memcachec plugin: malloc failed.");
213 return (-1);
214 }
215 memset (match, 0, sizeof (*match));
217 status = 0;
218 for (i = 0; i < ci->children_num; i++)
219 {
220 oconfig_item_t *child = ci->children + i;
222 if (strcasecmp ("Regex", child->key) == 0)
223 status = cmc_config_add_string ("Regex", &match->regex, child);
224 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
225 status = cmc_config_add_string ("ExcludeRegex", &match->exclude_regex, child);
226 else if (strcasecmp ("DSType", child->key) == 0)
227 status = cmc_config_add_match_dstype (&match->dstype, child);
228 else if (strcasecmp ("Type", child->key) == 0)
229 status = cmc_config_add_string ("Type", &match->type, child);
230 else if (strcasecmp ("Instance", child->key) == 0)
231 status = cmc_config_add_string ("Instance", &match->instance, child);
232 else
233 {
234 WARNING ("memcachec plugin: Option `%s' not allowed here.", child->key);
235 status = -1;
236 }
238 if (status != 0)
239 break;
240 } /* for (i = 0; i < ci->children_num; i++) */
242 while (status == 0)
243 {
244 if (match->regex == NULL)
245 {
246 WARNING ("memcachec plugin: `Regex' missing in `Match' block.");
247 status = -1;
248 }
250 if (match->type == NULL)
251 {
252 WARNING ("memcachec plugin: `Type' missing in `Match' block.");
253 status = -1;
254 }
256 if (match->dstype == 0)
257 {
258 WARNING ("memcachec plugin: `DSType' missing in `Match' block.");
259 status = -1;
260 }
262 break;
263 } /* while (status == 0) */
265 if (status != 0)
266 {
267 cmc_web_match_free (match);
268 return (status);
269 }
271 match->match = match_create_simple (match->regex, match->exclude_regex,
272 match->dstype);
273 if (match->match == NULL)
274 {
275 ERROR ("memcachec plugin: tail_match_add_match_simple failed.");
276 cmc_web_match_free (match);
277 return (-1);
278 }
279 else
280 {
281 web_match_t *prev;
283 prev = page->matches;
284 while ((prev != NULL) && (prev->next != NULL))
285 prev = prev->next;
287 if (prev == NULL)
288 page->matches = match;
289 else
290 prev->next = match;
291 }
293 return (0);
294 } /* }}} int cmc_config_add_match */
296 static int cmc_config_add_page (oconfig_item_t *ci) /* {{{ */
297 {
298 web_page_t *page;
299 int status;
300 int i;
302 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
303 {
304 WARNING ("memcachec plugin: `Page' blocks need exactly one string argument.");
305 return (-1);
306 }
308 page = (web_page_t *) malloc (sizeof (*page));
309 if (page == NULL)
310 {
311 ERROR ("memcachec plugin: malloc failed.");
312 return (-1);
313 }
314 memset (page, 0, sizeof (*page));
315 page->server = NULL;
316 page->key = NULL;
318 page->instance = strdup (ci->values[0].value.string);
319 if (page->instance == NULL)
320 {
321 ERROR ("memcachec plugin: strdup failed.");
322 sfree (page);
323 return (-1);
324 }
326 /* Process all children */
327 status = 0;
328 for (i = 0; i < ci->children_num; i++)
329 {
330 oconfig_item_t *child = ci->children + i;
332 if (strcasecmp ("Server", child->key) == 0)
333 status = cmc_config_add_string ("Server", &page->server, child);
334 else if (strcasecmp ("Key", child->key) == 0)
335 status = cmc_config_add_string ("Key", &page->key, child);
336 else if (strcasecmp ("Match", child->key) == 0)
337 /* Be liberal with failing matches => don't set `status'. */
338 cmc_config_add_match (page, child);
339 else
340 {
341 WARNING ("memcachec plugin: Option `%s' not allowed here.", child->key);
342 status = -1;
343 }
345 if (status != 0)
346 break;
347 } /* for (i = 0; i < ci->children_num; i++) */
349 /* Additionial sanity checks and libmemcached initialization. */
350 while (status == 0)
351 {
352 if (page->server == NULL)
353 {
354 WARNING ("memcachec plugin: `Server' missing in `Page' block.");
355 status = -1;
356 }
358 if (page->key == NULL)
359 {
360 WARNING ("memcachec plugin: `Key' missing in `Page' block.");
361 status = -1;
362 }
364 if (page->matches == NULL)
365 {
366 assert (page->instance != NULL);
367 WARNING ("memcachec plugin: No (valid) `Match' block "
368 "within `Page' block `%s'.", page->instance);
369 status = -1;
370 }
372 if (status == 0)
373 status = cmc_page_init_memc (page);
375 break;
376 } /* while (status == 0) */
378 if (status != 0)
379 {
380 cmc_web_page_free (page);
381 return (status);
382 }
384 /* Add the new page to the linked list */
385 if (pages_g == NULL)
386 pages_g = page;
387 else
388 {
389 web_page_t *prev;
391 prev = pages_g;
392 while ((prev != NULL) && (prev->next != NULL))
393 prev = prev->next;
394 prev->next = page;
395 }
397 return (0);
398 } /* }}} int cmc_config_add_page */
400 static int cmc_config (oconfig_item_t *ci) /* {{{ */
401 {
402 int success;
403 int errors;
404 int status;
405 int i;
407 success = 0;
408 errors = 0;
410 for (i = 0; i < ci->children_num; i++)
411 {
412 oconfig_item_t *child = ci->children + i;
414 if (strcasecmp ("Page", child->key) == 0)
415 {
416 status = cmc_config_add_page (child);
417 if (status == 0)
418 success++;
419 else
420 errors++;
421 }
422 else
423 {
424 WARNING ("memcachec plugin: Option `%s' not allowed here.", child->key);
425 errors++;
426 }
427 }
429 if ((success == 0) && (errors > 0))
430 {
431 ERROR ("memcachec plugin: All statements failed.");
432 return (-1);
433 }
435 return (0);
436 } /* }}} int cmc_config */
438 static int cmc_init (void) /* {{{ */
439 {
440 if (pages_g == NULL)
441 {
442 INFO ("memcachec plugin: No pages have been defined.");
443 return (-1);
444 }
445 return (0);
446 } /* }}} int cmc_init */
448 static void cmc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
449 const cu_match_value_t *mv)
450 {
451 value_t values[1];
452 value_list_t vl = VALUE_LIST_INIT;
454 values[0] = mv->value;
456 vl.values = values;
457 vl.values_len = 1;
458 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
459 sstrncpy (vl.plugin, "memcachec", sizeof (vl.plugin));
460 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
461 sstrncpy (vl.type, wm->type, sizeof (vl.type));
462 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
464 plugin_dispatch_values (&vl);
465 } /* }}} void cmc_submit */
467 static int cmc_read_page (web_page_t *wp) /* {{{ */
468 {
469 web_match_t *wm;
470 memcached_return rc;
471 size_t string_length;
472 uint32_t flags;
473 int status;
475 if (wp->memc == NULL)
476 return (-1);
478 wp->buffer = memcached_get (wp->memc, wp->key, strlen (wp->key),
479 &string_length, &flags, &rc);
480 if (rc != MEMCACHED_SUCCESS)
481 {
482 ERROR ("memcachec plugin: memcached_get failed: %s",
483 memcached_strerror (wp->memc, rc));
484 return (-1);
485 }
487 for (wm = wp->matches; wm != NULL; wm = wm->next)
488 {
489 cu_match_value_t *mv;
491 status = match_apply (wm->match, wp->buffer);
492 if (status != 0)
493 {
494 WARNING ("memcachec plugin: match_apply failed.");
495 continue;
496 }
498 mv = match_get_user_data (wm->match);
499 if (mv == NULL)
500 {
501 WARNING ("memcachec plugin: match_get_user_data returned NULL.");
502 continue;
503 }
505 cmc_submit (wp, wm, mv);
506 match_value_reset (mv);
507 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
509 sfree (wp->buffer);
511 return (0);
512 } /* }}} int cmc_read_page */
514 static int cmc_read (void) /* {{{ */
515 {
516 web_page_t *wp;
518 for (wp = pages_g; wp != NULL; wp = wp->next)
519 cmc_read_page (wp);
521 return (0);
522 } /* }}} int cmc_read */
524 static int cmc_shutdown (void) /* {{{ */
525 {
526 cmc_web_page_free (pages_g);
527 pages_g = NULL;
529 return (0);
530 } /* }}} int cmc_shutdown */
532 void module_register (void)
533 {
534 plugin_register_complex_config ("memcachec", cmc_config);
535 plugin_register_init ("memcachec", cmc_init);
536 plugin_register_read ("memcachec", cmc_read);
537 plugin_register_shutdown ("memcachec", cmc_shutdown);
538 } /* void module_register */
540 /* vim: set sw=2 sts=2 et fdm=marker : */