vsc_f_main.h

/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2014 Varnish Software AS
 * All rights reserved.
 *
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Definition of all shared memory statistics below.
 *
 * Fields (n, t, l, f, e, d):
 *    n - Name:		Field name, in C-source and stats programs
 *    t - Type:		C-type, uint64_t, unless marked in 'f'
 *    l - Local:	Local counter in worker thread.
 *    f - Format:	Semantics of the value in this field
 *				'a' - Accumulator (deprecated, use 'c')
 *				'b' - Bitmap
 *				'c' - Counter, never decreases.
 *				'g' - Gauge, goes up and down
 *				'i' - Integer (deprecated, use 'g')
 *    e - Explanation:	Short explanation of field (for screen use)
 *    d - Description:	Long explanation of field (for doc use)
 *
 * Please describe Gauge variables as "Number of..." to indicate that
 * this is a snapshot, and Counter variables as "Count of" to indicate
 * accumulative count.
 *
 * -----------------------
 * NB: Cleanup in progress
 * -----------------------
 *
 * Insufficient attention has caused this to become a swamp of conflicting
 * conventions, shorthands and general mumbo-jumbo.  I'm trying to clean
 * it up as I go over the code in other business.
 *
 * Please see the sessmem section for how it should look.
 *
 */

/*--------------------------------------------------------------------
 * Globals, not related to traffic
 */

VSC_F(uptime,			uint64_t, 0, 'a', info,
    "Child process uptime",
	"How long the child process has been running."
)


/*---------------------------------------------------------------------
 * Sessions
 */

VSC_F(sess_conn,		uint64_t, 1, 'c', info,
    "Sessions accepted",
	"Count of sessions successfully accepted"
)

VSC_F(sess_drop,		uint64_t, 1, 'c', info,
    "Sessions dropped",
	"Count of sessions silently dropped due to lack of worker thread."
)

VSC_F(sess_fail,		uint64_t, 1, 'c', info,
    "Session accept failures",
	"Count of failures to accept TCP connection."
	"  Either the client changed its mind, or the kernel ran out of"
	" some resource like file descriptors."
)

VSC_F(sess_pipe_overflow,	uint64_t, 1, 'c', info,
    "Session pipe overflow",
	"Count of sessions dropped due to the session pipe overflowing."
)

/*---------------------------------------------------------------------*/

VSC_F(client_req_400,		uint64_t, 1, 'a', info,
    "Client requests received, subject to 400 errors",
	"400 means we couldn't make sense of the request, it was"
	" malformed in some drastic way."
)

VSC_F(client_req_411,		uint64_t, 1, 'a', info,
    "Client requests received, subject to 411 errors",
	"411 means the client did not send a Content-Lenght for the req.body."
)

VSC_F(client_req_413,		uint64_t, 1, 'a', info,
    "Client requests received, subject to 413 errors",
	"413 means that HTTP headers exceeded length or count limits."
)

VSC_F(client_req_417,		uint64_t, 1, 'a', info,
    "Client requests received, subject to 417 errors",
	"417 means that something went wrong with an Expect: header."
)

VSC_F(client_req,		uint64_t, 1, 'a', info,
    "Good client requests received",
	"The count of parseable client requests seen."
)

/*---------------------------------------------------------------------*/

VSC_F(cache_hit,		uint64_t, 1, 'a', info,
    "Cache hits",
	"Count of cache hits. "
	"  A cache hit indicates that an object has been delivered to a"
	"  client without fetching it from a backend server."
)

VSC_F(cache_hitpass,		uint64_t, 1, 'a', info,
    "Cache hits for pass",
	"Count of hits for pass"
	"  A cache hit for pass indicates that Varnish is going to"
	"  pass the request to the backend and this decision has been "
	"  cached in it self. This counts how many times the cached "
	"  decision is being used."
)

VSC_F(cache_miss,		uint64_t, 1, 'a', info,
    "Cache misses",
	"Count of misses"
	"  A cache miss indicates the object was fetched from the"
	"  backend before delivering it to the backend."
)

/*---------------------------------------------------------------------*/

VSC_F(backend_conn,		uint64_t, 0, 'a', info,
    "Backend conn. success",
	"How many backend connections have successfully been"
	" established."
)

VSC_F(backend_unhealthy,	uint64_t, 0, 'a', info,
    "Backend conn. not attempted",
	""
)
VSC_F(backend_busy,		uint64_t, 0, 'a', info,
    "Backend conn. too many",
	""
)
VSC_F(backend_fail,		uint64_t, 0, 'a', info,
    "Backend conn. failures",
	""
)
VSC_F(backend_reuse,		uint64_t, 0, 'a', info,
    "Backend conn. reuses",
	"Count of backend connection reuses"
	"  This counter is increased whenever we reuse a recycled connection."
)
VSC_F(backend_toolate,		uint64_t, 0, 'a', info,
    "Backend conn. was closed",
	""
)
VSC_F(backend_recycle,		uint64_t, 0, 'a', info,
    "Backend conn. recycles",
	"Count of backend connection recycles"
	"  This counter is increased whenever we have a keep-alive"
	"  connection that is put back into the pool of connections."
	"  It has not yet been used, but it might be, unless the backend"
	"  closes it."
)
VSC_F(backend_retry,		uint64_t, 0, 'a', info,
    "Backend conn. retry",
	""
)

/*---------------------------------------------------------------------
 * Backend fetch statistics
 */

VSC_F(fetch_head,		uint64_t, 1, 'c', info,
    "Fetch no body (HEAD)",
	"beresp with no body because the request is HEAD."
)
VSC_F(fetch_length,		uint64_t, 1, 'c', info,
    "Fetch with Length",
	"beresp with Content-Length."
)
VSC_F(fetch_chunked,		uint64_t, 1, 'c', info,
    "Fetch chunked",
	"beresp with Chunked."
)
VSC_F(fetch_eof,		uint64_t, 1, 'c', info,
    "Fetch EOF",
	"beresp with EOF from lack of other info."
)
VSC_F(fetch_bad,		uint64_t, 1, 'c', info,
    "Fetch bad T-E",
	"beresp failed due to unknown Transfer-Encoding."
)
VSC_F(fetch_close,		uint64_t, 1, 'c', info,
    "Fetch wanted close",
	"beresp with EOF due to Connection: Close."
)
VSC_F(fetch_oldhttp,		uint64_t, 1, 'c', info,
    "Fetch pre HTTP/1.1 closed",
	"beresp with EOF due to HTTP < 1.1"
)
VSC_F(fetch_zero,		uint64_t, 1, 'c', info,
    "Fetch zero len body",
	"beresp with EOF due to keep-live but neither Chunked or Len."
)
VSC_F(fetch_1xx,		uint64_t, 1, 'c', info,
    "Fetch no body (1xx)",
	"beresp with no body because of 1XX response."
)
VSC_F(fetch_204,		uint64_t, 1, 'c', info,
    "Fetch no body (204)",
	"beresp with no body because of 204 response."
)
VSC_F(fetch_304,		uint64_t, 1, 'c', info,
    "Fetch no body (304)",
	"beresp with no body because of 304 response."
)
VSC_F(fetch_failed,		uint64_t, 1, 'c', info,
    "Fetch failed (all causes)",
	"beresp fetch failed."
)
VSC_F(fetch_no_thread,		uint64_t, 1, 'c', info,
    "Fetch failed (no thread)",
	"beresp fetch failed, no thread available."
)

/*---------------------------------------------------------------------
 * Pools, threads, and sessions
 *    see: cache_pool.c
 *
 */

VSC_F(pools,			uint64_t, 0, 'g', info,
    "Number of thread pools",
	"Number of thread pools.  See also parameter thread_pools."
	"  NB: Presently pools cannot be removed once created."
)

VSC_F(threads,			uint64_t, 0, 'g', info,
    "Total number of threads",
	"Number of threads in all pools."
	"  See also parameters thread_pools, thread_pool_min and"
	" thread_pool_max."
)

VSC_F(threads_limited,		uint64_t, 0, 'c', info,
    "Threads hit max",
	"Number of times more threads were needed, but limit was reached"
	" in a thread pool."
	"  See also parameter thread_pool_max."
)

VSC_F(threads_created,		uint64_t, 0, 'c', info,
    "Threads created",
	"Total number of threads created in all pools."
)

VSC_F(threads_destroyed,	uint64_t, 0, 'c', info,
    "Threads destroyed",
	"Total number of threads destroyed in all pools."
)

VSC_F(threads_failed,		uint64_t, 0, 'c', info,
    "Thread creation failed",
	"Number of times creating a thread failed."
	"  See VSL::Debug for diagnostics."
	"  See also parameter thread_fail_delay."
)

VSC_F(thread_queue_len,		uint64_t, 0, 'g', info,
    "Length of session queue",
	"Length of session queue waiting for threads."
	"  NB: Only updates once per second."
	"  See also parameter queue_max."
)

VSC_F(busy_sleep,		uint64_t, 1, 'c', info,
    "Number of requests sent to sleep on busy objhdr",
	"Number of requests sent to sleep without a worker thread because"
	" they found a busy object."
)

VSC_F(busy_wakeup,		uint64_t, 1, 'c', info,
    "Number of requests woken after sleep on busy objhdr",
	"Number of requests taken of the busy object sleep list and"
	" and rescheduled."
)

VSC_F(sess_queued,		uint64_t, 0, 'c', info,
    "Sessions queued for thread",
	"Number of times session was queued waiting for a thread."
	"  See also parameter queue_max."
)

VSC_F(sess_dropped,		uint64_t, 0, 'c', info,
    "Sessions dropped for thread",
	"Number of times session was dropped because the queue were too"
	" long already. See also parameter queue_max."
)

/*---------------------------------------------------------------------*/

VSC_F(n_object,			uint64_t, 1, 'i', info,
    "object structs made",
        "Number of object structs made"
)
VSC_F(n_vampireobject,		uint64_t, 1, 'i', diag,
    "unresurrected objects",
	"Number of unresurrected objects"
)
VSC_F(n_objectcore,		uint64_t, 1, 'i', info,
    "objectcore structs made",
       "Number of objectcore structs made"
)
VSC_F(n_objecthead,		uint64_t, 1, 'i', info,
    "objecthead structs made",
        "Number of objecthead structs made"
)
VSC_F(n_waitinglist,		uint64_t, 1, 'i', debug,
    "waitinglist structs made",
        "Number of waitinglist structs made"
)

VSC_F(n_backend,		uint64_t, 0, 'i', info,
    "Number of backends",
	"Number of backends known to us."
)

VSC_F(n_expired,		uint64_t, 0, 'i', info,
    "Number of expired objects",
	"Number of objects that expired from cache"
	" because of old age."
)
VSC_F(n_lru_nuked,		uint64_t, 0, 'i', info,
    "Number of LRU nuked objects",
	"How many objects have been forcefully evicted"
	" from storage to make room for a new object."
)
VSC_F(n_lru_moved,		uint64_t, 0, 'i', diag,
    "Number of LRU moved objects",
        "Number of move operations done on the LRU list."
)

VSC_F(losthdr,			uint64_t, 0, 'a', info,
    "HTTP header overflows",
	""
)

VSC_F(s_sess,			uint64_t, 1, 'a', info,
    "Total sessions seen",
	""
)
VSC_F(s_req,			uint64_t, 1, 'a', info,
    "Total requests seen",
	""
)
VSC_F(s_pipe,			uint64_t, 1, 'a', info,
    "Total pipe sessions seen",
	""
)
VSC_F(s_pass,			uint64_t, 1, 'a', info,
    "Total pass-ed requests seen",
	""
)
VSC_F(s_fetch,			uint64_t, 1, 'a', info,
    "Total backend fetches initiated",
	""
)
VSC_F(s_synth,			uint64_t, 1, 'a', info,
    "Total synthethic responses made",
	""
)
VSC_F(s_req_hdrbytes,		uint64_t, 1, 'a', info,
    "Request header bytes",
	"Total request header bytes received"
)
VSC_F(s_req_bodybytes,		uint64_t, 1, 'a', info,
    "Request body bytes",
	"Total request body bytes received"
)
VSC_F(s_resp_hdrbytes,		uint64_t, 1, 'a', info,
    "Response header bytes",
	"Total response header bytes transmitted"
)
VSC_F(s_resp_bodybytes,		uint64_t, 1, 'a', info,
    "Response body bytes",
	"Total response body bytes transmitted"
)
VSC_F(s_pipe_hdrbytes,		uint64_t, 0, 'a', info,
    "Pipe request header bytes",
	"Total request bytes received for piped sessions"
)
VSC_F(s_pipe_in,		uint64_t, 0, 'a', info,
    "Piped bytes from client",
	"Total number of bytes forwarded from clients in"
	" pipe sessions"
)
VSC_F(s_pipe_out,		uint64_t, 0, 'a', info,
    "Piped bytes to client",
	"Total number of bytes forwarded to clients in"
	" pipe sessions"
)

VSC_F(sess_closed,		uint64_t, 1, 'a', info,
    "Session Closed",
	""
)
VSC_F(sess_pipeline,		uint64_t, 1, 'a', info,
    "Session Pipeline",
	""
)
VSC_F(sess_readahead,		uint64_t, 1, 'a', info,
    "Session Read Ahead",
	""
)
VSC_F(sess_herd,		uint64_t, 1, 'a', diag,
    "Session herd",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(shm_records,		uint64_t, 0, 'a', diag,
    "SHM records",
	""
)
VSC_F(shm_writes,		uint64_t, 0, 'a', diag,
    "SHM writes",
	""
)
VSC_F(shm_flushes,		uint64_t, 0, 'a', diag,
    "SHM flushes due to overflow",
	""
)
VSC_F(shm_cont,			uint64_t, 0, 'a', diag,
    "SHM MTX contention",
	""
)
VSC_F(shm_cycles,		uint64_t, 0, 'a', diag,
    "SHM cycles through buffer",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(sms_nreq,			uint64_t, 0, 'a', diag,
    "SMS allocator requests",
	""
)
VSC_F(sms_nobj,			uint64_t, 0, 'i', diag,
    "SMS outstanding allocations",
	""
)
VSC_F(sms_nbytes,		uint64_t, 0, 'i', diag,
    "SMS outstanding bytes",
	""
)
VSC_F(sms_balloc,		uint64_t, 0, 'i', diag,
    "SMS bytes allocated",
	""
)
VSC_F(sms_bfree,		uint64_t, 0, 'i', diag,
    "SMS bytes freed",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(backend_req,		uint64_t, 0, 'a', info,
    "Backend requests made",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(n_vcl,			uint64_t, 0, 'a', info,
    "Number of loaded VCLs in total",
	""
)
VSC_F(n_vcl_avail,		uint64_t, 0, 'a', diag,
    "Number of VCLs available",
	""
)
VSC_F(n_vcl_discard,		uint64_t, 0, 'a', diag,
    "Number of discarded VCLs",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(bans,			uint64_t, 0, 'g', info,
   "Count of bans",
	"Number of all bans in system, including bans superseded"
	" by newer bans and bans already checked by the ban-lurker."
)
VSC_F(bans_completed,		uint64_t, 0, 'g', diag,
    "Number of bans marked 'completed'",
	"Number of bans which are no longer active, either because they"
	" got checked by the ban-lurker or superseded by newer identical bans."
)
VSC_F(bans_obj,			uint64_t, 0, 'g', diag,
    "Number of bans using obj.*",
	"Number of bans which use obj.* variables.  These bans can possibly"
	" be washed by the ban-lurker."
)
VSC_F(bans_req,			uint64_t, 0, 'g', diag,
    "Number of bans using req.*",
	"Number of bans which use req.* variables.  These bans can not"
	" be washed by the ban-lurker."
)
VSC_F(bans_added,		uint64_t, 0, 'c', diag,
    "Bans added",
	"Counter of bans added to ban list."
)
VSC_F(bans_deleted,		uint64_t, 0, 'c', diag,
    "Bans deleted",
	"Counter of bans deleted from ban list."
)

VSC_F(bans_tested,		uint64_t, 0, 'c', diag,
    "Bans tested against objects (lookup)",
	"Count of how many bans and objects have been tested against"
	" each other during hash lookup."
)
VSC_F(bans_obj_killed,	uint64_t, 0, 'c', diag,
    "Objects killed by bans (lookup)",
	"Number of objects killed by bans during object lookup."
)
VSC_F(bans_lurker_tested,	uint64_t, 0, 'c', diag,
    "Bans tested against objects (lurker)",
	"Count of how many bans and objects have been tested against"
	" each other by the ban-lurker."
)
VSC_F(bans_tests_tested,	uint64_t, 0, 'c', diag,
    "Ban tests tested against objects (lookup)",
	"Count of how many tests and objects have been tested against"
	" each other during lookup."
	"  'ban req.url == foo && req.http.host == bar'"
	" counts as one in 'bans_tested' and as two in 'bans_tests_tested'"
)
VSC_F(bans_lurker_tests_tested,	uint64_t, 0, 'c', diag,
    "Ban tests tested against objects (lurker)",
	"Count of how many tests and objects have been tested against"
	" each other by the ban-lurker."
	"  'ban req.url == foo && req.http.host == bar'"
	" counts as one in 'bans_tested' and as two in 'bans_tests_tested'"
)
VSC_F(bans_lurker_obj_killed,	uint64_t, 0, 'c', diag,
    "Objects killed by bans (lurker)",
	"Number of objects killed by ban-lurker."
)
VSC_F(bans_dups,		uint64_t, 0, 'c', diag,
    "Bans superseded by other bans",
	"Count of bans replaced by later identical bans."
)
VSC_F(bans_lurker_contention,	uint64_t, 0, 'c', diag,
    "Lurker gave way for lookup",
	"Number of times the ban-lurker had to wait for lookups."
)
VSC_F(bans_persisted_bytes,	uint64_t, 0, 'g', diag,
    "Bytes used by the persisted ban lists",
	"Number of bytes used by the persisted ban lists."
)
VSC_F(bans_persisted_fragmentation,	uint64_t, 0, 'g', diag,
    "Extra bytes in persisted ban lists due to fragmentation",
	"Number of extra bytes accumulated through dropped and"
	" completed bans in the persistent ban lists."
)

/*--------------------------------------------------------------------*/

VSC_F(n_purges,			uint64_t, 0, 'i', info,
    "Number of purge operations executed",
	""
)
VSC_F(n_obj_purged,		uint64_t, 0, 'i', info,
    "Number of purged objects",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(exp_mailed,			uint64_t, 0, 'c', diag,
    "Number of objects mailed to expiry thread",
	"Number of objects mailed to expiry thread for handling."
)

VSC_F(exp_received,			uint64_t, 0, 'c', diag,
    "Number of objects received by expiry thread",
	"Number of objects received by expiry thread for handling."
)

/*--------------------------------------------------------------------*/

VSC_F(hcb_nolock,		uint64_t, 1, 'a', debug,
    "HCB Lookups without lock",
	""
)
VSC_F(hcb_lock,			uint64_t, 0, 'a', debug,
    "HCB Lookups with lock",
	""
)
VSC_F(hcb_insert,		uint64_t, 0, 'a', debug,
    "HCB Inserts",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(esi_errors,		uint64_t, 0, 'a', diag,
    "ESI parse errors (unlock)",
	""
)
VSC_F(esi_warnings,		uint64_t, 0, 'a', diag,
    "ESI parse warnings (unlock)",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(vmods,			uint64_t, 0, 'i', info,
    "Loaded VMODs",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(n_gzip,			uint64_t, 0, 'a', info,
    "Gzip operations",
	""
)
VSC_F(n_gunzip,			uint64_t, 0, 'a', info,
    "Gunzip operations",
	""
)

/*--------------------------------------------------------------------*/

VSC_F(vsm_free,			uint64_t, 0, 'g', diag,
    "Free VSM space",
	"Number of bytes free in the shared memory used to communicate"
	" with tools like varnishstat, varnishlog etc."
)

VSC_F(vsm_used,			uint64_t, 0, 'g', diag,
    "Used VSM space",
	"Number of bytes used in the shared memory used to communicate"
	" with tools like varnishstat, varnishlog etc."
)

VSC_F(vsm_cooling,		uint64_t, 0, 'g', debug,
    "Cooling VSM space",
	"Number of bytes which will soon (max 1 minute) be freed"
	" in the shared memory used to communicate"
	" with tools like varnishstat, varnishlog etc."
)

VSC_F(vsm_overflow,		uint64_t, 0, 'g', diag,
    "Overflow VSM space",
	"Number of bytes which does not fit"
	" in the shared memory used to communicate"
	" with tools like varnishstat, varnishlog etc."
)

VSC_F(vsm_overflowed,		uint64_t, 0, 'c', diag,
    "Overflowed VSM space",
	"Total number of bytes which did not fit"
	" in the shared memory used to communicate"
	" with tools like varnishstat, varnishlog etc."
)