src/varnish.c

   1 /**
   2  * collectd - src/varnish.c
   3  * Copyright (C) 2010      Jérôme Renard
   4  * Copyright (C) 2010      Marc Fournier
   5  * Copyright (C) 2010-2012 Florian Forster
   6  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * Authors:
  21  *   Jérôme Renard <jerome.renard at gmail.com>
  22  *   Marc Fournier <marc.fournier at camptocamp.com>
  23  *   Florian octo Forster <octo at collectd.org>
  24  **/
  25
  26 #include "collectd.h"
  27 #include "common.h"
  28 #include "plugin.h"
  29 #include "configfile.h"
  30
  31 #if HAVE_VARNISH_V4
  32 #include <varnish/vapi/vsm.h>
  33 #include <varnish/vapi/vsc.h>
  34 typedef struct VSC_C_main c_varnish_stats_t;
  35 #endif
  36
  37 #if HAVE_VARNISH_V3
  38 #include <varnish/varnishapi.h>
  39 #include <varnish/vsc.h>
  40 typedef struct VSC_C_main c_varnish_stats_t;
  41 #endif
  42
  43 #if HAVE_VARNISH_V2
  44 #include <varnish/varnishapi.h>
  45 typedef struct varnish_stats c_varnish_stats_t;
  46 #endif
  47
  48 /* {{{ user_config_s */
  49 struct user_config_s {
  50         char *instance;
  51
  52         _Bool collect_cache;
  53         _Bool collect_connections;
  54         _Bool collect_esi;
  55         _Bool collect_backend;
  56 #ifdef HAVE_VARNISH_V3
  57         _Bool collect_dirdns;
  58 #endif
  59         _Bool collect_fetch;
  60         _Bool collect_hcb;
  61         _Bool collect_objects;
  62 #if HAVE_VARNISH_V2
  63         _Bool collect_purge;
  64 #else
  65         _Bool collect_ban;
  66 #endif
  67         _Bool collect_session;
  68         _Bool collect_shm;
  69         _Bool collect_sms;
  70 #if HAVE_VARNISH_V2
  71         _Bool collect_sm;
  72         _Bool collect_sma;
  73 #endif
  74         _Bool collect_struct;
  75         _Bool collect_totals;
  76 #if HAVE_VARNISH_V3 || HAVE_VARNISH_V4
  77         _Bool collect_uptime;
  78 #endif
  79         _Bool collect_vcl;
  80         _Bool collect_workers;
  81 };
  82 typedef struct user_config_s user_config_t; /* }}} */
  83
  84 static _Bool have_instance = 0;
  85
  86 static int varnish_submit (const char *plugin_instance, /* {{{ */
  87                 const char *category, const char *type, const char *type_instance, value_t value)
  88 {
  89         value_list_t vl = VALUE_LIST_INIT;
  90
  91         vl.values = &value;
  92         vl.values_len = 1;
  93
  94         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
  95
  96         sstrncpy (vl.plugin, "varnish", sizeof (vl.plugin));
  97
  98         if (plugin_instance == NULL)
  99                 plugin_instance = "default";
 100
 101         ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
 102                 "%s-%s", plugin_instance, category);
 103
 104         sstrncpy (vl.type, type, sizeof (vl.type));
 105
 106         if (type_instance != NULL)
 107                 sstrncpy (vl.type_instance, type_instance,
 108                                 sizeof (vl.type_instance));
 109
 110         return (plugin_dispatch_values (&vl));
 111 } /* }}} int varnish_submit */
 112
 113 static int varnish_submit_gauge (const char *plugin_instance, /* {{{ */
 114                 const char *category, const char *type, const char *type_instance,
 115                 uint64_t gauge_value)
 116 {
 117         value_t value;
 118
 119         value.gauge = (gauge_t) gauge_value;
 120
 121         return (varnish_submit (plugin_instance, category, type, type_instance, value));
 122 } /* }}} int varnish_submit_gauge */
 123
 124 static int varnish_submit_derive (const char *plugin_instance, /* {{{ */
 125                 const char *category, const char *type, const char *type_instance,
 126                 uint64_t derive_value)
 127 {
 128         value_t value;
 129
 130         value.derive = (derive_t) derive_value;
 131
 132         return (varnish_submit (plugin_instance, category, type, type_instance, value));
 133 } /* }}} int varnish_submit_derive */
 134
 135 static void varnish_monitor (const user_config_t *conf, /* {{{ */
 136                 const c_varnish_stats_t *stats)
 137 {
 138         if (conf->collect_cache)
 139         {
 140                 /* Cache hits */
 141                 varnish_submit_derive (conf->instance, "cache", "cache_result", "hit",     stats->cache_hit);
 142                 /* Cache misses */
 143                 varnish_submit_derive (conf->instance, "cache", "cache_result", "miss",    stats->cache_miss);
 144                 /* Cache hits for pass */
 145                 varnish_submit_derive (conf->instance, "cache", "cache_result", "hitpass", stats->cache_hitpass);
 146         }
 147
 148         if (conf->collect_connections)
 149         {
 150 #ifndef HAVE_VARNISH_V4
 151                 /* Client connections accepted */
 152                 varnish_submit_derive (conf->instance, "connections", "connections", "accepted", stats->client_conn);
 153                 /* Connection dropped, no sess */
 154                 varnish_submit_derive (conf->instance, "connections", "connections", "dropped" , stats->client_drop);
 155 #endif
 156                 /* Client requests received    */
 157                 varnish_submit_derive (conf->instance, "connections", "connections", "received", stats->client_req);
 158         }
 159
 160 #ifdef HAVE_VARNISH_V3
 161         if (conf->collect_dirdns)
 162         {
 163                 /* DNS director lookups */
 164                 varnish_submit_derive (conf->instance, "dirdns", "cache_operation", "lookups",    stats->dir_dns_lookups);
 165                 /* DNS director failed lookups */
 166                 varnish_submit_derive (conf->instance, "dirdns", "cache_result",    "failed",     stats->dir_dns_failed);
 167                 /* DNS director cached lookups hit */
 168                 varnish_submit_derive (conf->instance, "dirdns", "cache_result",    "hits",       stats->dir_dns_hit);
 169                 /* DNS director full dnscache */
 170                 varnish_submit_derive (conf->instance, "dirdns", "cache_result",    "cache_full", stats->dir_dns_cache_full);
 171         }
 172 #endif
 173
 174         if (conf->collect_esi)
 175         {
 176                 /* ESI parse errors (unlock)   */
 177                 varnish_submit_derive (conf->instance, "esi", "total_operations", "error",   stats->esi_errors);
 178 #if HAVE_VARNISH_V2
 179                 /* Objects ESI parsed (unlock) */
 180                 varnish_submit_derive (conf->instance, "esi", "total_operations", "parsed",  stats->esi_parse);
 181 #else
 182                 /* ESI parse warnings (unlock) */
 183                 varnish_submit_derive (conf->instance, "esi", "total_operations", "warning", stats->esi_warnings);
 184 #endif
 185         }
 186
 187         if (conf->collect_backend)
 188         {
 189                 /* Backend conn. success       */
 190                 varnish_submit_derive (conf->instance, "backend", "connections", "success"      , stats->backend_conn);
 191                 /* Backend conn. not attempted */
 192                 varnish_submit_derive (conf->instance, "backend", "connections", "not-attempted", stats->backend_unhealthy);
 193                 /* Backend conn. too many      */
 194                 varnish_submit_derive (conf->instance, "backend", "connections", "too-many"     , stats->backend_busy);
 195                 /* Backend conn. failures      */
 196                 varnish_submit_derive (conf->instance, "backend", "connections", "failures"     , stats->backend_fail);
 197                 /* Backend conn. reuses        */
 198                 varnish_submit_derive (conf->instance, "backend", "connections", "reuses"       , stats->backend_reuse);
 199                 /* Backend conn. was closed    */
 200                 varnish_submit_derive (conf->instance, "backend", "connections", "was-closed"   , stats->backend_toolate);
 201                 /* Backend conn. recycles      */
 202                 varnish_submit_derive (conf->instance, "backend", "connections", "recycled"     , stats->backend_recycle);
 203 #if HAVE_VARNISH_V2
 204                 /* Backend conn. unused        */
 205                 varnish_submit_derive (conf->instance, "backend", "connections", "unused"       , stats->backend_unused);
 206 #else
 207                 /* Backend conn. retry         */
 208                 varnish_submit_derive (conf->instance, "backend", "connections", "retries"      , stats->backend_retry);
 209 #endif
 210                 /* Backend requests mades      */
 211                 varnish_submit_derive (conf->instance, "backend", "http_requests", "requests"   , stats->backend_req);
 212                 /* N backends                  */
 213                 varnish_submit_gauge  (conf->instance, "backend", "backends", "n_backends"      , stats->n_backend);
 214         }
 215
 216         if (conf->collect_fetch)
 217         {
 218                 /* Fetch head                */
 219                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "head"       , stats->fetch_head);
 220                 /* Fetch with length         */
 221                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "length"     , stats->fetch_length);
 222                 /* Fetch chunked             */
 223                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "chunked"    , stats->fetch_chunked);
 224                 /* Fetch EOF                 */
 225                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "eof"        , stats->fetch_eof);
 226                 /* Fetch bad headers         */
 227                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "bad_headers", stats->fetch_bad);
 228                 /* Fetch wanted close        */
 229                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "close"      , stats->fetch_close);
 230                 /* Fetch pre HTTP/1.1 closed */
 231                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "oldhttp"    , stats->fetch_oldhttp);
 232                 /* Fetch zero len            */
 233                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "zero"       , stats->fetch_zero);
 234                 /* Fetch failed              */
 235                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "failed"     , stats->fetch_failed);
 236 #if HAVE_VARNISH_V3 || HAVE_VARNISH_V4
 237                 /* Fetch no body (1xx)       */
 238                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "no_body_1xx", stats->fetch_1xx);
 239                 /* Fetch no body (204)       */
 240                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "no_body_204", stats->fetch_204);
 241                 /* Fetch no body (304)       */
 242                 varnish_submit_derive (conf->instance, "fetch", "http_requests", "no_body_304", stats->fetch_304);
 243 #endif
 244         }
 245
 246         if (conf->collect_hcb)
 247         {
 248                 /* HCB Lookups without lock */
 249                 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "lookup_nolock", stats->hcb_nolock);
 250                 /* HCB Lookups with lock    */
 251                 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "lookup_lock",   stats->hcb_lock);
 252                 /* HCB Inserts              */
 253                 varnish_submit_derive (conf->instance, "hcb", "cache_operation", "insert",        stats->hcb_insert);
 254         }
 255
 256         if (conf->collect_objects)
 257         {
 258                 /* N expired objects             */
 259                 varnish_submit_derive (conf->instance, "objects", "total_objects", "expired",            stats->n_expired);
 260                 /* N LRU nuked objects           */
 261                 varnish_submit_derive (conf->instance, "objects", "total_objects", "lru_nuked",          stats->n_lru_nuked);
 262 #if HAVE_VARNISH_V2
 263                 /* N LRU saved objects           */
 264                 varnish_submit_derive (conf->instance, "objects", "total_objects", "lru_saved",          stats->n_lru_saved);
 265 #endif
 266                 /* N LRU moved objects           */
 267                 varnish_submit_derive (conf->instance, "objects", "total_objects", "lru_moved",          stats->n_lru_moved);
 268 #if HAVE_VARNISH_V2
 269                 /* N objects on deathrow         */
 270                 varnish_submit_derive (conf->instance, "objects", "total_objects", "deathrow",           stats->n_deathrow);
 271 #endif
 272                 /* HTTP header overflows         */
 273                 varnish_submit_derive (conf->instance, "objects", "total_objects", "header_overflow",    stats->losthdr);
 274 #if !HAVE_VARNISH_V4
 275                 /* Objects sent with sendfile    */
 276                 varnish_submit_derive (conf->instance, "objects", "total_objects", "sent_sendfile",      stats->n_objsendfile);
 277                 /* Objects sent with write       */
 278                 varnish_submit_derive (conf->instance, "objects", "total_objects", "sent_write",         stats->n_objwrite);
 279                 /* Objects overflowing workspace */
 280                 varnish_submit_derive (conf->instance, "objects", "total_objects", "workspace_overflow", stats->n_objoverflow);
 281 #endif
 282         }
 283
 284 #if HAVE_VARNISH_V2
 285         if (conf->collect_purge)
 286         {
 287                 /* N total active purges      */
 288                 varnish_submit_derive (conf->instance, "purge", "total_operations", "total",            stats->n_purge);
 289                 /* N new purges added         */
 290                 varnish_submit_derive (conf->instance, "purge", "total_operations", "added",            stats->n_purge_add);
 291                 /* N old purges deleted       */
 292                 varnish_submit_derive (conf->instance, "purge", "total_operations", "deleted",          stats->n_purge_retire);
 293                 /* N objects tested           */
 294                 varnish_submit_derive (conf->instance, "purge", "total_operations", "objects_tested",   stats->n_purge_obj_test);
 295                 /* N regexps tested against   */
 296                 varnish_submit_derive (conf->instance, "purge", "total_operations", "regexps_tested",   stats->n_purge_re_test);
 297                 /* N duplicate purges removed */
 298                 varnish_submit_derive (conf->instance, "purge", "total_operations", "duplicate",        stats->n_purge_dups);
 299         }
 300 #endif
 301 #if HAVE_VARNISH_V3
 302         if (conf->collect_ban)
 303         {
 304                 /* N total active bans      */
 305                 varnish_submit_derive (conf->instance, "ban", "total_operations", "total",          stats->n_ban);
 306                 /* N new bans added         */
 307                 varnish_submit_derive (conf->instance, "ban", "total_operations", "added",          stats->n_ban_add);
 308                 /* N old bans deleted       */
 309                 varnish_submit_derive (conf->instance, "ban", "total_operations", "deleted",        stats->n_ban_retire);
 310                 /* N objects tested         */
 311                 varnish_submit_derive (conf->instance, "ban", "total_operations", "objects_tested", stats->n_ban_obj_test);
 312                 /* N regexps tested against */
 313                 varnish_submit_derive (conf->instance, "ban", "total_operations", "regexps_tested", stats->n_ban_re_test);
 314                 /* N duplicate bans removed */
 315                 varnish_submit_derive (conf->instance, "ban", "total_operations", "duplicate",      stats->n_ban_dups);
 316         }
 317 #endif
 318 #if HAVE_VARNISH_V4
 319         if (conf->collect_ban)
 320         {
 321                 /* N total active bans      */
 322                 varnish_submit_derive (conf->instance, "ban", "total_operations", "total",          stats->bans);
 323                 /* N new bans added         */
 324                 varnish_submit_derive (conf->instance, "ban", "total_operations", "added",          stats->bans_added);
 325                 /* N bans using obj */
 326                 varnish_submit_derive (conf->instance, "ban", "total_operations", "obj",            stats->bans_obj);
 327                 /* N bans using req */
 328                 varnish_submit_derive (conf->instance, "ban", "total_operations", "req",            stats->bans_req);
 329                 /* N new bans completed     */
 330                 varnish_submit_derive (conf->instance, "ban", "total_operations", "completed",      stats->bans_completed);
 331                 /* N old bans deleted       */
 332                 varnish_submit_derive (conf->instance, "ban", "total_operations", "deleted",        stats->bans_deleted);
 333                 /* N objects tested         */
 334                 varnish_submit_derive (conf->instance, "ban", "total_operations", "tested",         stats->bans_tested);
 335                 /* N duplicate bans removed */
 336                 varnish_submit_derive (conf->instance, "ban", "total_operations", "duplicate",      stats->bans_dups);
 337         }
 338 #endif
 339
 340         if (conf->collect_session)
 341         {
 342                 /* Session Closed     */
 343                 varnish_submit_derive (conf->instance, "session", "total_operations", "closed",    stats->sess_closed);
 344                 /* Session Pipeline   */
 345                 varnish_submit_derive (conf->instance, "session", "total_operations", "pipeline",  stats->sess_pipeline);
 346                 /* Session Read Ahead */
 347                 varnish_submit_derive (conf->instance, "session", "total_operations", "readahead", stats->sess_readahead);
 348 #if HAVE_VARNISH_V4
 349                 /* Sessions accepted */
 350                 varnish_submit_derive (conf->instance, "session", "total_operations", "accepted",  stats->sess_conn);
 351                 /* Sessions dropped for thread */
 352                 varnish_submit_derive (conf->instance, "session", "total_operations", "dropped",   stats->sess_drop);
 353                 /* Sessions accept failure */
 354                 varnish_submit_derive (conf->instance, "session", "total_operations", "failed",    stats->sess_fail);
 355                 /* Sessions pipe overflow */
 356                 varnish_submit_derive (conf->instance, "session", "total_operations", "overflow",  stats->sess_pipe_overflow);
 357                 /* Sessions queued for thread */
 358                 varnish_submit_derive (conf->instance, "session", "total_operations", "queued",    stats->sess_queued);
 359 #else
 360                 /* Session Linger     */
 361                 varnish_submit_derive (conf->instance, "session", "total_operations", "linger",    stats->sess_linger);
 362 #endif
 363                 /* Session herd       */
 364                 varnish_submit_derive (conf->instance, "session", "total_operations", "herd",      stats->sess_herd);
 365         }
 366
 367         if (conf->collect_shm)
 368         {
 369                 /* SHM records                 */
 370                 varnish_submit_derive (conf->instance, "shm", "total_operations", "records"   , stats->shm_records);
 371                 /* SHM writes                  */
 372                 varnish_submit_derive (conf->instance, "shm", "total_operations", "writes"    , stats->shm_writes);
 373                 /* SHM flushes due to overflow */
 374                 varnish_submit_derive (conf->instance, "shm", "total_operations", "flushes"   , stats->shm_flushes);
 375                 /* SHM MTX contention          */
 376                 varnish_submit_derive (conf->instance, "shm", "total_operations", "contention", stats->shm_cont);
 377                 /* SHM cycles through buffer   */
 378                 varnish_submit_derive (conf->instance, "shm", "total_operations", "cycles"    , stats->shm_cycles);
 379         }
 380
 381 #if HAVE_VARNISH_V2
 382         if (conf->collect_sm)
 383         {
 384                 /* allocator requests */
 385                 varnish_submit_derive (conf->instance, "sm", "total_requests", "nreq",         stats->sm_nreq);
 386                 /* outstanding allocations */
 387                 varnish_submit_gauge (conf->instance,  "sm", "requests", "outstanding",        stats->sm_nobj);
 388                 /* bytes allocated */
 389                 varnish_submit_derive (conf->instance,  "sm", "total_bytes", "allocated",      stats->sm_balloc);
 390                 /* bytes free */
 391                 varnish_submit_derive (conf->instance,  "sm", "total_bytes", "free",           stats->sm_bfree);
 392         }
 393
 394         if (conf->collect_sma)
 395         {
 396                 /* SMA allocator requests */
 397                 varnish_submit_derive (conf->instance, "sma", "total_requests", "nreq",    stats->sma_nreq);
 398                 /* SMA outstanding allocations */
 399                 varnish_submit_gauge (conf->instance,  "sma", "requests", "outstanding",   stats->sma_nobj);
 400                 /* SMA outstanding bytes */
 401                 varnish_submit_gauge (conf->instance,  "sma", "bytes", "outstanding",      stats->sma_nbytes);
 402                 /* SMA bytes allocated */
 403                 varnish_submit_derive (conf->instance,  "sma", "total_bytes", "allocated", stats->sma_balloc);
 404                 /* SMA bytes free */
 405                 varnish_submit_derive (conf->instance,  "sma", "total_bytes", "free" ,     stats->sma_bfree);
 406         }
 407 #endif
 408
 409         if (conf->collect_sms)
 410         {
 411                 /* SMS allocator requests */
 412                 varnish_submit_derive (conf->instance, "sms", "total_requests", "allocator", stats->sms_nreq);
 413                 /* SMS outstanding allocations */
 414                 varnish_submit_gauge (conf->instance,  "sms", "requests", "outstanding",     stats->sms_nobj);
 415                 /* SMS outstanding bytes */
 416                 varnish_submit_gauge (conf->instance,  "sms", "bytes", "outstanding",        stats->sms_nbytes);
 417                 /* SMS bytes allocated */
 418                 varnish_submit_derive (conf->instance,  "sms", "total_bytes", "allocated",   stats->sms_balloc);
 419                 /* SMS bytes freed */
 420                 varnish_submit_derive (conf->instance,  "sms", "total_bytes", "free",        stats->sms_bfree);
 421         }
 422
 423         if (conf->collect_struct)
 424         {
 425 #if !HAVE_VARNISH_V4
 426                 /* N struct sess_mem       */
 427                 varnish_submit_gauge (conf->instance, "struct", "current_sessions", "sess_mem",  stats->n_sess_mem);
 428                 /* N struct sess           */
 429                 varnish_submit_gauge (conf->instance, "struct", "current_sessions", "sess",      stats->n_sess);
 430 #endif
 431                 /* N struct object         */
 432                 varnish_submit_gauge (conf->instance, "struct", "objects", "object",             stats->n_object);
 433 #if HAVE_VARNISH_V3 || HAVE_VARNISH_V4
 434                 /* N unresurrected objects */
 435                 varnish_submit_gauge (conf->instance, "struct", "objects", "vampireobject",      stats->n_vampireobject);
 436                 /* N struct objectcore     */
 437                 varnish_submit_gauge (conf->instance, "struct", "objects", "objectcore",         stats->n_objectcore);
 438 #endif
 439                 /* N struct objecthead     */
 440                 varnish_submit_gauge (conf->instance, "struct", "objects", "objecthead",         stats->n_objecthead);
 441 #ifdef HAVE_VARNISH_V2
 442                 /* N struct smf            */
 443                 varnish_submit_gauge (conf->instance, "struct", "objects", "smf",                stats->n_smf);
 444                 /* N small free smf         */
 445                 varnish_submit_gauge (conf->instance, "struct", "objects", "smf_frag",           stats->n_smf_frag);
 446                 /* N large free smf         */
 447                 varnish_submit_gauge (conf->instance, "struct", "objects", "smf_large",          stats->n_smf_large);
 448                 /* N struct vbe_conn        */
 449                 varnish_submit_gauge (conf->instance, "struct", "objects", "vbe_conn",           stats->n_vbe_conn);
 450 #endif
 451         }
 452
 453         if (conf->collect_totals)
 454         {
 455                 /* Total Sessions */
 456                 varnish_submit_derive (conf->instance, "totals", "total_sessions", "sessions",  stats->s_sess);
 457                 /* Total Requests */
 458                 varnish_submit_derive (conf->instance, "totals", "total_requests", "requests",  stats->s_req);
 459                 /* Total pipe */
 460                 varnish_submit_derive (conf->instance, "totals", "total_operations", "pipe",    stats->s_pipe);
 461                 /* Total pass */
 462                 varnish_submit_derive (conf->instance, "totals", "total_operations", "pass",    stats->s_pass);
 463                 /* Total fetch */
 464                 varnish_submit_derive (conf->instance, "totals", "total_operations", "fetches", stats->s_fetch);
 465 #if HAVE_VARNISH_V4
 466                 /* Total synth */
 467                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "synth",       stats->s_synth);
 468                 /* Request header bytes */
 469                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "req_header",  stats->s_req_hdrbytes);
 470                 /* Request body byte */
 471                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "req_body",    stats->s_req_bodybytes);
 472                 /* Response header bytes */
 473                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "resp_header", stats->s_resp_hdrbytes);
 474                 /* Response body byte */
 475                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "resp_body",   stats->s_resp_bodybytes);
 476                 /* Pipe request header bytes */
 477                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "pipe_header", stats->s_pipe_hdrbytes);
 478                 /* Piped bytes from client */
 479                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "pipe_in",     stats->s_pipe_in);
 480                 /* Piped bytes to client */
 481                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "pipe_out",    stats->s_pipe_out);
 482 #else
 483                 /* Total header bytes */
 484                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "header-bytes", stats->s_hdrbytes);
 485                 /* Total body byte */
 486                 varnish_submit_derive (conf->instance, "totals", "total_bytes", "body-bytes",   stats->s_bodybytes);
 487 #endif
 488         }
 489
 490 #if HAVE_VARNISH_V3 || HAVE_VARNISH_V4
 491         if (conf->collect_uptime)
 492         {
 493                 /* Client uptime */
 494                 varnish_submit_gauge (conf->instance, "uptime", "uptime", "client_uptime", stats->uptime);
 495         }
 496 #endif
 497
 498         if (conf->collect_vcl)
 499         {
 500                 /* N vcl total     */
 501                 varnish_submit_gauge (conf->instance, "vcl", "vcl", "total_vcl",     stats->n_vcl);
 502                 /* N vcl available */
 503                 varnish_submit_gauge (conf->instance, "vcl", "vcl", "avail_vcl",     stats->n_vcl_avail);
 504                 /* N vcl discarded */
 505                 varnish_submit_gauge (conf->instance, "vcl", "vcl", "discarded_vcl", stats->n_vcl_discard);
 506         }
 507
 508         if (conf->collect_workers)
 509         {
 510 #ifdef HAVE_VARNISH_V4
 511                 /* total number of threads */
 512                 varnish_submit_gauge (conf->instance, "workers", "threads", "worker",             stats->threads);
 513                 /* threads created */
 514                 varnish_submit_derive (conf->instance, "workers", "total_threads", "created",     stats->threads_created);
 515                 /* thread creation failed */
 516                 varnish_submit_derive (conf->instance, "workers", "total_threads", "failed",      stats->threads_failed);
 517                 /* threads hit max */
 518                 varnish_submit_derive (conf->instance, "workers", "total_threads", "limited",     stats->threads_limited);
 519                 /* threads destroyed */
 520                 varnish_submit_derive (conf->instance, "workers", "total_threads", "dropped",     stats->threads_destroyed);
 521                 /* length of session queue */
 522                 varnish_submit_derive (conf->instance, "workers", "queue_length",  "threads",     stats->thread_queue_len);
 523 #else
 524                 /* worker threads */
 525                 varnish_submit_gauge (conf->instance, "workers", "threads", "worker",             stats->n_wrk);
 526                 /* worker threads created */
 527                 varnish_submit_derive (conf->instance, "workers", "total_threads", "created",     stats->n_wrk_create);
 528                 /* worker threads not created */
 529                 varnish_submit_derive (conf->instance, "workers", "total_threads", "failed",      stats->n_wrk_failed);
 530                 /* worker threads limited */
 531                 varnish_submit_derive (conf->instance, "workers", "total_threads", "limited",     stats->n_wrk_max);
 532                 /* dropped work requests */
 533                 varnish_submit_derive (conf->instance, "workers", "total_requests", "dropped",    stats->n_wrk_drop);
 534 #ifdef HAVE_VARNISH_V2
 535                 /* queued work requests */
 536                 varnish_submit_derive (conf->instance, "workers", "total_requests", "queued",     stats->n_wrk_queue);
 537                 /* overflowed work requests */
 538                 varnish_submit_derive (conf->instance, "workers", "total_requests", "overflowed", stats->n_wrk_overflow);
 539 #else /* HAVE_VARNISH_V3 */
 540                 /* queued work requests */
 541                 varnish_submit_derive (conf->instance, "workers", "total_requests", "queued",       stats->n_wrk_queued);
 542                 /* work request queue length */
 543                 varnish_submit_derive (conf->instance, "workers", "total_requests", "queue_length", stats->n_wrk_lqueue);
 544 #endif
 545 #endif
 546         }
 547 } /* }}} void varnish_monitor */
 548
 549 #if HAVE_VARNISH_V3 || HAVE_VARNISH_V4
 550 static int varnish_read (user_data_t *ud) /* {{{ */
 551 {
 552         struct VSM_data *vd;
 553         const c_varnish_stats_t *stats;
 554
 555         user_config_t *conf;
 556
 557         if ((ud == NULL) || (ud->data == NULL))
 558                 return (EINVAL);
 559
 560         conf = ud->data;
 561
 562         vd = VSM_New();
 563 #if HAVE_VARNISH_V3
 564         VSC_Setup(vd);
 565 #endif
 566
 567         if (conf->instance != NULL)
 568         {
 569                 int status;
 570
 571                 status = VSM_n_Arg (vd, conf->instance);
 572                 if (status < 0)
 573                 {
 574                         ERROR ("varnish plugin: VSM_n_Arg (\"%s\") failed "
 575                                         "with status %i.",
 576                                         conf->instance, status);
 577                         return (-1);
 578                 }
 579         }
 580
 581 #if HAVE_VARNISH_V3
 582         if (VSC_Open (vd, /* diag = */ 1))
 583 #else /* if HAVE_VARNISH_V4 */
 584         if (VSM_Open (vd))
 585 #endif
 586         {
 587                 ERROR ("varnish plugin: Unable to load statistics.");
 588
 589                 return (-1);
 590         }
 591
 592 #if HAVE_VARNISH_V3
 593         stats = VSC_Main(vd);
 594 #else /* if HAVE_VARNISH_V4 */
 595         stats = VSC_Main(vd, NULL);
 596 #endif
 597
 598         varnish_monitor (conf, stats);
 599         VSM_Close (vd);
 600
 601         return (0);
 602 } /* }}} */
 603 #else /* if HAVE_VARNISH_V2 */
 604 static int varnish_read (user_data_t *ud) /* {{{ */
 605 {
 606         const c_varnish_stats_t *stats;
 607
 608         user_config_t *conf;
 609
 610         if ((ud == NULL) || (ud->data == NULL))
 611                 return (EINVAL);
 612
 613         conf = ud->data;
 614
 615         stats = VSL_OpenStats (conf->instance);
 616         if (stats == NULL)
 617         {
 618                 ERROR ("Varnish plugin : unable to load statistics");
 619
 620                 return (-1);
 621         }
 622
 623         varnish_monitor (conf, stats);
 624
 625         return (0);
 626 } /* }}} */
 627 #endif
 628
 629 static void varnish_config_free (void *ptr) /* {{{ */
 630 {
 631         user_config_t *conf = ptr;
 632
 633         if (conf == NULL)
 634                 return;
 635
 636         sfree (conf->instance);
 637         sfree (conf);
 638 } /* }}} */
 639
 640 static int varnish_config_apply_default (user_config_t *conf) /* {{{ */
 641 {
 642         if (conf == NULL)
 643                 return (EINVAL);
 644
 645         conf->collect_backend     = 1;
 646         conf->collect_cache       = 1;
 647         conf->collect_connections = 1;
 648 #ifdef HAVE_VARNISH_V3
 649         conf->collect_dirdns      = 0;
 650 #endif
 651         conf->collect_esi         = 0;
 652         conf->collect_fetch       = 0;
 653         conf->collect_hcb         = 0;
 654         conf->collect_objects     = 0;
 655 #if HAVE_VARNISH_V2
 656         conf->collect_purge       = 0;
 657 #else
 658         conf->collect_ban         = 0;
 659 #endif
 660         conf->collect_session     = 0;
 661         conf->collect_shm         = 1;
 662 #if HAVE_VARNISH_V2
 663         conf->collect_sm          = 0;
 664         conf->collect_sma         = 0;
 665 #endif
 666         conf->collect_sms         = 0;
 667         conf->collect_struct      = 0;
 668         conf->collect_totals      = 0;
 669 #if HAVE_VARNISH_V3 || HAVE_VARNISH_V4
 670         conf->collect_uptime      = 0;
 671 #endif
 672         conf->collect_vcl         = 0;
 673         conf->collect_workers     = 0;
 674
 675         return (0);
 676 } /* }}} int varnish_config_apply_default */
 677
 678 static int varnish_init (void) /* {{{ */
 679 {
 680         user_config_t *conf;
 681         user_data_t ud;
 682
 683         if (have_instance)
 684                 return (0);
 685
 686         conf = malloc (sizeof (*conf));
 687         if (conf == NULL)
 688                 return (ENOMEM);
 689         memset (conf, 0, sizeof (*conf));
 690
 691         /* Default settings: */
 692         conf->instance = NULL;
 693
 694         varnish_config_apply_default (conf);
 695
 696         ud.data = conf;
 697         ud.free_func = varnish_config_free;
 698
 699         plugin_register_complex_read (/* group = */ "varnish",
 700                         /* name      = */ "varnish/localhost",
 701                         /* callback  = */ varnish_read,
 702                         /* interval  = */ NULL,
 703                         /* user data = */ &ud);
 704
 705         return (0);
 706 } /* }}} int varnish_init */
 707
 708 static int varnish_config_instance (const oconfig_item_t *ci) /* {{{ */
 709 {
 710         user_config_t *conf;
 711         user_data_t ud;
 712         char callback_name[DATA_MAX_NAME_LEN];
 713         int i;
 714
 715         conf = malloc (sizeof (*conf));
 716         if (conf == NULL)
 717                 return (ENOMEM);
 718         memset (conf, 0, sizeof (*conf));
 719         conf->instance = NULL;
 720
 721         varnish_config_apply_default (conf);
 722
 723         if (ci->values_num == 1)
 724         {
 725                 int status;
 726
 727                 status = cf_util_get_string (ci, &conf->instance);
 728                 if (status != 0)
 729                 {
 730                         sfree (conf);
 731                         return (status);
 732                 }
 733                 assert (conf->instance != NULL);
 734
 735                 if (strcmp ("localhost", conf->instance) == 0)
 736                 {
 737                         sfree (conf->instance);
 738                         conf->instance = NULL;
 739                 }
 740         }
 741         else if (ci->values_num > 1)
 742         {
 743                 WARNING ("Varnish plugin: \"Instance\" blocks accept only "
 744                                 "one argument.");
 745                 return (EINVAL);
 746         }
 747
 748         for (i = 0; i < ci->children_num; i++)
 749         {
 750                 oconfig_item_t *child = ci->children + i;
 751
 752                 if (strcasecmp ("CollectCache", child->key) == 0)
 753                         cf_util_get_boolean (child, &conf->collect_cache);
 754                 else if (strcasecmp ("CollectConnections", child->key) == 0)
 755                         cf_util_get_boolean (child, &conf->collect_connections);
 756                 else if (strcasecmp ("CollectESI", child->key) == 0)
 757                         cf_util_get_boolean (child, &conf->collect_esi);
 758 #ifdef HAVE_VARNISH_V3
 759                 else if (strcasecmp ("CollectDirectorDNS", child->key) == 0)
 760                         cf_util_get_boolean (child, &conf->collect_dirdns);
 761 #endif
 762                 else if (strcasecmp ("CollectBackend", child->key) == 0)
 763                         cf_util_get_boolean (child, &conf->collect_backend);
 764                 else if (strcasecmp ("CollectFetch", child->key) == 0)
 765                         cf_util_get_boolean (child, &conf->collect_fetch);
 766                 else if (strcasecmp ("CollectHCB", child->key) == 0)
 767                         cf_util_get_boolean (child, &conf->collect_hcb);
 768                 else if (strcasecmp ("CollectObjects", child->key) == 0)
 769                         cf_util_get_boolean (child, &conf->collect_objects);
 770 #if HAVE_VARNISH_V2
 771                 else if (strcasecmp ("CollectPurge", child->key) == 0)
 772                         cf_util_get_boolean (child, &conf->collect_purge);
 773 #else
 774                 else if (strcasecmp ("CollectBan", child->key) == 0)
 775                         cf_util_get_boolean (child, &conf->collect_ban);
 776 #endif
 777                 else if (strcasecmp ("CollectSession", child->key) == 0)
 778                         cf_util_get_boolean (child, &conf->collect_session);
 779                 else if (strcasecmp ("CollectSHM", child->key) == 0)
 780                         cf_util_get_boolean (child, &conf->collect_shm);
 781                 else if (strcasecmp ("CollectSMS", child->key) == 0)
 782                         cf_util_get_boolean (child, &conf->collect_sms);
 783 #if HAVE_VARNISH_V2
 784                 else if (strcasecmp ("CollectSMA", child->key) == 0)
 785                         cf_util_get_boolean (child, &conf->collect_sma);
 786                 else if (strcasecmp ("CollectSM", child->key) == 0)
 787                         cf_util_get_boolean (child, &conf->collect_sm);
 788 #endif
 789                 else if (strcasecmp ("CollectStruct", child->key) == 0)
 790                         cf_util_get_boolean (child, &conf->collect_struct);
 791                 else if (strcasecmp ("CollectTotals", child->key) == 0)
 792                         cf_util_get_boolean (child, &conf->collect_totals);
 793 #if HAVE_VARNISH_V3 || HAVE_VARNISH_V4
 794                 else if (strcasecmp ("CollectUptime", child->key) == 0)
 795                         cf_util_get_boolean (child, &conf->collect_uptime);
 796 #endif
 797                 else if (strcasecmp ("CollectVCL", child->key) == 0)
 798                         cf_util_get_boolean (child, &conf->collect_vcl);
 799                 else if (strcasecmp ("CollectWorkers", child->key) == 0)
 800                         cf_util_get_boolean (child, &conf->collect_workers);
 801                 else
 802                 {
 803                         WARNING ("Varnish plugin: Ignoring unknown "
 804                                         "configuration option: \"%s\". Did "
 805                                         "you forget to add an <Instance /> "
 806                                         "block around the configuration?",
 807                                         child->key);
 808                 }
 809         }
 810
 811         if (!conf->collect_cache
 812                         && !conf->collect_connections
 813                         && !conf->collect_esi
 814                         && !conf->collect_backend
 815 #ifdef HAVE_VARNISH_V3
 816                         && !conf->collect_dirdns
 817 #endif
 818                         && !conf->collect_fetch
 819                         && !conf->collect_hcb
 820                         && !conf->collect_objects
 821 #if HAVE_VARNISH_V2
 822                         && !conf->collect_purge
 823 #else
 824                         && !conf->collect_ban
 825 #endif
 826                         && !conf->collect_session
 827                         && !conf->collect_shm
 828                         && !conf->collect_sms
 829 #if HAVE_VARNISH_V2
 830                         && !conf->collect_sma
 831                         && !conf->collect_sm
 832 #endif
 833                         && !conf->collect_struct
 834                         && !conf->collect_totals
 835 #if HAVE_VARNISH_V3 || HAVE_VARNISH_V4
 836                         && !conf->collect_uptime
 837 #endif
 838                         && !conf->collect_vcl
 839                         && !conf->collect_workers)
 840         {
 841                 WARNING ("Varnish plugin: No metric has been configured for "
 842                                 "instance \"%s\". Disabling this instance.",
 843                                 (conf->instance == NULL) ? "localhost" : conf->instance);
 844                 return (EINVAL);
 845         }
 846
 847         ssnprintf (callback_name, sizeof (callback_name), "varnish/%s",
 848                         (conf->instance == NULL) ? "localhost" : conf->instance);
 849
 850         ud.data = conf;
 851         ud.free_func = varnish_config_free;
 852
 853         plugin_register_complex_read (/* group = */ "varnish",
 854                         /* name      = */ callback_name,
 855                         /* callback  = */ varnish_read,
 856                         /* interval  = */ NULL,
 857                         /* user data = */ &ud);
 858
 859         have_instance = 1;
 860
 861         return (0);
 862 } /* }}} int varnish_config_instance */
 863
 864 static int varnish_config (oconfig_item_t *ci) /* {{{ */
 865 {
 866         int i;
 867
 868         for (i = 0; i < ci->children_num; i++)
 869         {
 870                 oconfig_item_t *child = ci->children + i;
 871
 872                 if (strcasecmp ("Instance", child->key) == 0)
 873                         varnish_config_instance (child);
 874                 else
 875                 {
 876                         WARNING ("Varnish plugin: Ignoring unknown "
 877                                         "configuration option: \"%s\"",
 878                                         child->key);
 879                 }
 880         }
 881
 882         return (0);
 883 } /* }}} int varnish_config */
 884
 885 void module_register (void) /* {{{ */
 886 {
 887         plugin_register_complex_config ("varnish", varnish_config);
 888         plugin_register_init ("varnish", varnish_init);
 889 } /* }}} */
 890
 891 /* vim: set sw=8 noet fdm=marker : */