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>
138 # include <varnish/vsc.h>
139 typedef struct VSC_C_main c_varnish_stats_t;
143 typedef struct varnish_stats c_varnish_stats_t;
146 /* {{{ user_config_s */
147 struct user_config_s {
151 _Bool collect_connections;
153 _Bool collect_backend;
162 _Bool collect_totals;
163 _Bool collect_workers;
165 typedef struct user_config_s user_config_t; /* }}} */
167 static _Bool have_instance = 0;
169 static int varnish_submit (const char *plugin_instance, /* {{{ */
170 const char *category, const char *type, const char *type_instance, value_t value)
172 value_list_t vl = VALUE_LIST_INIT;
177 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
179 sstrncpy (vl.plugin, "varnish", sizeof (vl.plugin));
181 if (plugin_instance == NULL)
182 plugin_instance = "default";
184 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
185 "%s-%s", plugin_instance, category);
187 sstrncpy (vl.type, type, sizeof (vl.type));
189 if (type_instance != NULL)
190 sstrncpy (vl.type_instance, type_instance,
191 sizeof (vl.type_instance));
193 return (plugin_dispatch_values (&vl));
194 } /* }}} int varnish_submit */
196 static int varnish_submit_gauge (const char *plugin_instance, /* {{{ */
197 const char *category, const char *type, const char *type_instance,
198 uint64_t gauge_value)
202 value.gauge = (gauge_t) gauge_value;
204 return (varnish_submit (plugin_instance, category, type, type_instance, value));
205 } /* }}} int varnish_submit_gauge */
207 static int varnish_submit_derive (const char *plugin_instance, /* {{{ */
208 const char *category, const char *type, const char *type_instance,
209 uint64_t derive_value)
213 value.derive = (derive_t) derive_value;
215 return (varnish_submit (plugin_instance, category, type, type_instance, value));
216 } /* }}} int varnish_submit_derive */
218 static void varnish_monitor (const user_config_t *conf, /* {{{ */
219 const c_varnish_stats_t *stats)
221 if (conf->collect_cache)
224 varnish_submit_derive (conf->instance, "cache", "cache_result", "hit", stats->cache_hit);
226 varnish_submit_derive (conf->instance, "cache", "cache_result", "miss", stats->cache_miss);
227 /* Cache hits for pass */
228 varnish_submit_derive (conf->instance, "cache", "cache_result", "hitpass", stats->cache_hitpass);
231 if (conf->collect_connections)
233 /* Client connections accepted */
234 varnish_submit_derive (conf->instance, "connections", "connections", "accepted", stats->client_conn);
235 /* Connection dropped, no sess */
236 varnish_submit_derive (conf->instance, "connections", "connections", "dropped" , stats->client_drop);
237 /* Client requests received */
238 varnish_submit_derive (conf->instance, "connections", "connections", "received", stats->client_req);
241 if (conf->collect_esi)
243 /* ESI parse errors (unlock) */
244 varnish_submit_derive (conf->instance, "esi", "total_operations", "error", stats->esi_errors);
246 /* Objects ESI parsed (unlock) */
247 varnish_submit_derive (conf->instance, "esi", "total_operations", "parsed", stats->esi_parse);
251 if (conf->collect_backend)
253 /* Backend conn. success */
254 varnish_submit_derive (conf->instance, "backend", "connections", "success" , stats->backend_conn);
255 /* Backend conn. not attempted */
256 varnish_submit_derive (conf->instance, "backend", "connections", "not-attempted", stats->backend_unhealthy);
257 /* Backend conn. too many */
258 varnish_submit_derive (conf->instance, "backend", "connections", "too-many" , stats->backend_busy);
259 /* Backend conn. failures */
260 varnish_submit_derive (conf->instance, "backend", "connections", "failures" , stats->backend_fail);
261 /* Backend conn. reuses */
262 varnish_submit_derive (conf->instance, "backend", "connections", "reuses" , stats->backend_reuse);
263 /* Backend conn. was closed */
264 varnish_submit_derive (conf->instance, "backend", "connections", "was-closed" , stats->backend_toolate);
265 /* Backend conn. recycles */
266 varnish_submit_derive (conf->instance, "backend", "connections", "recycled" , stats->backend_recycle);
268 /* Backend conn. unused */
269 varnish_submit_derive (conf->instance, "backend", "connections", "unused" , stats->backend_unused);
273 if (conf->collect_fetch)
276 varnish_submit_derive (conf->instance, "fetch", "http_requests", "head" , stats->fetch_head);
277 /* Fetch with length */
278 varnish_submit_derive (conf->instance, "fetch", "http_requests", "length" , stats->fetch_length);
280 varnish_submit_derive (conf->instance, "fetch", "http_requests", "chunked" , stats->fetch_chunked);
282 varnish_submit_derive (conf->instance, "fetch", "http_requests", "eof" , stats->fetch_eof);
283 /* Fetch bad headers */
284 varnish_submit_derive (conf->instance, "fetch", "http_requests", "bad_headers", stats->fetch_bad);
285 /* Fetch wanted close */
286 varnish_submit_derive (conf->instance, "fetch", "http_requests", "close" , stats->fetch_close);
287 /* Fetch pre HTTP/1.1 closed */
288 varnish_submit_derive (conf->instance, "fetch", "http_requests", "oldhttp" , stats->fetch_oldhttp);
290 varnish_submit_derive (conf->instance, "fetch", "http_requests", "zero" , stats->fetch_zero);
292 varnish_submit_derive (conf->instance, "fetch", "http_requests", "failed" , stats->fetch_failed);
295 if (conf->collect_hcb)
297 /* HCB Lookups without lock */
298 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "lookup_nolock", stats->hcb_nolock);
299 /* HCB Lookups with lock */
300 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "lookup_lock", stats->hcb_lock);
302 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "insert", stats->hcb_insert);
305 if (conf->collect_shm)
308 varnish_submit_derive (conf->instance, "shm", "total_operations", "records" , stats->shm_records);
310 varnish_submit_derive (conf->instance, "shm", "total_operations", "writes" , stats->shm_writes);
311 /* SHM flushes due to overflow */
312 varnish_submit_derive (conf->instance, "shm", "total_operations", "flushes" , stats->shm_flushes);
313 /* SHM MTX contention */
314 varnish_submit_derive (conf->instance, "shm", "total_operations", "contention", stats->shm_cont);
315 /* SHM cycles through buffer */
316 varnish_submit_derive (conf->instance, "shm", "total_operations", "cycles" , stats->shm_cycles);
320 if (conf->collect_sm)
322 /* allocator requests */
323 varnish_submit_derive (conf->instance, "sm", "total_requests", "nreq", stats->sm_nreq);
324 /* outstanding allocations */
325 varnish_submit_gauge (conf->instance, "sm", "requests", "outstanding", stats->sm_nobj);
326 /* bytes allocated */
327 varnish_submit_derive (conf->instance, "sm", "total_bytes", "allocated", stats->sm_balloc);
329 varnish_submit_derive (conf->instance, "sm", "total_bytes", "free", stats->sm_bfree);
332 if (conf->collect_sma)
334 /* SMA allocator requests */
335 varnish_submit_derive (conf->instance, "sma", "total_requests", "nreq", stats->sma_nreq);
336 /* SMA outstanding allocations */
337 varnish_submit_gauge (conf->instance, "sma", "requests", "outstanding", stats->sma_nobj);
338 /* SMA outstanding bytes */
339 varnish_submit_gauge (conf->instance, "sma", "bytes", "outstanding", stats->sma_nbytes);
340 /* SMA bytes allocated */
341 varnish_submit_derive (conf->instance, "sma", "total_bytes", "allocated", stats->sma_balloc);
343 varnish_submit_derive (conf->instance, "sma", "total_bytes", "free" , stats->sma_bfree);
347 if (conf->collect_sms)
349 /* SMS allocator requests */
350 varnish_submit_derive (conf->instance, "sms", "total_requests", "allocator", stats->sms_nreq);
351 /* SMS outstanding allocations */
352 varnish_submit_gauge (conf->instance, "sms", "requests", "outstanding", stats->sms_nobj);
353 /* SMS outstanding bytes */
354 varnish_submit_gauge (conf->instance, "sms", "bytes", "outstanding", stats->sms_nbytes);
355 /* SMS bytes allocated */
356 varnish_submit_derive (conf->instance, "sms", "total_bytes", "allocated", stats->sms_balloc);
357 /* SMS bytes freed */
358 varnish_submit_derive (conf->instance, "sms", "total_bytes", "free", stats->sms_bfree);
361 if (conf->collect_totals)
364 varnish_submit_derive (conf->instance, "totals", "total_sessions", "sessions", stats->s_sess);
366 varnish_submit_derive (conf->instance, "totals", "total_requests", "requests", stats->s_req);
368 varnish_submit_derive (conf->instance, "totals", "total_operations", "pipe", stats->s_pipe);
370 varnish_submit_derive (conf->instance, "totals", "total_operations", "pass", stats->s_pass);
372 varnish_submit_derive (conf->instance, "totals", "total_operations", "fetches", stats->s_fetch);
373 /* Total header bytes */
374 varnish_submit_derive (conf->instance, "totals", "total_bytes", "header-bytes", stats->s_hdrbytes);
375 /* Total body byte */
376 varnish_submit_derive (conf->instance, "totals", "total_bytes", "body-bytes", stats->s_bodybytes);
379 if (conf->collect_workers)
382 varnish_submit_gauge (conf->instance, "workers", "threads", "worker", stats->n_wrk);
383 /* worker threads created */
384 varnish_submit_derive (conf->instance, "workers", "total_threads", "created", stats->n_wrk_create);
385 /* worker threads not created */
386 varnish_submit_derive (conf->instance, "workers", "total_threads", "failed", stats->n_wrk_failed);
387 /* worker threads limited */
388 varnish_submit_derive (conf->instance, "workers", "total_threads", "limited", stats->n_wrk_max);
389 /* dropped work requests */
390 varnish_submit_derive (conf->instance, "workers", "total_requests", "dropped", stats->n_wrk_drop);
391 #ifdef HAVE_VARNISH_V2
392 /* queued work requests */
393 varnish_submit_derive (conf->instance, "workers", "total_requests", "queued", stats->n_wrk_queue);
394 /* overflowed work requests */
395 varnish_submit_derive (conf->instance, "workers", "total_requests", "overflowed", stats->n_wrk_overflow);
398 } /* }}} void varnish_monitor */
401 static int varnish_read (user_data_t *ud) /* {{{ */
404 const c_varnish_stats_t *stats;
408 if ((ud == NULL) || (ud->data == NULL))
415 if (VSC_Open (vd, /* diag = */ 1))
417 ERROR ("varnish plugin: Unable to load statistics.");
422 stats = VSC_Main(vd);
424 varnish_monitor (conf, stats);
429 #else /* if HAVE_VARNISH_V2 */
430 static int varnish_read (user_data_t *ud) /* {{{ */
432 const c_varnish_stats_t *stats;
436 if ((ud == NULL) || (ud->data == NULL))
441 stats = VSL_OpenStats (conf->instance);
444 ERROR ("Varnish plugin : unable to load statistics");
449 varnish_monitor (conf, stats);
455 static void varnish_config_free (void *ptr) /* {{{ */
457 user_config_t *conf = ptr;
462 sfree (conf->instance);
466 static int varnish_config_apply_default (user_config_t *conf) /* {{{ */
471 conf->collect_backend = 1;
472 conf->collect_cache = 1;
473 conf->collect_connections = 1;
474 conf->collect_esi = 0;
475 conf->collect_fetch = 0;
476 conf->collect_hcb = 0;
477 conf->collect_shm = 1;
479 conf->collect_sm = 0;
480 conf->collect_sma = 0;
482 conf->collect_sms = 0;
483 conf->collect_totals = 0;
486 } /* }}} int varnish_config_apply_default */
488 static int varnish_init (void) /* {{{ */
496 conf = malloc (sizeof (*conf));
499 memset (conf, 0, sizeof (*conf));
501 /* Default settings: */
502 conf->instance = NULL;
504 varnish_config_apply_default (conf);
507 ud.free_func = varnish_config_free;
509 plugin_register_complex_read (/* group = */ "varnish",
510 /* name = */ "varnish/localhost",
511 /* callback = */ varnish_read,
512 /* interval = */ NULL,
513 /* user data = */ &ud);
516 } /* }}} int varnish_init */
518 static int varnish_config_instance (const oconfig_item_t *ci) /* {{{ */
522 char callback_name[DATA_MAX_NAME_LEN];
525 conf = malloc (sizeof (*conf));
528 memset (conf, 0, sizeof (*conf));
529 conf->instance = NULL;
531 varnish_config_apply_default (conf);
533 if (ci->values_num == 1)
537 status = cf_util_get_string (ci, &conf->instance);
543 assert (conf->instance != NULL);
545 if (strcmp ("localhost", conf->instance) == 0)
547 sfree (conf->instance);
548 conf->instance = NULL;
551 else if (ci->values_num > 1)
553 WARNING ("Varnish plugin: \"Instance\" blocks accept only "
558 for (i = 0; i < ci->children_num; i++)
560 oconfig_item_t *child = ci->children + i;
562 if (strcasecmp ("CollectCache", child->key) == 0)
563 cf_util_get_boolean (child, &conf->collect_cache);
564 else if (strcasecmp ("CollectConnections", child->key) == 0)
565 cf_util_get_boolean (child, &conf->collect_connections);
566 else if (strcasecmp ("CollectESI", child->key) == 0)
567 cf_util_get_boolean (child, &conf->collect_esi);
568 else if (strcasecmp ("CollectBackend", child->key) == 0)
569 cf_util_get_boolean (child, &conf->collect_backend);
570 else if (strcasecmp ("CollectFetch", child->key) == 0)
571 cf_util_get_boolean (child, &conf->collect_fetch);
572 else if (strcasecmp ("CollectHCB", child->key) == 0)
573 cf_util_get_boolean (child, &conf->collect_hcb);
574 else if (strcasecmp ("CollectSHM", child->key) == 0)
575 cf_util_get_boolean (child, &conf->collect_shm);
576 else if (strcasecmp ("CollectSMS", child->key) == 0)
577 cf_util_get_boolean (child, &conf->collect_sms);
579 else if (strcasecmp ("CollectSMA", child->key) == 0)
580 cf_util_get_boolean (child, &conf->collect_sma);
581 else if (strcasecmp ("CollectSM", child->key) == 0)
582 cf_util_get_boolean (child, &conf->collect_sm);
584 else if (strcasecmp ("CollectTotals", child->key) == 0)
585 cf_util_get_boolean (child, &conf->collect_totals);
586 else if (strcasecmp ("CollectWorkers", child->key) == 0)
587 cf_util_get_boolean (child, &conf->collect_workers);
590 WARNING ("Varnish plugin: Ignoring unknown "
591 "configuration option: \"%s\"",
596 if (!conf->collect_cache
597 && !conf->collect_connections
598 && !conf->collect_esi
599 && !conf->collect_backend
600 && !conf->collect_fetch
601 && !conf->collect_hcb
602 && !conf->collect_shm
603 && !conf->collect_sms
605 && !conf->collect_sma
608 && !conf->collect_totals
609 && !conf->collect_workers)
611 WARNING ("Varnish plugin: No metric has been configured for "
612 "instance \"%s\". Disabling this instance.",
613 (conf->instance == NULL) ? "localhost" : conf->instance);
617 ssnprintf (callback_name, sizeof (callback_name), "varnish/%s",
618 (conf->instance == NULL) ? "localhost" : conf->instance);
621 ud.free_func = varnish_config_free;
623 plugin_register_complex_read (/* group = */ "varnish",
624 /* name = */ callback_name,
625 /* callback = */ varnish_read,
626 /* interval = */ NULL,
627 /* user data = */ &ud);
632 } /* }}} int varnish_config_instance */
634 static int varnish_config (oconfig_item_t *ci) /* {{{ */
638 for (i = 0; i < ci->children_num; i++)
640 oconfig_item_t *child = ci->children + i;
642 if (strcasecmp ("Instance", child->key) == 0)
643 varnish_config_instance (child);
646 WARNING ("Varnish plugin: Ignoring unknown "
647 "configuration option: \"%s\"",
653 } /* }}} int varnish_config */
655 void module_register (void) /* {{{ */
657 plugin_register_complex_config ("varnish", varnish_config);
658 plugin_register_init ("varnish", varnish_init);
661 /* vim: set sw=8 noet fdm=marker : */