2 * collectd - src/varnish.c
3 * Copyright (C) 2010 Jerome Renard
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
20 * Jerome Renard <jerome.renard@gmail.com>
24 * Current list of what is monitored and what is not monitored (yet)
26 * Field name Description Monitored
27 * ---------- ----------- ---------
28 * uptime Child uptime N
29 * client_conn Client connections accepted Y
30 * client_drop Connection dropped, no sess Y
31 * client_req Client requests received Y
32 * cache_hit Cache hits Y
33 * cache_hitpass Cache hits for pass Y
34 * cache_miss Cache misses Y
35 * backend_conn Backend conn. success Y
36 * backend_unhealthy Backend conn. not attempted Y
37 * backend_busy Backend conn. too many Y
38 * backend_fail Backend conn. failures Y
39 * backend_reuse Backend conn. reuses Y
40 * backend_toolate Backend conn. was closed Y
41 * backend_recycle Backend conn. recycles Y
42 * backend_unused Backend conn. unused Y
43 * fetch_head Fetch head Y
44 * fetch_length Fetch with Length Y
45 * fetch_chunked Fetch chunked Y
46 * fetch_eof Fetch EOF Y
47 * fetch_bad Fetch had bad headers Y
48 * fetch_close Fetch wanted close Y
49 * fetch_oldhttp Fetch pre HTTP/1.1 closed Y
50 * fetch_zero Fetch zero len Y
51 * fetch_failed Fetch failed Y
52 * n_sess_mem N struct sess_mem N
53 * n_sess N struct sess N
54 * n_object N struct object N
55 * n_vampireobject N unresurrected objects N
56 * n_objectcore N struct objectcore N
57 * n_objecthead N struct objecthead N
58 * n_smf N struct smf N
59 * n_smf_frag N small free smf N
60 * n_smf_large N large free smf N
61 * n_vbe_conn N struct vbe_conn N
62 * n_wrk N worker threads Y
63 * n_wrk_create N worker threads created Y
64 * n_wrk_failed N worker threads not created Y
65 * n_wrk_max N worker threads limited Y
66 * n_wrk_queue N queued work requests Y
67 * n_wrk_overflow N overflowed work requests Y
68 * n_wrk_drop N dropped work requests Y
69 * n_backend N backends N
70 * n_expired N expired objects N
71 * n_lru_nuked N LRU nuked objects N
72 * n_lru_saved N LRU saved objects N
73 * n_lru_moved N LRU moved objects N
74 * n_deathrow N objects on deathrow N
75 * losthdr HTTP header overflows N
76 * n_objsendfile Objects sent with sendfile N
77 * n_objwrite Objects sent with write N
78 * n_objoverflow Objects overflowing workspace N
79 * s_sess Total Sessions Y
80 * s_req Total Requests Y
83 * s_fetch Total fetch Y
84 * s_hdrbytes Total header bytes Y
85 * s_bodybytes Total body bytes Y
86 * sess_closed Session Closed N
87 * sess_pipeline Session Pipeline N
88 * sess_readahead Session Read Ahead N
89 * sess_linger Session Linger N
90 * sess_herd Session herd N
91 * shm_records SHM records Y
92 * shm_writes SHM writes Y
93 * shm_flushes SHM flushes due to overflow Y
94 * shm_cont SHM MTX contention Y
95 * shm_cycles SHM cycles through buffer Y
96 * sm_nreq allocator requests Y
97 * sm_nobj outstanding allocations Y
98 * sm_balloc bytes allocated Y
99 * sm_bfree bytes free Y
100 * sma_nreq SMA allocator requests Y
101 * sma_nobj SMA outstanding allocations Y
102 * sma_nbytes SMA outstanding bytes Y
103 * sma_balloc SMA bytes allocated Y
104 * sma_bfree SMA bytes free Y
105 * sms_nreq SMS allocator requests Y
106 * sms_nobj SMS outstanding allocations Y
107 * sms_nbytes SMS outstanding bytes Y
108 * sms_balloc SMS bytes allocated Y
109 * sms_bfree SMS bytes freed Y
110 * backend_req Backend requests made N
111 * n_vcl N vcl total N
112 * n_vcl_avail N vcl available N
113 * n_vcl_discard N vcl discarded N
114 * n_purge N total active purges N
115 * n_purge_add N new purges added N
116 * n_purge_retire N old purges deleted N
117 * n_purge_obj_test N objects tested N
118 * n_purge_re_test N regexps tested against N
119 * n_purge_dups N duplicate purges removed N
120 * hcb_nolock HCB Lookups without lock Y
121 * hcb_lock HCB Lookups with lock Y
122 * hcb_insert HCB Inserts Y
123 * esi_parse Objects ESI parsed (unlock) Y
124 * esi_errors ESI parse errors (unlock) Y
127 #include "collectd.h"
130 #include "configfile.h"
132 #include <varnish/varnishapi.h>
134 /* {{{ user_config_s */
135 struct user_config_s {
139 _Bool collect_connections;
141 _Bool collect_backend;
148 _Bool collect_totals;
149 _Bool collect_workers;
151 typedef struct user_config_s user_config_t; /* }}} */
153 static _Bool have_instance = 0;
155 static int varnish_submit (const char *plugin_instance, /* {{{ */
156 const char *category, const char *type, const char *type_instance, value_t value)
158 value_list_t vl = VALUE_LIST_INIT;
163 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
165 sstrncpy(vl.plugin, "varnish", sizeof(vl.plugin));
167 if (plugin_instance == NULL)
168 plugin_instance = "default";
170 sstrncpy (vl.plugin_instance, plugin_instance,
171 sizeof (vl.plugin_instance));
172 strncat(vl.plugin_instance, "-", 1);
173 strncat(vl.plugin_instance, category, sizeof(category));
175 sstrncpy(vl.type, type, sizeof(vl.type));
177 if (type_instance != NULL)
178 sstrncpy(vl.type_instance, type_instance,
179 sizeof(vl.type_instance));
181 return (plugin_dispatch_values(&vl));
182 } /* }}} int varnish_submit */
184 static int varnish_submit_gauge (const char *plugin_instance, /* {{{ */
185 const char *category, const char *type, const char *type_instance,
186 uint64_t gauge_value)
190 value.gauge = (gauge_t) gauge_value;
192 return (varnish_submit (plugin_instance, category, type, type_instance, value));
193 } /* }}} int varnish_submit_gauge */
195 static int varnish_submit_derive (const char *plugin_instance, /* {{{ */
196 const char *category, const char *type, const char *type_instance,
197 uint64_t derive_value)
201 value.derive = (derive_t) derive_value;
203 return (varnish_submit (plugin_instance, category, type, type_instance, value));
204 } /* }}} int varnish_submit_derive */
206 static void varnish_monitor(const user_config_t *conf, struct varnish_stats *VSL_stats) /* {{{ */
208 if(conf->collect_cache)
211 varnish_submit_derive (conf->instance, "cache", "cache_result", "hit", VSL_stats->cache_hit);
213 varnish_submit_derive (conf->instance, "cache", "cache_result", "miss", VSL_stats->cache_miss);
214 /* Cache hits for pass */
215 varnish_submit_derive (conf->instance, "cache", "cache_result", "hitpass", VSL_stats->cache_hitpass);
218 if(conf->collect_connections)
220 /* Client connections accepted */
221 varnish_submit_derive (conf->instance, "client", "connections", "accepted", VSL_stats->client_conn);
222 /* Connection dropped, no sess */
223 varnish_submit_derive (conf->instance, "client", "connections", "dropped" , VSL_stats->client_drop);
224 /* Client requests received */
225 varnish_submit_derive (conf->instance, "client", "connections", "received", VSL_stats->client_req);
228 if(conf->collect_esi)
230 /* Objects ESI parsed (unlock) */
231 varnish_submit_derive (conf->instance, "esi", "total_operations", "parsed", VSL_stats->esi_parse);
232 /* ESI parse errors (unlock) */
233 varnish_submit_derive (conf->instance, "esi", "total_operations", "error", VSL_stats->esi_errors);
236 if(conf->collect_backend)
238 /* Backend conn. success */
239 varnish_submit_derive (conf->instance, "backend", "connections", "success" , VSL_stats->backend_conn);
240 /* Backend conn. not attempted */
241 varnish_submit_derive (conf->instance, "backend", "connections", "not-attempted", VSL_stats->backend_unhealthy);
242 /* Backend conn. too many */
243 varnish_submit_derive (conf->instance, "backend", "connections", "too-many" , VSL_stats->backend_busy);
244 /* Backend conn. failures */
245 varnish_submit_derive (conf->instance, "backend", "connections", "failures" , VSL_stats->backend_fail);
246 /* Backend conn. reuses */
247 varnish_submit_derive (conf->instance, "backend", "connections", "reuses" , VSL_stats->backend_reuse);
248 /* Backend conn. was closed */
249 varnish_submit_derive (conf->instance, "backend", "connections", "was-closed" , VSL_stats->backend_toolate);
250 /* Backend conn. recycles */
251 varnish_submit_derive (conf->instance, "backend", "connections", "recycled" , VSL_stats->backend_recycle);
252 /* Backend conn. unused */
253 varnish_submit_derive (conf->instance, "backend", "connections", "unused" , VSL_stats->backend_unused);
256 if(conf->collect_fetch)
259 varnish_submit_derive (conf->instance, "fetch", "http_requests", "head" , VSL_stats->fetch_head);
260 /* Fetch with length */
261 varnish_submit_derive (conf->instance, "fetch", "http_requests", "length" , VSL_stats->fetch_length);
263 varnish_submit_derive (conf->instance, "fetch", "http_requests", "chunked" , VSL_stats->fetch_chunked);
265 varnish_submit_derive (conf->instance, "fetch", "http_requests", "eof" , VSL_stats->fetch_eof);
266 /* Fetch bad headers */
267 varnish_submit_derive (conf->instance, "fetch", "http_requests", "bad_headers", VSL_stats->fetch_bad);
268 /* Fetch wanted close */
269 varnish_submit_derive (conf->instance, "fetch", "http_requests", "close" , VSL_stats->fetch_close);
270 /* Fetch pre HTTP/1.1 closed */
271 varnish_submit_derive (conf->instance, "fetch", "http_requests", "oldhttp" , VSL_stats->fetch_oldhttp);
273 varnish_submit_derive (conf->instance, "fetch", "http_requests", "zero" , VSL_stats->fetch_zero);
275 varnish_submit_derive (conf->instance, "fetch", "http_requests", "failed" , VSL_stats->fetch_failed);
278 if(conf->collect_hcb)
280 /* HCB Lookups without lock */
281 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "lookup_nolock", VSL_stats->hcb_nolock);
282 /* HCB Lookups with lock */
283 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "lookup_lock", VSL_stats->hcb_lock);
285 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "insert", VSL_stats->hcb_insert);
288 if(conf->collect_shm)
291 varnish_submit_derive (conf->instance, "shm", "total_operations", "records" , VSL_stats->shm_records);
293 varnish_submit_derive (conf->instance, "shm", "total_operations", "writes" , VSL_stats->shm_writes);
294 /* SHM flushes due to overflow */
295 varnish_submit_derive (conf->instance, "shm", "total_operations", "flushes" , VSL_stats->shm_flushes);
296 /* SHM MTX contention */
297 varnish_submit_derive (conf->instance, "shm", "total_operations", "contention", VSL_stats->shm_cont);
298 /* SHM cycles through buffer */
299 varnish_submit_derive (conf->instance, "shm", "total_operations", "cycles" , VSL_stats->shm_cycles);
304 /* allocator requests */
305 varnish_submit_derive (conf->instance, "sm", "total_requests", "nreq", VSL_stats->sm_nreq);
306 /* outstanding allocations */
307 varnish_submit_gauge (conf->instance, "sm", "requests", "outstanding", VSL_stats->sm_nobj);
308 /* bytes allocated */
309 varnish_submit_gauge (conf->instance, "sm", "bytes", "allocated", VSL_stats->sm_balloc);
311 varnish_submit_gauge (conf->instance, "sm", "bytes", "free", VSL_stats->sm_bfree);
314 if(conf->collect_sma)
316 /* SMA allocator requests */
317 varnish_submit_derive (conf->instance, "sma", "total_requests", "nreq", VSL_stats->sma_nreq);
318 /* SMA outstanding allocations */
319 varnish_submit_gauge (conf->instance, "sma", "requests", "outstanding", VSL_stats->sma_nobj);
320 /* SMA outstanding bytes */
321 varnish_submit_gauge (conf->instance, "sma", "bytes", "outstanding", VSL_stats->sma_nbytes);
322 /* SMA bytes allocated */
323 varnish_submit_gauge (conf->instance, "sma", "bytes", "allocated", VSL_stats->sma_balloc);
325 varnish_submit_gauge (conf->instance, "sma", "bytes", "free" , VSL_stats->sma_bfree);
328 if(conf->collect_sms)
330 /* SMS allocator requests */
331 varnish_submit_derive (conf->instance, "sms", "total_requests", "allocator", VSL_stats->sms_nreq);
332 /* SMS outstanding allocations */
333 varnish_submit_gauge (conf->instance, "sms", "requests", "outstanding", VSL_stats->sms_nobj);
334 /* SMS outstanding bytes */
335 varnish_submit_gauge (conf->instance, "sms", "bytes", "outstanding", VSL_stats->sms_nbytes);
336 /* SMS bytes allocated */
337 varnish_submit_gauge (conf->instance, "sms", "bytes", "allocated", VSL_stats->sms_balloc);
338 /* SMS bytes freed */
339 varnish_submit_gauge (conf->instance, "sms", "bytes", "free", VSL_stats->sms_bfree);
342 if(conf->collect_totals)
345 varnish_submit_derive (conf->instance, "s", "total_sessions", "sessions", VSL_stats->s_sess);
347 varnish_submit_derive (conf->instance, "s", "total_requests", "requests", VSL_stats->s_req);
349 varnish_submit_derive (conf->instance, "s", "total_operations", "pipe", VSL_stats->s_pipe);
351 varnish_submit_derive (conf->instance, "s", "total_operations", "pass", VSL_stats->s_pass);
353 varnish_submit_derive (conf->instance, "s", "total_operations", "fetches", VSL_stats->s_fetch);
354 /* Total header bytes */
355 varnish_submit_derive (conf->instance, "s", "total_bytes", "header-bytes", VSL_stats->s_hdrbytes);
356 /* Total body byte */
357 varnish_submit_derive (conf->instance, "s", "total_bytes", "body-bytes", VSL_stats->s_bodybytes);
360 if(conf->collect_workers)
363 varnish_submit_gauge (conf->instance, "n_wrk", "threads", "worker", VSL_stats->n_wrk);
364 /* worker threads created */
365 varnish_submit_gauge (conf->instance, "n_wrk", "total_threads", "created", VSL_stats->n_wrk_create);
366 /* worker threads not created */
367 varnish_submit_gauge (conf->instance, "n_wrk", "total_threads", "failed", VSL_stats->n_wrk_failed);
368 /* worker threads limited */
369 varnish_submit_gauge (conf->instance, "n_wrk", "total_threads", "limited", VSL_stats->n_wrk_max);
370 /* queued work requests */
371 varnish_submit_gauge (conf->instance, "n_wrk", "total_requests", "queued", VSL_stats->n_wrk_queue);
372 /* overflowed work requests */
373 varnish_submit_gauge (conf->instance, "n_wrk", "total_requests", "overflowed", VSL_stats->n_wrk_overflow);
374 /* dropped work requests */
375 varnish_submit_gauge (conf->instance, "n_wrk", "total_requests", "dropped", VSL_stats->n_wrk_drop);
377 } /* }}} void varnish_monitor */
379 static int varnish_read(user_data_t *ud) /* {{{ */
381 struct varnish_stats *VSL_stats;
384 if ((ud == NULL) || (ud->data == NULL))
389 VSL_stats = VSL_OpenStats(conf->instance);
390 if (VSL_stats == NULL)
392 ERROR("Varnish plugin : unable to load statistics");
397 varnish_monitor(conf, VSL_stats);
402 static void varnish_config_free (void *ptr) /* {{{ */
404 user_config_t *conf = ptr;
409 sfree (conf->instance);
413 static int varnish_config_apply_default (user_config_t *conf) /* {{{ */
418 conf->collect_backend = 1;
419 conf->collect_cache = 1;
420 conf->collect_connections = 1;
421 conf->collect_esi = 0;
422 conf->collect_fetch = 0;
423 conf->collect_hcb = 0;
424 conf->collect_shm = 1;
425 conf->collect_sm = 0;
426 conf->collect_sma = 0;
427 conf->collect_sms = 0;
428 conf->collect_totals = 0;
431 } /* }}} int varnish_config_apply_default */
433 static int varnish_init (void) /* {{{ */
441 conf = malloc (sizeof (*conf));
444 memset (conf, 0, sizeof (*conf));
446 /* Default settings: */
447 conf->instance = NULL;
449 varnish_config_apply_default (conf);
452 ud.free_func = varnish_config_free;
454 plugin_register_complex_read (/* group = */ "varnish",
455 /* name = */ "varnish/localhost",
456 /* callback = */ varnish_read,
457 /* interval = */ NULL,
458 /* user data = */ &ud);
461 } /* }}} int varnish_init */
463 static int varnish_config_instance (const oconfig_item_t *ci) /* {{{ */
467 char callback_name[DATA_MAX_NAME_LEN];
470 conf = malloc (sizeof (*conf));
473 memset (conf, 0, sizeof (*conf));
474 conf->instance = NULL;
476 varnish_config_apply_default (conf);
478 if (ci->values_num == 1)
482 status = cf_util_get_string (ci, &conf->instance);
488 assert (conf->instance != NULL);
490 if (strcmp ("localhost", conf->instance) == 0)
492 sfree (conf->instance);
493 conf->instance = NULL;
496 else if (ci->values_num > 1)
498 WARNING ("Varnish plugin: \"Instance\" blocks accept only "
503 for (i = 0; i < ci->children_num; i++)
505 oconfig_item_t *child = ci->children + i;
507 if (strcasecmp ("CollectCache", child->key) == 0)
508 cf_util_get_boolean (child, &conf->collect_cache);
509 else if (strcasecmp ("CollectConnections", child->key) == 0)
510 cf_util_get_boolean (child, &conf->collect_connections);
511 else if (strcasecmp ("CollectESI", child->key) == 0)
512 cf_util_get_boolean (child, &conf->collect_esi);
513 else if (strcasecmp ("CollectBackend", child->key) == 0)
514 cf_util_get_boolean (child, &conf->collect_backend);
515 else if (strcasecmp ("CollectFetch", child->key) == 0)
516 cf_util_get_boolean (child, &conf->collect_fetch);
517 else if (strcasecmp ("CollectHCB", child->key) == 0)
518 cf_util_get_boolean (child, &conf->collect_hcb);
519 else if (strcasecmp ("CollectSHM", child->key) == 0)
520 cf_util_get_boolean (child, &conf->collect_shm);
521 else if (strcasecmp ("CollectSMA", child->key) == 0)
522 cf_util_get_boolean (child, &conf->collect_sma);
523 else if (strcasecmp ("CollectSMS", child->key) == 0)
524 cf_util_get_boolean (child, &conf->collect_sms);
525 else if (strcasecmp ("CollectSM", child->key) == 0)
526 cf_util_get_boolean (child, &conf->collect_sm);
527 else if (strcasecmp ("CollectTotals", child->key) == 0)
528 cf_util_get_boolean (child, &conf->collect_totals);
529 else if (strcasecmp ("CollectWorkers", child->key) == 0)
530 cf_util_get_boolean (child, &conf->collect_workers);
533 WARNING ("Varnish plugin: Ignoring unknown "
534 "configuration option: \"%s\"",
539 if (!conf->collect_cache
540 && !conf->collect_connections
541 && !conf->collect_esi
542 && !conf->collect_backend
543 && !conf->collect_fetch
544 && !conf->collect_hcb
545 && !conf->collect_shm
546 && !conf->collect_sma
547 && !conf->collect_sms
549 && !conf->collect_totals
550 && !conf->collect_workers)
552 WARNING ("Varnish plugin: No metric has been configured for "
553 "instance \"%s\". Disabling this instance.",
554 (conf->instance == NULL) ? "localhost" : conf->instance);
558 ssnprintf (callback_name, sizeof (callback_name), "varnish/%s",
559 (conf->instance == NULL) ? "localhost" : conf->instance);
562 ud.free_func = varnish_config_free;
564 plugin_register_complex_read (/* group = */ "varnish",
565 /* name = */ callback_name,
566 /* callback = */ varnish_read,
567 /* interval = */ NULL,
568 /* user data = */ &ud);
573 } /* }}} int varnish_config_instance */
575 static int varnish_config (oconfig_item_t *ci) /* {{{ */
579 for (i = 0; i < ci->children_num; i++)
581 oconfig_item_t *child = ci->children + i;
583 if (strcasecmp ("Instance", child->key) == 0)
584 varnish_config_instance (child);
587 WARNING ("Varnish plugin: Ignoring unknown "
588 "configuration option: \"%s\"",
594 } /* }}} int varnish_config */
596 void module_register (void) /* {{{ */
598 plugin_register_complex_config("varnish", varnish_config);
599 plugin_register_init ("varnish", varnish_init);
602 /* vim: set sw=8 noet fdm=marker : */