diff options
Diffstat (limited to 'src/varnish-mib.8')
-rw-r--r-- | src/varnish-mib.8 | 40 |
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,50 +1,59 @@ .\" This file is part of Varnish-mib -*- nroff -*- -.\" Copyright (C) 2014-2015 Sergey Poznyakoff +.\" Copyright (C) 2014-2016 Sergey Poznyakoff .\" .\" Varnish-mib is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3, or (at your option) .\" any later version. .\" .\" Varnish-mib is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with Varnish-mib. If not, see <http://www.gnu.org/licenses/>. -.TH VARNISH-MIB 8 "November 28, 2014" "varnish-mib" +.TH VARNISH-MIB 8 "April 27, 2016" "varnish-mib" .SH NAME varnish\-mib \- net-snmp module for obtaining Varnish Cache statistics .SH SYNOPSIS In \fBsnmpd.conf\fR(5): .PP .B dlmod varnish_mib /usr/lib/snmp/varnish\-mib.so .SH DESCRIPTION Dynamically loadable object module for .B net-snmp that provides access to Varnish Cache statistics. The module is loaded into .BR snmpd (8) as shown above (actual path can of course differ, depending on how -the package was configured). +the package was configured). Varnish version \fB4.0\fR and \fB4.1\fR +are supported. +.PP +When using with \fBVarnish\fR version \fB4.1\fR, make sure the +\fB_.vsm\fR file is readable for \fBsnmpd\fR. This file is normally +located in \fB/var/lib/varnish/\fIHOSTNAME\fR and has mode \fB640\fR. +Its owner is determined by the \fB\-j\fR (\fB\-\-jail\fR) +\fBvarnishd\fR option. There are two ways to ensure it is readable: +either make sure \fBsnmpd\fR and \fBvarnishd\fR run with the same user +group, or use \fBsetfacl\fR(1) to tune access to that file. .PP The module obtains most of the data using Varnish API. Information about available bans (\fBbanTable\fR subtree) as well as the mechanism for setting bans (\fBclientBan\fR OID) are implemented via \fBvarnishd\fR administrative interface. For these to work, the module must have read access to Varnish secret file. In other words, the secret file -must be readable either by the user \fBsnmpd\fR runs as, or by one -of this user's groups. +must be readable either by the user \fBsnmpd\fR runs as, or by its +group. .SH CONFIGURATION OPTIONS Configuration statements specific to .B varnish\-mib must appear in the .B snmpd.conf file below the .B dlmod statement that loads the module. .PP The following configuration statements are available: .TP \fBvarnishBanTableTimeout\fR \fINUMBER\fR @@ -84,24 +93,35 @@ Number of received HTTP requests. .B clientCacheHits Number of cache hits. A cache hit indicates that an object has been delivered to a client without fetching it from a backend server. .TP .B clientCacheHitsPass Number of hits for pass. A cache hit for pass indicates that Varnish passes the request to the backend and this decision itself has been cached. .TP .B clientCacheMisses Number of misses. A cache miss indicates the object was fetched from the backend before delivering it to the client. .TP +.B clientRequests400 +Client requests received, subject to 400 errors. +.TP +.B clientRequests411 +Client requests received, subject to 411 errors. This variable is +available only in Varnish version \fR4.0\fR. +.TP +.B clientRequests413 +Client requests received, subject to 413 errors. This variable is +available only in Varnish version \fR4.0\fR. +.TP .B clientBan A write-only OID. When set, invalidates the cache using the supplied value as argument to ban. When read, returns an empty string. E.g., to invalidate caches of all \fBpng\fR images: .EE snmpset \fBhostname\fR VARNISH\-MIB::clientBan.0 s 'req.url ~ \(dq\\.png$\(dq' .EX .SS Branch \(dqbackend\(dq .TP .B backendConnSuccess Number of successful connections to the backend. @@ -119,25 +139,26 @@ Number of failed backend connections. .TP .B backendConnReuses Number of reused backend connections. This counter is increased whenever Varnish reuses a recycled connection. .TP .B backendConnRecycled Number of backend connection recycles. This counter is increased whenever Varnish has 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. .TP .B backendConnUnused -Number of unused backend connections. +Number of unused backend connections. This variable is available only +in Varnish version \fR4.0\fR. .TP .B backendConnRetry Backend connections retried. .TP .B backendRequests Total backend requests made. .TP .B backendTable This branch provides a conceptual table of backends with the corresponding statistics. It is indexed by \fBvbeIndex\fR. Each row has the following elements: .RS @@ -228,40 +249,41 @@ Master daemon uptime, in hundredths of a second. Number of sessions succesfully accepted. .TP .B sessQueued Number of times session was queued waiting for a thread. .TP .B sessDropped Number of sessions dropped because session queue was full. .TP .B sessClosed Number of sessions closed. .TP .B sessPipeline -Session pipeline. +Session pipeline. This variable is available only in Varnish version \fR4.0\fR. .TP .B sessReadAhead Session read-ahead. .TP .B sessHerd Session herd. .TP .B sessDrop Number of sessions dropped for thread. .TP .B sessFail Number of session accept failures. .TP .B sessPipeOverflow -Number of session pipe overflows. +Number of session pipe overflows. This variable is available only in +Varnish version \fR4.0\fR. .SS Branch \(dqthreads\(dq .TP .B threadsPools Number of thread pools. .TP .B threadsTotal Number of thread pools. .TP .B threadsLimitHits Number of times more threads were needed, but limit was reached in a thread pool. .TP @@ -348,25 +370,25 @@ seconds. It can be configured in the \fBsnmpd.conf\fR file The \fBagent\fR branch is reserved for OIDs for implementation-specific management. It is not used currently. .SH "SEE ALSO" .BR snmpd.conf (5), .BR snmpd (8), .BR varnish (7), .BR varnishstat (1). .SH AUTHORS Sergey Poznyakoff .SH "BUG REPORTS" Report bugs to <gray@gnu.org>. .SH COPYRIGHT -Copyright \(co 2014 Sergey Poznyakoff +Copyright \(co 2014-2016 Sergey Poznyakoff .br .na License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> .br .ad This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. .\" Local variables: .\" eval: (add-hook 'write-file-hooks 'time-stamp) .\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.-]* [0-9] \"" .\" time-stamp-format: "%:B %:d, %:y" .\" time-stamp-end: "\"" |