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 * Jerome Renard <jerome.renard@gmail.com>
23 * Current list of what is monitored and what is not monitored (yet)
25 * Field name Description Monitored
26 * ---------- ----------- ---------
27 * uptime Child uptime N
28 * client_conn Client connections accepted Y
29 * client_drop Connection dropped, no sess Y
30 * client_req Client requests received Y
31 * cache_hit Cache hits Y
32 * cache_hitpass Cache hits for pass Y
33 * cache_miss Cache misses Y
34 * backend_conn Backend conn. success Y
35 * backend_unhealthy Backend conn. not attempted Y
36 * backend_busy Backend conn. too many Y
37 * backend_fail Backend conn. failures Y
38 * backend_reuse Backend conn. reuses Y
39 * backend_toolate Backend conn. was closed Y
40 * backend_recycle Backend conn. recycles Y
41 * backend_unused Backend conn. unused Y
42 * fetch_head Fetch head Y
43 * fetch_length Fetch with Length Y
44 * fetch_chunked Fetch chunked Y
45 * fetch_eof Fetch EOF Y
46 * fetch_bad Fetch had bad headers Y
47 * fetch_close Fetch wanted close Y
48 * fetch_oldhttp Fetch pre HTTP/1.1 closed Y
49 * fetch_zero Fetch zero len Y
50 * fetch_failed Fetch failed Y
51 * n_sess_mem N struct sess_mem N
52 * n_sess N struct sess N
53 * n_object N struct object N
54 * n_vampireobject N unresurrected objects N
55 * n_objectcore N struct objectcore N
56 * n_objecthead N struct objecthead N
57 * n_smf N struct smf N
58 * n_smf_frag N small free smf N
59 * n_smf_large N large free smf N
60 * n_vbe_conn N struct vbe_conn N
61 * n_wrk N worker threads N
62 * n_wrk_create N worker threads created N
63 * n_wrk_failed N worker threads not created N
64 * n_wrk_max N worker threads limited N
65 * n_wrk_queue N queued work requests N
66 * n_wrk_overflow N overflowed work requests N
67 * n_wrk_drop N dropped work requests N
68 * n_backend N backends N
69 * n_expired N expired objects N
70 * n_lru_nuked N LRU nuked objects N
71 * n_lru_saved N LRU saved objects N
72 * n_lru_moved N LRU moved objects N
73 * n_deathrow N objects on deathrow N
74 * losthdr HTTP header overflows N
75 * n_objsendfile Objects sent with sendfile N
76 * n_objwrite Objects sent with write N
77 * n_objoverflow Objects overflowing workspace N
78 * s_sess Total Sessions N
79 * s_req Total Requests N
82 * s_fetch Total fetch N
83 * s_hdrbytes Total header bytes N
84 * s_bodybytes Total body bytes N
85 * sess_closed Session Closed N
86 * sess_pipeline Session Pipeline N
87 * sess_readahead Session Read Ahead N
88 * sess_linger Session Linger N
89 * sess_herd Session herd N
90 * shm_records SHM records Y
91 * shm_writes SHM writes Y
92 * shm_flushes SHM flushes due to overflow Y
93 * shm_cont SHM MTX contention Y
94 * shm_cycles SHM cycles through buffer Y
95 * sm_nreq allocator requests Y
96 * sm_nobj outstanding allocations Y
97 * sm_balloc bytes allocated Y
98 * sm_bfree bytes free Y
99 * sma_nreq SMA allocator requests Y
100 * sma_nobj SMA outstanding allocations Y
101 * sma_nbytes SMA outstanding bytes Y
102 * sma_balloc SMA bytes allocated Y
103 * sma_bfree SMA bytes free Y
104 * sms_nreq SMS allocator requests Y
105 * sms_nobj SMS outstanding allocations Y
106 * sms_nbytes SMS outstanding bytes Y
107 * sms_balloc SMS bytes allocated Y
108 * sms_bfree SMS bytes freed Y
109 * backend_req Backend requests made N
110 * n_vcl N vcl total N
111 * n_vcl_avail N vcl available N
112 * n_vcl_discard N vcl discarded N
113 * n_purge N total active purges N
114 * n_purge_add N new purges added N
115 * n_purge_retire N old purges deleted N
116 * n_purge_obj_test N objects tested N
117 * n_purge_re_test N regexps tested against N
118 * n_purge_dups N duplicate purges removed N
119 * hcb_nolock HCB Lookups without lock Y
120 * hcb_lock HCB Lookups with lock Y
121 * hcb_insert HCB Inserts Y
122 * esi_parse Objects ESI parsed (unlock) Y
123 * esi_errors ESI parse errors (unlock) Y
125 #include "collectd.h"
128 #include "configfile.h"
130 #include <varnish/varnishapi.h>
132 /* {{{ user_config_s */
133 struct user_config_s {
137 _Bool monitor_connections;
139 _Bool monitor_backend;
147 typedef struct user_config_s user_config_t; /* }}} */
149 static _Bool have_instance = 0;
151 static void varnish_submit (const char *plugin_instance, /* {{{ */
152 const char *type, const char *type_instance, gauge_t value)
155 value_list_t vl = VALUE_LIST_INIT;
157 values[0].gauge = value;
161 sstrncpy(vl.host , hostname_g , sizeof(vl.host));
162 sstrncpy(vl.plugin , "varnish" , sizeof(vl.plugin));
163 if (plugin_instance != NULL)
164 sstrncpy (vl.plugin_instance, plugin_instance,
165 sizeof (vl.plugin_instance));
166 sstrncpy(vl.type , type , sizeof(vl.type));
167 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
169 plugin_dispatch_values(&vl);
172 static void varnish_monitor(const user_config_t *conf, struct varnish_stats *VSL_stats) /* {{{ */
174 if(conf->monitor_cache)
176 varnish_submit (conf->instance, "varnish_cache_ratio", "cache_hit" , VSL_stats->cache_hit); /* Cache hits */
177 varnish_submit (conf->instance, "varnish_cache_ratio", "cache_miss" , VSL_stats->cache_miss); /* Cache misses */
178 varnish_submit (conf->instance, "varnish_cache_ratio", "cache_hitpass", VSL_stats->cache_hitpass); /* Cache hits for pass */
181 if(conf->monitor_connections)
183 varnish_submit (conf->instance, "varnish_connections", "client_connections-accepted", VSL_stats->client_conn); /* Client connections accepted */
184 varnish_submit (conf->instance, "varnish_connections", "client_connections-dropped" , VSL_stats->client_drop); /* Connection dropped, no sess */
185 varnish_submit (conf->instance, "varnish_connections", "client_connections-received", VSL_stats->client_req); /* Client requests received */
188 if(conf->monitor_esi)
190 varnish_submit (conf->instance, "varnish_esi", "esi_parsed", VSL_stats->esi_parse); /* Objects ESI parsed (unlock) */
191 varnish_submit (conf->instance, "varnish_esi", "esi_errors", VSL_stats->esi_errors); /* ESI parse errors (unlock) */
194 if(conf->monitor_backend)
196 varnish_submit (conf->instance, "varnish_backend_connections", "backend_connections-success" , VSL_stats->backend_conn); /* Backend conn. success */
197 varnish_submit (conf->instance, "varnish_backend_connections", "backend_connections-not-attempted", VSL_stats->backend_unhealthy); /* Backend conn. not attempted */
198 varnish_submit (conf->instance, "varnish_backend_connections", "backend_connections-too-many" , VSL_stats->backend_busy); /* Backend conn. too many */
199 varnish_submit (conf->instance, "varnish_backend_connections", "backend_connections-failures" , VSL_stats->backend_fail); /* Backend conn. failures */
200 varnish_submit (conf->instance, "varnish_backend_connections", "backend_connections-reuses" , VSL_stats->backend_reuse); /* Backend conn. reuses */
201 varnish_submit (conf->instance, "varnish_backend_connections", "backend_connections-was-closed" , VSL_stats->backend_toolate); /* Backend conn. was closed */
202 varnish_submit (conf->instance, "varnish_backend_connections", "backend_connections-recycles" , VSL_stats->backend_recycle); /* Backend conn. recycles */
203 varnish_submit (conf->instance, "varnish_backend_connections", "backend_connections-unused" , VSL_stats->backend_unused); /* Backend conn. unused */
206 if(conf->monitor_fetch)
208 varnish_submit (conf->instance, "varnish_fetch", "fetch_head" , VSL_stats->fetch_head); /* Fetch head */
209 varnish_submit (conf->instance, "varnish_fetch", "fetch_length" , VSL_stats->fetch_length); /* Fetch with length */
210 varnish_submit (conf->instance, "varnish_fetch", "fetch_chunked" , VSL_stats->fetch_chunked); /* Fetch chunked */
211 varnish_submit (conf->instance, "varnish_fetch", "fetch_eof" , VSL_stats->fetch_eof); /* Fetch EOF */
212 varnish_submit (conf->instance, "varnish_fetch", "fetch_bad-headers", VSL_stats->fetch_bad); /* Fetch bad headers */
213 varnish_submit (conf->instance, "varnish_fetch", "fetch_close" , VSL_stats->fetch_close); /* Fetch wanted close */
214 varnish_submit (conf->instance, "varnish_fetch", "fetch_oldhttp" , VSL_stats->fetch_oldhttp); /* Fetch pre HTTP/1.1 closed */
215 varnish_submit (conf->instance, "varnish_fetch", "fetch_zero" , VSL_stats->fetch_zero); /* Fetch zero len */
216 varnish_submit (conf->instance, "varnish_fetch", "fetch_failed" , VSL_stats->fetch_failed); /* Fetch failed */
219 if(conf->monitor_hcb)
221 varnish_submit (conf->instance, "varnish_hcb", "hcb_nolock", VSL_stats->hcb_nolock); /* HCB Lookups without lock */
222 varnish_submit (conf->instance, "varnish_hcb", "hcb_lock" , VSL_stats->hcb_lock); /* HCB Lookups with lock */
223 varnish_submit (conf->instance, "varnish_hcb", "hcb_insert", VSL_stats->hcb_insert); /* HCB Inserts */
226 if(conf->monitor_shm)
228 varnish_submit (conf->instance, "varnish_shm", "shm_records" , VSL_stats->shm_records); /* SHM records */
229 varnish_submit (conf->instance, "varnish_shm", "shm_writes" , VSL_stats->shm_writes); /* SHM writes */
230 varnish_submit (conf->instance, "varnish_shm", "shm_flushes" , VSL_stats->shm_flushes); /* SHM flushes due to overflow */
231 varnish_submit (conf->instance, "varnish_shm", "shm_contention", VSL_stats->shm_cont); /* SHM MTX contention */
232 varnish_submit (conf->instance, "varnish_shm", "shm_cycles" , VSL_stats->shm_cycles); /* SHM cycles through buffer */
235 if(conf->monitor_sma)
237 varnish_submit (conf->instance, "varnish_sma", "sma_req" , VSL_stats->sma_nreq); /* SMA allocator requests */
238 varnish_submit (conf->instance, "varnish_sma", "sma_nobj" , VSL_stats->sma_nobj); /* SMA outstanding allocations */
239 varnish_submit (conf->instance, "varnish_sma", "sma_nbytes", VSL_stats->sma_nbytes); /* SMA outstanding bytes */
240 varnish_submit (conf->instance, "varnish_sma", "sma_balloc", VSL_stats->sma_balloc); /* SMA bytes allocated */
241 varnish_submit (conf->instance, "varnish_sma", "sma_bfree" , VSL_stats->sma_bfree); /* SMA bytes free */
244 if(conf->monitor_sms)
246 varnish_submit (conf->instance, "varnish_sms", "sms_nreq" , VSL_stats->sms_nreq); /* SMS allocator requests */
247 varnish_submit (conf->instance, "varnish_sms", "sms_nobj" , VSL_stats->sms_nobj); /* SMS outstanding allocations */
248 varnish_submit (conf->instance, "varnish_sms", "sms_nbytes", VSL_stats->sms_nbytes); /* SMS outstanding bytes */
249 varnish_submit (conf->instance, "varnish_sms", "sms_balloc", VSL_stats->sms_balloc); /* SMS bytes allocated */
250 varnish_submit (conf->instance, "varnish_sms", "sms_bfree" , VSL_stats->sms_bfree); /* SMS bytes freed */
255 varnish_submit (conf->instance, "varnish_sm", "sm_nreq" , VSL_stats->sm_nreq); /* allocator requests */
256 varnish_submit (conf->instance, "varnish_sm", "sm_nobj" , VSL_stats->sm_nobj); /* outstanding allocations */
257 varnish_submit (conf->instance, "varnish_sm", "sm_balloc", VSL_stats->sm_balloc); /* bytes allocated */
258 varnish_submit (conf->instance, "varnish_sm", "sm_bfree" , VSL_stats->sm_bfree); /* bytes free */
262 static int varnish_read(user_data_t *ud) /* {{{ */
264 struct varnish_stats *VSL_stats;
267 if ((ud == NULL) || (ud->data == NULL))
272 VSL_stats = VSL_OpenStats(conf->instance);
273 if (VSL_stats == NULL)
275 ERROR("Varnish plugin : unable to load statistics");
280 varnish_monitor(conf, VSL_stats);
285 static void varnish_config_free (void *ptr) /* {{{ */
287 user_config_t *conf = ptr;
292 sfree (conf->instance);
296 static int varnish_init (void) /* {{{ */
304 conf = malloc (sizeof (*conf));
307 memset (conf, 0, sizeof (*conf));
309 /* Default settings: */
310 conf->instance = NULL;
311 conf->monitor_cache = 1;
312 conf->monitor_backend = 1;
313 conf->monitor_connections = 1;
314 conf->monitor_shm = 1;
317 ud.free_func = varnish_config_free;
319 plugin_register_complex_read (/* group = */ "varnish",
320 /* name = */ "varnish/localhost",
321 /* callback = */ varnish_read,
322 /* interval = */ NULL,
323 /* user data = */ &ud);
326 } /* }}} int varnish_init */
328 static int varnish_config_instance (const oconfig_item_t *ci) /* {{{ */
332 char callback_name[DATA_MAX_NAME_LEN];
335 conf = malloc (sizeof (*conf));
338 memset (conf, 0, sizeof (*conf));
339 conf->instance = NULL;
341 if (ci->values_num == 1)
345 status = cf_util_get_string (ci, &conf->instance);
351 assert (conf->instance != NULL);
353 if (strcmp ("localhost", conf->instance) == 0)
355 sfree (conf->instance);
356 conf->instance = NULL;
359 else if (ci->values_num > 1)
361 WARNING ("Varnish plugin: \"Instance\" blocks accept only "
366 for (i = 0; i < ci->children_num; i++)
368 oconfig_item_t *child = ci->children + i;
370 if (strcasecmp ("CollectCache", child->key) == 0)
371 cf_util_get_boolean (child, &conf->monitor_cache);
372 else if (strcasecmp ("CollectConnections", child->key) == 0)
373 cf_util_get_boolean (child, &conf->monitor_connections);
374 else if (strcasecmp ("CollectESI", child->key) == 0)
375 cf_util_get_boolean (child, &conf->monitor_esi);
376 else if (strcasecmp ("CollectBackend", child->key) == 0)
377 cf_util_get_boolean (child, &conf->monitor_backend);
378 else if (strcasecmp ("CollectFetch", child->key) == 0)
379 cf_util_get_boolean (child, &conf->monitor_fetch);
380 else if (strcasecmp ("CollectHCB", child->key) == 0)
381 cf_util_get_boolean (child, &conf->monitor_hcb);
382 else if (strcasecmp ("CollectSHM", child->key) == 0)
383 cf_util_get_boolean (child, &conf->monitor_shm);
384 else if (strcasecmp ("CollectSMA", child->key) == 0)
385 cf_util_get_boolean (child, &conf->monitor_sma);
386 else if (strcasecmp ("CollectSMS", child->key) == 0)
387 cf_util_get_boolean (child, &conf->monitor_sms);
388 else if (strcasecmp ("CollectSM", child->key) == 0)
389 cf_util_get_boolean (child, &conf->monitor_sm);
392 WARNING ("Varnish plugin: Ignoring unknown "
393 "configuration option: \"%s\"",
398 if (!conf->monitor_cache
399 && !conf->monitor_connections
400 && !conf->monitor_esi
401 && !conf->monitor_backend
402 && !conf->monitor_fetch
403 && !conf->monitor_hcb
404 && !conf->monitor_shm
405 && !conf->monitor_sma
406 && !conf->monitor_sms
407 && !conf->monitor_sm)
409 WARNING ("Varnish plugin: No metric has been configured for "
410 "instance \"%s\". Disabling this instance.",
411 (conf->instance == NULL) ? "localhost" : conf->instance);
415 ssnprintf (callback_name, sizeof (callback_name), "varnish/%s",
416 (conf->instance == NULL) ? "localhost" : conf->instance);
419 ud.free_func = varnish_config_free;
421 plugin_register_complex_read (/* group = */ "varnish",
422 /* name = */ callback_name,
423 /* callback = */ varnish_read,
424 /* interval = */ NULL,
425 /* user data = */ &ud);
430 } /* }}} int varnish_config_instance */
432 static int varnish_config (oconfig_item_t *ci) /* {{{ */
436 for (i = 0; i < ci->children_num; i++)
438 oconfig_item_t *child = ci->children + i;
440 if (strcasecmp ("Instance", child->key) == 0)
441 varnish_config_instance (child);
444 WARNING ("Varnish plugin: Ignoring unknown "
445 "configuration option: \"%s\"",
451 } /* }}} int varnish_config */
453 void module_register (void) /* {{{ */
455 plugin_register_complex_config("varnish", varnish_config);
456 plugin_register_init ("varnish", varnish_init);
459 /* vim: set sw=8 noet fdm=marker : */