Varnish plugin: Make it possible to configure multiple instances.
[collectd.git] / src / varnish.c
index 14e18f1..aa20444 100644 (file)
  *   Jerome Renard <jerome.renard@gmail.com>
  **/
 
+/**
+ * Current list of what is monitored and what is not monitored (yet)
+ *
+ * Field name           Description                           Monitored
+ * ----------           -----------                           ---------
+ * uptime               Child uptime                              N
+ * client_conn          Client connections accepted               Y
+ * client_drop          Connection dropped, no sess               Y
+ * client_req           Client requests received                  Y
+ * cache_hit            Cache hits                                Y
+ * cache_hitpass        Cache hits for pass                       Y
+ * cache_miss           Cache misses                              Y
+ * backend_conn         Backend conn. success                     Y
+ * backend_unhealthy    Backend conn. not attempted               Y
+ * backend_busy         Backend conn. too many                    Y
+ * backend_fail         Backend conn. failures                    Y
+ * backend_reuse        Backend conn. reuses                      Y
+ * backend_toolate      Backend conn. was closed                  Y
+ * backend_recycle      Backend conn. recycles                    Y
+ * backend_unused       Backend conn. unused                      Y
+ * fetch_head           Fetch head                                Y
+ * fetch_length         Fetch with Length                         Y
+ * fetch_chunked        Fetch chunked                             Y
+ * fetch_eof            Fetch EOF                                 Y
+ * fetch_bad            Fetch had bad headers                     Y
+ * fetch_close          Fetch wanted close                        Y
+ * fetch_oldhttp        Fetch pre HTTP/1.1 closed                 Y
+ * fetch_zero           Fetch zero len                            Y
+ * fetch_failed         Fetch failed                              Y
+ * n_sess_mem           N struct sess_mem                         N
+ * n_sess               N struct sess                             N
+ * n_object             N struct object                           N
+ * n_vampireobject      N unresurrected objects                   N
+ * n_objectcore         N struct objectcore                       N
+ * n_objecthead         N struct objecthead                       N
+ * n_smf                N struct smf                              N
+ * n_smf_frag           N small free smf                          N
+ * n_smf_large          N large free smf                          N
+ * n_vbe_conn           N struct vbe_conn                         N
+ * n_wrk                N worker threads                          N
+ * n_wrk_create         N worker threads created                  N
+ * n_wrk_failed         N worker threads not created              N
+ * n_wrk_max            N worker threads limited                  N
+ * n_wrk_queue          N queued work requests                    N
+ * n_wrk_overflow       N overflowed work requests                N
+ * n_wrk_drop           N dropped work requests                   N
+ * n_backend            N backends                                N
+ * n_expired            N expired objects                         N
+ * n_lru_nuked          N LRU nuked objects                       N
+ * n_lru_saved          N LRU saved objects                       N
+ * n_lru_moved          N LRU moved objects                       N
+ * n_deathrow           N objects on deathrow                     N
+ * losthdr              HTTP header overflows                     N
+ * n_objsendfile        Objects sent with sendfile                N
+ * n_objwrite           Objects sent with write                   N
+ * n_objoverflow        Objects overflowing workspace             N
+ * s_sess               Total Sessions                            N
+ * s_req                Total Requests                            N
+ * s_pipe               Total pipe                                N
+ * s_pass               Total pass                                N
+ * s_fetch              Total fetch                               N
+ * s_hdrbytes           Total header bytes                        N
+ * s_bodybytes          Total body bytes                          N
+ * sess_closed          Session Closed                            N
+ * sess_pipeline        Session Pipeline                          N
+ * sess_readahead       Session Read Ahead                        N
+ * sess_linger          Session Linger                            N
+ * sess_herd            Session herd                              N
+ * shm_records          SHM records                               Y
+ * shm_writes           SHM writes                                Y
+ * shm_flushes          SHM flushes due to overflow               Y
+ * shm_cont             SHM MTX contention                        Y
+ * shm_cycles           SHM cycles through buffer                 Y
+ * sm_nreq              allocator requests                        Y
+ * sm_nobj              outstanding allocations                   Y
+ * sm_balloc            bytes allocated                           Y
+ * sm_bfree             bytes free                                Y
+ * sma_nreq             SMA allocator requests                    Y
+ * sma_nobj             SMA outstanding allocations               Y
+ * sma_nbytes           SMA outstanding bytes                     Y
+ * sma_balloc           SMA bytes allocated                       Y
+ * sma_bfree            SMA bytes free                            Y
+ * sms_nreq             SMS allocator requests                    Y
+ * sms_nobj             SMS outstanding allocations               Y
+ * sms_nbytes           SMS outstanding bytes                     Y
+ * sms_balloc           SMS bytes allocated                       Y
+ * sms_bfree            SMS bytes freed                           Y
+ * backend_req          Backend requests made                     N
+ * n_vcl                N vcl total                               N
+ * n_vcl_avail          N vcl available                           N
+ * n_vcl_discard        N vcl discarded                           N
+ * n_purge              N total active purges                     N
+ * n_purge_add          N new purges added                        N
+ * n_purge_retire       N old purges deleted                      N
+ * n_purge_obj_test     N objects tested                          N
+ * n_purge_re_test      N regexps tested against                  N
+ * n_purge_dups         N duplicate purges removed                N
+ * hcb_nolock           HCB Lookups without lock                  Y
+ * hcb_lock             HCB Lookups with lock                     Y
+ * hcb_insert           HCB Inserts                               Y
+ * esi_parse            Objects ESI parsed (unlock)               Y
+ * esi_errors           ESI parse errors (unlock)                 Y
+ */
 #include "collectd.h"
 #include "common.h"
 #include "plugin.h"
+#include "configfile.h"
 
 #include <varnish/varnishapi.h>
 
-#define USER_CONFIG_INIT {0, 0, 0, 0, 0}
+#define USER_CONFIG_INIT {0, 0, 0, 0, 0, 0, 0, 0, 0, 0}
 #define SET_MONITOR_FLAG(name, flag, value) if((strcasecmp(name, key) == 0) && IS_TRUE(value)) user_config.flag = 1
 
 /* {{{ user_config_s */
 struct user_config_s {
-       int monitor_cache;
-       int monitor_connections;
-       int monitor_esi;
-       int monitor_backend;
-       int monitor_fetch;
-};
-
-typedef struct user_config_s user_config_t; /* }}} */
+       char *instance;
 
-/* {{{ Configuration directives */
-static user_config_t user_config = USER_CONFIG_INIT;
-
-static const char *config_keys[] =
-{
-  "MonitorCache",
-  "MonitorConnections",
-  "MonitorESI",
-  "MonitorBackend",
-  "MonitorFetch"
+       _Bool monitor_cache;
+       _Bool monitor_connections;
+       _Bool monitor_esi;
+       _Bool monitor_backend;
+       _Bool monitor_fetch;
+       _Bool monitor_hcb;
+       _Bool monitor_shm;
+       _Bool monitor_sma;
+       _Bool monitor_sms;
+       _Bool monitor_sm;
 };
+typedef struct user_config_s user_config_t; /* }}} */
 
-static int config_keys_num = STATIC_ARRAY_SIZE (config_keys); /* }}} */
-
-static int varnish_config(const char *key, const char *value) /* {{{ */
-{
-       SET_MONITOR_FLAG("MonitorCache", monitor_cache, value);
-       SET_MONITOR_FLAG("MonitorConnections", monitor_connections, value);
-       SET_MONITOR_FLAG("MonitorESI", monitor_esi, value);
-       SET_MONITOR_FLAG("MonitorBackend", monitor_backend, value);
-       SET_MONITOR_FLAG("MonitorFetch", monitor_fetch, value);
-
-       return (0);
-} /* }}} */
+static _Bool have_instance = 0;
 
 static void varnish_submit(const char *type, const char *type_instance, gauge_t value) /* {{{ */
 {
@@ -81,29 +168,29 @@ static void varnish_submit(const char *type, const char *type_instance, gauge_t
        plugin_dispatch_values(&vl);
 } /* }}} */
 
-static void varnish_monitor(struct varnish_stats *VSL_stats) /* {{{ */
+static void varnish_monitor(const user_config_t *conf, struct varnish_stats *VSL_stats) /* {{{ */
 {
-       if(user_config.monitor_cache == 1)
+       if(conf->monitor_cache)
        {
                varnish_submit("varnish_cache_ratio", "cache_hit"    , VSL_stats->cache_hit);     /* Cache hits          */
                varnish_submit("varnish_cache_ratio", "cache_miss"   , VSL_stats->cache_miss);    /* Cache misses        */
                varnish_submit("varnish_cache_ratio", "cache_hitpass", VSL_stats->cache_hitpass); /* Cache hits for pass */
        }
 
-       if(user_config.monitor_connections == 1)
+       if(conf->monitor_connections)
        {
                varnish_submit("varnish_connections", "client_connections-accepted", VSL_stats->client_conn); /* Client connections accepted */
                varnish_submit("varnish_connections", "client_connections-dropped" , VSL_stats->client_drop); /* Connection dropped, no sess */
                varnish_submit("varnish_connections", "client_connections-received", VSL_stats->client_req);  /* Client requests received    */
        }
 
-       if(user_config.monitor_esi == 1)
+       if(conf->monitor_esi)
        {
                varnish_submit("varnish_esi", "esi_parsed", VSL_stats->esi_parse);  /* Objects ESI parsed (unlock) */
                varnish_submit("varnish_esi", "esi_errors", VSL_stats->esi_errors); /* ESI parse errors (unlock)   */
        }
 
-       if(user_config.monitor_backend == 1)
+       if(conf->monitor_backend)
        {
                varnish_submit("varnish_backend_connections", "backend_connections-success"      , VSL_stats->backend_conn);      /* Backend conn. success       */
                varnish_submit("varnish_backend_connections", "backend_connections-not-attempted", VSL_stats->backend_unhealthy); /* Backend conn. not attempted */
@@ -115,7 +202,7 @@ static void varnish_monitor(struct varnish_stats *VSL_stats) /* {{{ */
                varnish_submit("varnish_backend_connections", "backend_connections-unused"       , VSL_stats->backend_unused);    /* Backend conn. unused        */
        }
 
-       if(user_config.monitor_fetch == 1)
+       if(conf->monitor_fetch)
        {
                varnish_submit("varnish_fetch", "fetch_head"       , VSL_stats->fetch_head);    /* Fetch head                */
                varnish_submit("varnish_fetch", "fetch_length"     , VSL_stats->fetch_length);  /* Fetch with length         */
@@ -127,29 +214,243 @@ static void varnish_monitor(struct varnish_stats *VSL_stats) /* {{{ */
                varnish_submit("varnish_fetch", "fetch_zero"       , VSL_stats->fetch_zero);    /* Fetch zero len            */
                varnish_submit("varnish_fetch", "fetch_failed"     , VSL_stats->fetch_failed);  /* Fetch failed              */
        }
+
+       if(conf->monitor_hcb)
+       {
+               varnish_submit("varnish_hcb", "hcb_nolock", VSL_stats->hcb_nolock); /* HCB Lookups without lock */
+               varnish_submit("varnish_hcb", "hcb_lock"  , VSL_stats->hcb_lock);   /* HCB Lookups with lock    */
+               varnish_submit("varnish_hcb", "hcb_insert", VSL_stats->hcb_insert); /* HCB Inserts              */
+       }
+
+       if(conf->monitor_shm)
+       {
+               varnish_submit("varnish_shm", "shm_records"   , VSL_stats->shm_records); /* SHM records                 */
+               varnish_submit("varnish_shm", "shm_writes"    , VSL_stats->shm_writes);  /* SHM writes                  */
+               varnish_submit("varnish_shm", "shm_flushes"   , VSL_stats->shm_flushes); /* SHM flushes due to overflow */
+               varnish_submit("varnish_shm", "shm_contention", VSL_stats->shm_cont);    /* SHM MTX contention          */
+               varnish_submit("varnish_shm", "shm_cycles"    , VSL_stats->shm_cycles);  /* SHM cycles through buffer   */
+       }
+
+       if(conf->monitor_sma)
+       {
+               varnish_submit("varnish_sma", "sma_req"   , VSL_stats->sma_nreq);   /* SMA allocator requests      */
+               varnish_submit("varnish_sma", "sma_nobj"  , VSL_stats->sma_nobj);   /* SMA outstanding allocations */
+               varnish_submit("varnish_sma", "sma_nbytes", VSL_stats->sma_nbytes); /* SMA outstanding bytes       */
+               varnish_submit("varnish_sma", "sma_balloc", VSL_stats->sma_balloc); /* SMA bytes allocated         */
+               varnish_submit("varnish_sma", "sma_bfree" , VSL_stats->sma_bfree);  /* SMA bytes free              */
+       }
+
+       if(conf->monitor_sms)
+       {
+               varnish_submit("varnish_sms", "sms_nreq"  , VSL_stats->sms_nreq);   /* SMS allocator requests      */
+               varnish_submit("varnish_sms", "sms_nobj"  , VSL_stats->sms_nobj);   /* SMS outstanding allocations */
+               varnish_submit("varnish_sms", "sms_nbytes", VSL_stats->sms_nbytes); /* SMS outstanding bytes       */
+               varnish_submit("varnish_sms", "sms_balloc", VSL_stats->sms_balloc); /* SMS bytes allocated         */
+               varnish_submit("varnish_sms", "sms_bfree" , VSL_stats->sms_bfree);  /* SMS bytes freed             */
+       }
+
+       if(conf->monitor_sm)
+       {
+               varnish_submit("varnish_sm", "sm_nreq"  , VSL_stats->sm_nreq);   /* allocator requests      */
+               varnish_submit("varnish_sm", "sm_nobj"  , VSL_stats->sm_nobj);   /* outstanding allocations */
+               varnish_submit("varnish_sm", "sm_balloc", VSL_stats->sm_balloc); /* bytes allocated         */
+               varnish_submit("varnish_sm", "sm_bfree" , VSL_stats->sm_bfree);  /* bytes free              */
+       }
 } /* }}} */
 
-static int varnish_read(void) /* {{{ */
+static int varnish_read(user_data_t *ud) /* {{{ */
 {
        struct varnish_stats *VSL_stats;
-       const char *varnish_instance_name = NULL;
+       user_config_t *conf;
+
+       if ((ud == NULL) || (ud->data == NULL))
+               return (EINVAL);
 
-       if ((VSL_stats = VSL_OpenStats(varnish_instance_name)) == NULL)
+       conf = ud->data;
+
+       VSL_stats = VSL_OpenStats(conf->instance);
+       if (VSL_stats == NULL)
        {
                ERROR("Varnish plugin : unable to load statistics");
 
                return (-1);
        }
 
-       varnish_monitor(VSL_stats);
+       varnish_monitor(conf, VSL_stats);
 
     return (0);
 } /* }}} */
 
+static void varnish_config_free (void *ptr) /* {{{ */
+{
+       user_config_t *conf = ptr;
+
+       if (conf == NULL)
+               return;
+
+       sfree (conf->instance);
+       sfree (conf);
+} /* }}} */
+
+static int varnish_init (void) /* {{{ */
+{
+       user_config_t *conf;
+       user_data_t ud;
+
+       if (have_instance)
+               return (0);
+
+       conf = malloc (sizeof (*conf));
+       if (conf == NULL)
+               return (ENOMEM);
+       memset (conf, 0, sizeof (*conf));
+
+       /* Default settings: */
+       conf->instance = NULL;
+       conf->monitor_cache = 1;
+       conf->monitor_connections = 1;
+
+       ud.data = conf;
+       ud.free_func = varnish_config_free;
+
+       plugin_register_complex_read (/* group = */ "varnish",
+                       /* name      = */ "varnish/localhost",
+                       /* callback  = */ varnish_read,
+                       /* interval  = */ NULL,
+                       /* user data = */ &ud);
+
+       return (0);
+} /* }}} int varnish_init */
+
+static int varnish_config_instance (const oconfig_item_t *ci) /* {{{ */
+{
+       user_config_t *conf;
+       user_data_t ud;
+       char callback_name[DATA_MAX_NAME_LEN];
+       int i;
+
+       conf = malloc (sizeof (*conf));
+       if (conf == NULL)
+               return (ENOMEM);
+       memset (conf, 0, sizeof (*conf));
+       conf->instance = NULL;
+
+       if (ci->values_num == 1)
+       {
+               int status;
+
+               status = cf_util_get_string (ci, &conf->instance);
+               if (status != 0)
+               {
+                       sfree (conf);
+                       return (status);
+               }
+               assert (conf->instance != NULL);
+
+               if (strcmp ("localhost", conf->instance) == 0)
+               {
+                       sfree (conf->instance);
+                       conf->instance = NULL;
+               }
+       }
+       else if (ci->values_num > 1)
+       {
+               WARNING ("Varnish plugin: \"Instance\" blocks accept only "
+                               "one argument.");
+               return (EINVAL);
+       }
+
+       for (i = 0; i < ci->children_num; i++)
+       {
+               oconfig_item_t *child = ci->children + i;
+
+               if (strcasecmp ("MonitorCache", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_cache);
+               else if (strcasecmp ("MonitorConnections", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_connections);
+               else if (strcasecmp ("MonitorESI", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_esi);
+               else if (strcasecmp ("MonitorBackend", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_backend);
+               else if (strcasecmp ("MonitorFetch", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_fetch);
+               else if (strcasecmp ("MonitorHCB", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_hcb);
+               else if (strcasecmp ("MonitorSHM", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_shm);
+               else if (strcasecmp ("MonitorSMA", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_sma);
+               else if (strcasecmp ("MonitorSMS", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_sms);
+               else if (strcasecmp ("MonitorSM", child->key) == 0)
+                       cf_util_get_boolean (child, &conf->monitor_sm);
+               else
+               {
+                       WARNING ("Varnish plugin: Ignoring unknown "
+                                       "configuration option: \"%s\"",
+                                       child->key);
+               }
+       }
+
+       if (!conf->monitor_cache
+                       && !conf->monitor_connections
+                       && !conf->monitor_esi
+                       && !conf->monitor_backend
+                       && !conf->monitor_fetch
+                       && !conf->monitor_hcb
+                       && !conf->monitor_shm
+                       && !conf->monitor_sma
+                       && !conf->monitor_sms
+                       && !conf->monitor_sm)
+       {
+               WARNING ("Varnish plugin: No metric has been configured for "
+                               "instance \"%s\". Disabling this instance.",
+                               (conf->instance == NULL) ? "localhost" : conf->instance);
+               return (EINVAL);
+       }
+
+       ssnprintf (callback_name, sizeof (callback_name), "varnish/%s",
+                       (conf->instance == NULL) ? "localhost" : conf->instance);
+
+       ud.data = conf;
+       ud.free_func = varnish_config_free;
+
+       plugin_register_complex_read (/* group = */ "varnish",
+                       /* name      = */ callback_name,
+                       /* callback  = */ varnish_read,
+                       /* interval  = */ NULL,
+                       /* user data = */ &ud);
+
+       have_instance = 1;
+
+       return (0);
+} /* }}} int varnish_config_instance */
+
+static int varnish_config (oconfig_item_t *ci) /* {{{ */
+{
+       int i;
+
+       for (i = 0; i < ci->children_num; i++)
+       {
+               oconfig_item_t *child = ci->children + i;
+
+               if (strcasecmp ("Instance", child->key) == 0)
+                       varnish_config_instance (child);
+               else
+               {
+                       WARNING ("Varnish plugin: Ignoring unknown "
+                                       "configuration option: \"%s\"",
+                                       child->key);
+               }
+       }
+
+       return (0);
+} /* }}} int varnish_config */
+
 void module_register (void) /* {{{ */
 {
-       plugin_register_config("varnish", varnish_config, config_keys, config_keys_num);
-       plugin_register_read("varnish", varnish_read);
+       plugin_register_complex_config("varnish", varnish_config);
+       plugin_register_init ("varnish", varnish_init);
 } /* }}} */
 
 /* vim: set sw=8 noet fdm=marker : */