2 * collectd - src/varnish.c
3 * Copyright (C) 2010 Jérôme Renard
4 * Copyright (C) 2010 Marc Fournier
5 * Copyright (C) 2010 Florian Forster
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Jérôme Renard <jerome.renard at gmail.com>
22 * Marc Fournier <marc.fournier at camptocamp.com>
23 * Florian octo Forster <octo at verplant.org>
27 * Current list of what is monitored and what is not monitored (yet)
29 * Field name Description Monitored
30 * ---------- ----------- ---------
31 * uptime Child uptime N
32 * client_conn Client connections accepted Y
33 * client_drop Connection dropped, no sess Y
34 * client_req Client requests received Y
35 * cache_hit Cache hits Y
36 * cache_hitpass Cache hits for pass Y
37 * cache_miss Cache misses Y
38 * backend_conn Backend conn. success Y
39 * backend_unhealthy Backend conn. not attempted Y
40 * backend_busy Backend conn. too many Y
41 * backend_fail Backend conn. failures Y
42 * backend_reuse Backend conn. reuses Y
43 * backend_toolate Backend conn. was closed Y
44 * backend_recycle Backend conn. recycles Y
45 * backend_unused Backend conn. unused Y
46 * fetch_head Fetch head Y
47 * fetch_length Fetch with Length Y
48 * fetch_chunked Fetch chunked Y
49 * fetch_eof Fetch EOF Y
50 * fetch_bad Fetch had bad headers Y
51 * fetch_close Fetch wanted close Y
52 * fetch_oldhttp Fetch pre HTTP/1.1 closed Y
53 * fetch_zero Fetch zero len Y
54 * fetch_failed Fetch failed Y
55 * n_sess_mem N struct sess_mem N
56 * n_sess N struct sess N
57 * n_object N struct object N
58 * n_vampireobject N unresurrected objects N
59 * n_objectcore N struct objectcore N
60 * n_objecthead N struct objecthead N
61 * n_smf N struct smf N
62 * n_smf_frag N small free smf N
63 * n_smf_large N large free smf N
64 * n_vbe_conn N struct vbe_conn N
65 * n_wrk N worker threads Y
66 * n_wrk_create N worker threads created Y
67 * n_wrk_failed N worker threads not created Y
68 * n_wrk_max N worker threads limited Y
69 * n_wrk_queue N queued work requests Y
70 * n_wrk_overflow N overflowed work requests Y
71 * n_wrk_drop N dropped work requests Y
72 * n_backend N backends N
73 * n_expired N expired objects N
74 * n_lru_nuked N LRU nuked objects N
75 * n_lru_saved N LRU saved objects N
76 * n_lru_moved N LRU moved objects N
77 * n_deathrow N objects on deathrow N
78 * losthdr HTTP header overflows N
79 * n_objsendfile Objects sent with sendfile N
80 * n_objwrite Objects sent with write N
81 * n_objoverflow Objects overflowing workspace N
82 * s_sess Total Sessions Y
83 * s_req Total Requests Y
86 * s_fetch Total fetch Y
87 * s_hdrbytes Total header bytes Y
88 * s_bodybytes Total body bytes Y
89 * sess_closed Session Closed N
90 * sess_pipeline Session Pipeline N
91 * sess_readahead Session Read Ahead N
92 * sess_linger Session Linger N
93 * sess_herd Session herd N
94 * shm_records SHM records Y
95 * shm_writes SHM writes Y
96 * shm_flushes SHM flushes due to overflow Y
97 * shm_cont SHM MTX contention Y
98 * shm_cycles SHM cycles through buffer Y
99 * sm_nreq allocator requests Y
100 * sm_nobj outstanding allocations Y
101 * sm_balloc bytes allocated Y
102 * sm_bfree bytes free Y
103 * sma_nreq SMA allocator requests Y
104 * sma_nobj SMA outstanding allocations Y
105 * sma_nbytes SMA outstanding bytes Y
106 * sma_balloc SMA bytes allocated Y
107 * sma_bfree SMA bytes free Y
108 * sms_nreq SMS allocator requests Y
109 * sms_nobj SMS outstanding allocations Y
110 * sms_nbytes SMS outstanding bytes Y
111 * sms_balloc SMS bytes allocated Y
112 * sms_bfree SMS bytes freed Y
113 * backend_req Backend requests made N
114 * n_vcl N vcl total N
115 * n_vcl_avail N vcl available N
116 * n_vcl_discard N vcl discarded N
117 * n_purge N total active purges N
118 * n_purge_add N new purges added N
119 * n_purge_retire N old purges deleted N
120 * n_purge_obj_test N objects tested N
121 * n_purge_re_test N regexps tested against N
122 * n_purge_dups N duplicate purges removed N
123 * hcb_nolock HCB Lookups without lock Y
124 * hcb_lock HCB Lookups with lock Y
125 * hcb_insert HCB Inserts Y
126 * esi_parse Objects ESI parsed (unlock) Y
127 * esi_errors ESI parse errors (unlock) Y
130 #include "collectd.h"
133 #include "configfile.h"
135 #include <varnish/varnishapi.h>
137 #include <varnish/vsc.h>
138 #define STAT_STRUCT VSC_C_main
142 #define STAT_STRUCT VSL_stats
145 /* {{{ user_config_s */
146 struct user_config_s {
150 _Bool collect_connections;
152 _Bool collect_backend;
161 _Bool collect_totals;
162 _Bool collect_workers;
164 typedef struct user_config_s user_config_t; /* }}} */
166 static _Bool have_instance = 0;
168 static int varnish_submit (const char *plugin_instance, /* {{{ */
169 const char *category, const char *type, const char *type_instance, value_t value)
171 value_list_t vl = VALUE_LIST_INIT;
176 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
178 sstrncpy (vl.plugin, "varnish", sizeof (vl.plugin));
180 if (plugin_instance == NULL)
181 plugin_instance = "default";
183 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
184 "%s-%s", plugin_instance, category);
186 sstrncpy (vl.type, type, sizeof (vl.type));
188 if (type_instance != NULL)
189 sstrncpy (vl.type_instance, type_instance,
190 sizeof (vl.type_instance));
192 return (plugin_dispatch_values (&vl));
193 } /* }}} int varnish_submit */
195 static int varnish_submit_gauge (const char *plugin_instance, /* {{{ */
196 const char *category, const char *type, const char *type_instance,
197 uint64_t gauge_value)
201 value.gauge = (gauge_t) gauge_value;
203 return (varnish_submit (plugin_instance, category, type, type_instance, value));
204 } /* }}} int varnish_submit_gauge */
206 static int varnish_submit_derive (const char *plugin_instance, /* {{{ */
207 const char *category, const char *type, const char *type_instance,
208 uint64_t derive_value)
212 value.derive = (derive_t) derive_value;
214 return (varnish_submit (plugin_instance, category, type, type_instance, value));
215 } /* }}} int varnish_submit_derive */
218 static void varnish_monitor (const user_config_t *conf, struct varnish_stats *VSL_stats) /* {{{ */
221 static void varnish_monitor (const user_config_t *conf, const struct VSC_C_main *VSC_C_main)
224 if (conf->collect_cache)
227 varnish_submit_derive (conf->instance, "cache", "cache_result", "hit", STAT_STRUCT->cache_hit);
229 varnish_submit_derive (conf->instance, "cache", "cache_result", "miss", STAT_STRUCT->cache_miss);
230 /* Cache hits for pass */
231 varnish_submit_derive (conf->instance, "cache", "cache_result", "hitpass", STAT_STRUCT->cache_hitpass);
234 if (conf->collect_connections)
236 /* Client connections accepted */
237 varnish_submit_derive (conf->instance, "connections", "connections", "accepted", STAT_STRUCT->client_conn);
238 /* Connection dropped, no sess */
239 varnish_submit_derive (conf->instance, "connections", "connections", "dropped" , STAT_STRUCT->client_drop);
240 /* Client requests received */
241 varnish_submit_derive (conf->instance, "connections", "connections", "received", STAT_STRUCT->client_req);
244 if (conf->collect_esi)
247 /* Objects ESI parsed (unlock) */
248 varnish_submit_derive (conf->instance, "esi", "total_operations", "parsed", STAT_STRUCT->esi_parse);
250 /* ESI parse errors (unlock) */
251 varnish_submit_derive (conf->instance, "esi", "total_operations", "error", STAT_STRUCT->esi_errors);
254 if (conf->collect_backend)
256 /* Backend conn. success */
257 varnish_submit_derive (conf->instance, "backend", "connections", "success" , STAT_STRUCT->backend_conn);
258 /* Backend conn. not attempted */
259 varnish_submit_derive (conf->instance, "backend", "connections", "not-attempted", STAT_STRUCT->backend_unhealthy);
260 /* Backend conn. too many */
261 varnish_submit_derive (conf->instance, "backend", "connections", "too-many" , STAT_STRUCT->backend_busy);
262 /* Backend conn. failures */
263 varnish_submit_derive (conf->instance, "backend", "connections", "failures" , STAT_STRUCT->backend_fail);
264 /* Backend conn. reuses */
265 varnish_submit_derive (conf->instance, "backend", "connections", "reuses" , STAT_STRUCT->backend_reuse);
266 /* Backend conn. was closed */
267 varnish_submit_derive (conf->instance, "backend", "connections", "was-closed" , STAT_STRUCT->backend_toolate);
268 /* Backend conn. recycles */
269 varnish_submit_derive (conf->instance, "backend", "connections", "recycled" , STAT_STRUCT->backend_recycle);
271 /* Backend conn. unused */
272 varnish_submit_derive (conf->instance, "backend", "connections", "unused" , STAT_STRUCT->backend_unused);
276 if (conf->collect_fetch)
279 varnish_submit_derive (conf->instance, "fetch", "http_requests", "head" , STAT_STRUCT->fetch_head);
280 /* Fetch with length */
281 varnish_submit_derive (conf->instance, "fetch", "http_requests", "length" , STAT_STRUCT->fetch_length);
283 varnish_submit_derive (conf->instance, "fetch", "http_requests", "chunked" , STAT_STRUCT->fetch_chunked);
285 varnish_submit_derive (conf->instance, "fetch", "http_requests", "eof" , STAT_STRUCT->fetch_eof);
286 /* Fetch bad headers */
287 varnish_submit_derive (conf->instance, "fetch", "http_requests", "bad_headers", STAT_STRUCT->fetch_bad);
288 /* Fetch wanted close */
289 varnish_submit_derive (conf->instance, "fetch", "http_requests", "close" , STAT_STRUCT->fetch_close);
290 /* Fetch pre HTTP/1.1 closed */
291 varnish_submit_derive (conf->instance, "fetch", "http_requests", "oldhttp" , STAT_STRUCT->fetch_oldhttp);
293 varnish_submit_derive (conf->instance, "fetch", "http_requests", "zero" , STAT_STRUCT->fetch_zero);
295 varnish_submit_derive (conf->instance, "fetch", "http_requests", "failed" , STAT_STRUCT->fetch_failed);
298 if (conf->collect_hcb)
300 /* HCB Lookups without lock */
301 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "lookup_nolock", STAT_STRUCT->hcb_nolock);
302 /* HCB Lookups with lock */
303 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "lookup_lock", STAT_STRUCT->hcb_lock);
305 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "insert", STAT_STRUCT->hcb_insert);
308 if (conf->collect_shm)
311 varnish_submit_derive (conf->instance, "shm", "total_operations", "records" , STAT_STRUCT->shm_records);
313 varnish_submit_derive (conf->instance, "shm", "total_operations", "writes" , STAT_STRUCT->shm_writes);
314 /* SHM flushes due to overflow */
315 varnish_submit_derive (conf->instance, "shm", "total_operations", "flushes" , STAT_STRUCT->shm_flushes);
316 /* SHM MTX contention */
317 varnish_submit_derive (conf->instance, "shm", "total_operations", "contention", STAT_STRUCT->shm_cont);
318 /* SHM cycles through buffer */
319 varnish_submit_derive (conf->instance, "shm", "total_operations", "cycles" , STAT_STRUCT->shm_cycles);
323 if (conf->collect_sm)
325 /* allocator requests */
326 varnish_submit_derive (conf->instance, "sm", "total_requests", "nreq", STAT_STRUCT->sm_nreq);
327 /* outstanding allocations */
328 varnish_submit_gauge (conf->instance, "sm", "requests", "outstanding", STAT_STRUCT->sm_nobj);
329 /* bytes allocated */
330 varnish_submit_derive (conf->instance, "sm", "total_bytes", "allocated", STAT_STRUCT->sm_balloc);
332 varnish_submit_derive (conf->instance, "sm", "total_bytes", "free", STAT_STRUCT->sm_bfree);
335 if (conf->collect_sma)
337 /* SMA allocator requests */
338 varnish_submit_derive (conf->instance, "sma", "total_requests", "nreq", STAT_STRUCT->sma_nreq);
339 /* SMA outstanding allocations */
340 varnish_submit_gauge (conf->instance, "sma", "requests", "outstanding", STAT_STRUCT->sma_nobj);
341 /* SMA outstanding bytes */
342 varnish_submit_gauge (conf->instance, "sma", "bytes", "outstanding", STAT_STRUCT->sma_nbytes);
343 /* SMA bytes allocated */
344 varnish_submit_derive (conf->instance, "sma", "total_bytes", "allocated", STAT_STRUCT->sma_balloc);
346 varnish_submit_derive (conf->instance, "sma", "total_bytes", "free" , STAT_STRUCT->sma_bfree);
350 if (conf->collect_sms)
352 /* SMS allocator requests */
353 varnish_submit_derive (conf->instance, "sms", "total_requests", "allocator", STAT_STRUCT->sms_nreq);
354 /* SMS outstanding allocations */
355 varnish_submit_gauge (conf->instance, "sms", "requests", "outstanding", STAT_STRUCT->sms_nobj);
356 /* SMS outstanding bytes */
357 varnish_submit_gauge (conf->instance, "sms", "bytes", "outstanding", STAT_STRUCT->sms_nbytes);
358 /* SMS bytes allocated */
359 varnish_submit_derive (conf->instance, "sms", "total_bytes", "allocated", STAT_STRUCT->sms_balloc);
360 /* SMS bytes freed */
361 varnish_submit_derive (conf->instance, "sms", "total_bytes", "free", STAT_STRUCT->sms_bfree);
364 if (conf->collect_totals)
367 varnish_submit_derive (conf->instance, "totals", "total_sessions", "sessions", STAT_STRUCT->s_sess);
369 varnish_submit_derive (conf->instance, "totals", "total_requests", "requests", STAT_STRUCT->s_req);
371 varnish_submit_derive (conf->instance, "totals", "total_operations", "pipe", STAT_STRUCT->s_pipe);
373 varnish_submit_derive (conf->instance, "totals", "total_operations", "pass", STAT_STRUCT->s_pass);
375 varnish_submit_derive (conf->instance, "totals", "total_operations", "fetches", STAT_STRUCT->s_fetch);
376 /* Total header bytes */
377 varnish_submit_derive (conf->instance, "totals", "total_bytes", "header-bytes", STAT_STRUCT->s_hdrbytes);
378 /* Total body byte */
379 varnish_submit_derive (conf->instance, "totals", "total_bytes", "body-bytes", STAT_STRUCT->s_bodybytes);
382 if (conf->collect_workers)
385 varnish_submit_gauge (conf->instance, "workers", "threads", "worker", STAT_STRUCT->n_wrk);
386 /* worker threads created */
387 varnish_submit_derive (conf->instance, "workers", "total_threads", "created", STAT_STRUCT->n_wrk_create);
388 /* worker threads not created */
389 varnish_submit_derive (conf->instance, "workers", "total_threads", "failed", STAT_STRUCT->n_wrk_failed);
390 /* worker threads limited */
391 varnish_submit_derive (conf->instance, "workers", "total_threads", "limited", STAT_STRUCT->n_wrk_max);
392 #ifdef HAVE_VARNISH_V2
393 /* queued work requests */
394 varnish_submit_derive (conf->instance, "workers", "total_requests", "queued", STAT_STRUCT->n_wrk_queue);
395 /* overflowed work requests */
396 varnish_submit_derive (conf->instance, "workers", "total_requests", "overflowed", STAT_STRUCT->n_wrk_overflow);
398 /* dropped work requests */
399 varnish_submit_derive (conf->instance, "workers", "total_requests", "dropped", STAT_STRUCT->n_wrk_drop);
401 } /* }}} void varnish_monitor */
403 static int varnish_read (user_data_t *ud) /* {{{ */
405 #ifdef HAVE_VARNISH_V2
406 struct varnish_stats *VSL_stats;
409 #ifdef HAVE_VARNISH_V3
411 const struct VSC_C_main *VSC_C_main;
416 if ((ud == NULL) || (ud->data == NULL))
421 #ifdef HAVE_VARNISH_V2
422 VSL_stats = VSL_OpenStats (conf->instance);
423 if (VSL_stats == NULL)
425 ERROR ("Varnish plugin : unable to load statistics");
430 varnish_monitor (conf, VSL_stats);
433 #ifdef HAVE_VARNISH_V3
438 ERROR ("Varnish plugin : unable to load statistics");
443 VSC_C_main = VSC_Main(vd);
445 varnish_monitor (conf, VSC_C_main);
451 static void varnish_config_free (void *ptr) /* {{{ */
453 user_config_t *conf = ptr;
458 sfree (conf->instance);
462 static int varnish_config_apply_default (user_config_t *conf) /* {{{ */
467 conf->collect_backend = 1;
468 conf->collect_cache = 1;
469 conf->collect_connections = 1;
470 conf->collect_esi = 0;
471 conf->collect_fetch = 0;
472 conf->collect_hcb = 0;
473 conf->collect_shm = 1;
475 conf->collect_sm = 0;
476 conf->collect_sma = 0;
478 conf->collect_sms = 0;
479 conf->collect_totals = 0;
482 } /* }}} int varnish_config_apply_default */
484 static int varnish_init (void) /* {{{ */
492 conf = malloc (sizeof (*conf));
495 memset (conf, 0, sizeof (*conf));
497 /* Default settings: */
498 conf->instance = NULL;
500 varnish_config_apply_default (conf);
503 ud.free_func = varnish_config_free;
505 plugin_register_complex_read (/* group = */ "varnish",
506 /* name = */ "varnish/localhost",
507 /* callback = */ varnish_read,
508 /* interval = */ NULL,
509 /* user data = */ &ud);
512 } /* }}} int varnish_init */
514 static int varnish_config_instance (const oconfig_item_t *ci) /* {{{ */
518 char callback_name[DATA_MAX_NAME_LEN];
521 conf = malloc (sizeof (*conf));
524 memset (conf, 0, sizeof (*conf));
525 conf->instance = NULL;
527 varnish_config_apply_default (conf);
529 if (ci->values_num == 1)
533 status = cf_util_get_string (ci, &conf->instance);
539 assert (conf->instance != NULL);
541 if (strcmp ("localhost", conf->instance) == 0)
543 sfree (conf->instance);
544 conf->instance = NULL;
547 else if (ci->values_num > 1)
549 WARNING ("Varnish plugin: \"Instance\" blocks accept only "
554 for (i = 0; i < ci->children_num; i++)
556 oconfig_item_t *child = ci->children + i;
558 if (strcasecmp ("CollectCache", child->key) == 0)
559 cf_util_get_boolean (child, &conf->collect_cache);
560 else if (strcasecmp ("CollectConnections", child->key) == 0)
561 cf_util_get_boolean (child, &conf->collect_connections);
562 else if (strcasecmp ("CollectESI", child->key) == 0)
563 cf_util_get_boolean (child, &conf->collect_esi);
564 else if (strcasecmp ("CollectBackend", child->key) == 0)
565 cf_util_get_boolean (child, &conf->collect_backend);
566 else if (strcasecmp ("CollectFetch", child->key) == 0)
567 cf_util_get_boolean (child, &conf->collect_fetch);
568 else if (strcasecmp ("CollectHCB", child->key) == 0)
569 cf_util_get_boolean (child, &conf->collect_hcb);
570 else if (strcasecmp ("CollectSHM", child->key) == 0)
571 cf_util_get_boolean (child, &conf->collect_shm);
572 else if (strcasecmp ("CollectSMS", child->key) == 0)
573 cf_util_get_boolean (child, &conf->collect_sms);
575 else if (strcasecmp ("CollectSMA", child->key) == 0)
576 cf_util_get_boolean (child, &conf->collect_sma);
577 else if (strcasecmp ("CollectSM", child->key) == 0)
578 cf_util_get_boolean (child, &conf->collect_sm);
580 else if (strcasecmp ("CollectTotals", child->key) == 0)
581 cf_util_get_boolean (child, &conf->collect_totals);
582 else if (strcasecmp ("CollectWorkers", child->key) == 0)
583 cf_util_get_boolean (child, &conf->collect_workers);
586 WARNING ("Varnish plugin: Ignoring unknown "
587 "configuration option: \"%s\"",
592 if (!conf->collect_cache
593 && !conf->collect_connections
594 && !conf->collect_esi
595 && !conf->collect_backend
596 && !conf->collect_fetch
597 && !conf->collect_hcb
598 && !conf->collect_shm
599 && !conf->collect_sms
601 && !conf->collect_sma
604 && !conf->collect_totals
605 && !conf->collect_workers)
607 WARNING ("Varnish plugin: No metric has been configured for "
608 "instance \"%s\". Disabling this instance.",
609 (conf->instance == NULL) ? "localhost" : conf->instance);
613 ssnprintf (callback_name, sizeof (callback_name), "varnish/%s",
614 (conf->instance == NULL) ? "localhost" : conf->instance);
617 ud.free_func = varnish_config_free;
619 plugin_register_complex_read (/* group = */ "varnish",
620 /* name = */ callback_name,
621 /* callback = */ varnish_read,
622 /* interval = */ NULL,
623 /* user data = */ &ud);
628 } /* }}} int varnish_config_instance */
630 static int varnish_config (oconfig_item_t *ci) /* {{{ */
634 for (i = 0; i < ci->children_num; i++)
636 oconfig_item_t *child = ci->children + i;
638 if (strcasecmp ("Instance", child->key) == 0)
639 varnish_config_instance (child);
642 WARNING ("Varnish plugin: Ignoring unknown "
643 "configuration option: \"%s\"",
649 } /* }}} int varnish_config */
651 void module_register (void) /* {{{ */
653 plugin_register_complex_config ("varnish", varnish_config);
654 plugin_register_init ("varnish", varnish_init);
657 /* vim: set sw=8 noet fdm=marker : */