summaryrefslogtreecommitdiffabout
path: root/src/varnish-mib.8
Unidiff
Diffstat (limited to 'src/varnish-mib.8') (more/less context) (ignore whitespace changes)
-rw-r--r--src/varnish-mib.840
1 files changed, 31 insertions, 9 deletions
diff --git a/src/varnish-mib.8 b/src/varnish-mib.8
index 4559b0c..0c54e6f 100644
--- a/src/varnish-mib.8
+++ b/src/varnish-mib.8
@@ -1,5 +1,5 @@
1.\" This file is part of Varnish-mib -*- nroff -*- 1.\" This file is part of Varnish-mib -*- nroff -*-
2.\" Copyright (C) 2014-2015 Sergey Poznyakoff 2.\" Copyright (C) 2014-2016 Sergey Poznyakoff
3.\" 3.\"
4.\" Varnish-mib is free software; you can redistribute it and/or modify 4.\" Varnish-mib is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by 5.\" it under the terms of the GNU General Public License as published by
@@ -13,7 +13,7 @@
13.\" 13.\"
14.\" You should have received a copy of the GNU General Public License 14.\" You should have received a copy of the GNU General Public License
15.\" along with Varnish-mib. If not, see <http://www.gnu.org/licenses/>. 15.\" along with Varnish-mib. If not, see <http://www.gnu.org/licenses/>.
16.TH VARNISH-MIB 8 "November 28, 2014" "varnish-mib" 16.TH VARNISH-MIB 8 "April 27, 2016" "varnish-mib"
17.SH NAME 17.SH NAME
18varnish\-mib \- net-snmp module for obtaining Varnish Cache statistics 18varnish\-mib \- net-snmp module for obtaining Varnish Cache statistics
19.SH SYNOPSIS 19.SH SYNOPSIS
@@ -27,15 +27,24 @@ that provides access to Varnish Cache statistics. The module is
27loaded into 27loaded into
28.BR snmpd (8) 28.BR snmpd (8)
29as shown above (actual path can of course differ, depending on how 29as shown above (actual path can of course differ, depending on how
30the package was configured). 30the package was configured). Varnish version \fB4.0\fR and \fB4.1\fR
31are supported.
32.PP
33When using with \fBVarnish\fR version \fB4.1\fR, make sure the
34\fB_.vsm\fR file is readable for \fBsnmpd\fR. This file is normally
35located in \fB/var/lib/varnish/\fIHOSTNAME\fR and has mode \fB640\fR.
36Its owner is determined by the \fB\-j\fR (\fB\-\-jail\fR)
37\fBvarnishd\fR option. There are two ways to ensure it is readable:
38either make sure \fBsnmpd\fR and \fBvarnishd\fR run with the same user
39group, or use \fBsetfacl\fR(1) to tune access to that file.
31.PP 40.PP
32The module obtains most of the data using Varnish API. Information 41The module obtains most of the data using Varnish API. Information
33about available bans (\fBbanTable\fR subtree) as well as the mechanism 42about available bans (\fBbanTable\fR subtree) as well as the mechanism
34for setting bans (\fBclientBan\fR OID) are implemented via \fBvarnishd\fR 43for setting bans (\fBclientBan\fR OID) are implemented via \fBvarnishd\fR
35administrative interface. For these to work, the module must have 44administrative interface. For these to work, the module must have
36read access to Varnish secret file. In other words, the secret file 45read access to Varnish secret file. In other words, the secret file
37must be readable either by the user \fBsnmpd\fR runs as, or by one 46must be readable either by the user \fBsnmpd\fR runs as, or by its
38of this user's groups. 47group.
39.SH CONFIGURATION OPTIONS 48.SH CONFIGURATION OPTIONS
40Configuration statements specific to 49Configuration statements specific to
41.B varnish\-mib 50.B varnish\-mib
@@ -93,6 +102,17 @@ passes the request to the backend and this decision itself has been cached.
93Number of misses. A cache miss indicates the object was fetched from 102Number of misses. A cache miss indicates the object was fetched from
94the backend before delivering it to the client. 103the backend before delivering it to the client.
95.TP 104.TP
105.B clientRequests400
106Client requests received, subject to 400 errors.
107.TP
108.B clientRequests411
109Client requests received, subject to 411 errors. This variable is
110available only in Varnish version \fR4.0\fR.
111.TP
112.B clientRequests413
113Client requests received, subject to 413 errors. This variable is
114available only in Varnish version \fR4.0\fR.
115.TP
96.B clientBan 116.B clientBan
97A write-only OID. When set, invalidates the cache using the supplied 117A write-only OID. When set, invalidates the cache using the supplied
98value as argument to ban. When read, returns an empty string. E.g., 118value as argument to ban. When read, returns an empty string. E.g.,
@@ -128,7 +148,8 @@ the pool of connections. It has not yet been used, but it might be,
128unless the backend closes it. 148unless the backend closes it.
129.TP 149.TP
130.B backendConnUnused 150.B backendConnUnused
131Number of unused backend connections. 151Number of unused backend connections. This variable is available only
152in Varnish version \fR4.0\fR.
132.TP 153.TP
133.B backendConnRetry 154.B backendConnRetry
134Backend connections retried. 155Backend connections retried.
@@ -237,7 +258,7 @@ Number of sessions dropped because session queue was full.
237Number of sessions closed. 258Number of sessions closed.
238.TP 259.TP
239.B sessPipeline 260.B sessPipeline
240Session pipeline. 261Session pipeline. This variable is available only in Varnish version \fR4.0\fR.
241.TP 262.TP
242.B sessReadAhead 263.B sessReadAhead
243Session read-ahead. 264Session read-ahead.
@@ -252,7 +273,8 @@ Number of sessions dropped for thread.
252Number of session accept failures. 273Number of session accept failures.
253.TP 274.TP
254.B sessPipeOverflow 275.B sessPipeOverflow
255Number of session pipe overflows. 276Number of session pipe overflows. This variable is available only in
277Varnish version \fR4.0\fR.
256.SS Branch \(dqthreads\(dq 278.SS Branch \(dqthreads\(dq
257.TP 279.TP
258.B threadsPools 280.B threadsPools
@@ -357,7 +379,7 @@ Sergey Poznyakoff
357.SH "BUG REPORTS" 379.SH "BUG REPORTS"
358Report bugs to <gray@gnu.org>. 380Report bugs to <gray@gnu.org>.
359.SH COPYRIGHT 381.SH COPYRIGHT
360Copyright \(co 2014 Sergey Poznyakoff 382Copyright \(co 2014-2016 Sergey Poznyakoff
361.br 383.br
362.na 384.na
363License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> 385License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

Return to:

Send suggestions and report system problems to the System administrator.