diff options
author | Sergey Poznyakoff <gray@nxc.no> | 2018-02-05 20:56:59 +0100 |
---|---|---|
committer | Sergey Poznyakoff <gray@nxc.no> | 2018-02-05 20:56:59 +0100 |
commit | f7677f32b90eea37e54b39a3e26e5437924a2ada (patch) | |
tree | 4112eecd0acecd664e613fd1b66dd177b7ab87ba /src/varnish-mib.8 | |
parent | 027e83b6f5dc6a63ed9c69e534c0b994041df14f (diff) | |
download | varnish-mib-f7677f32b90eea37e54b39a3e26e5437924a2ada.tar.gz varnish-mib-f7677f32b90eea37e54b39a3e26e5437924a2ada.tar.bz2 |
Version 2.0
Diffstat (limited to 'src/varnish-mib.8')
-rw-r--r-- | src/varnish-mib.8 | 85 |
1 files changed, 57 insertions, 28 deletions
diff --git a/src/varnish-mib.8 b/src/varnish-mib.8 index 8d86f18..77912af 100644 --- a/src/varnish-mib.8 +++ b/src/varnish-mib.8 | |||
@@ -1,3 +1,3 @@ | |||
1 | .\" This file is part of Varnish-mib -*- nroff -*- | 1 | .\" This file is part of Varnish-mib -*- nroff -*- |
2 | .\" Copyright (C) 2014-2016 Sergey Poznyakoff | 2 | .\" Copyright (C) 2014-2018 Sergey Poznyakoff |
3 | .\" | 3 | .\" |
@@ -15,5 +15,5 @@ | |||
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 "February 2, 2018" "varnish-mib" | 16 | .TH VARNISH-MIB 8 "February 5, 2018" "varnish-mib" |
17 | .SH NAME | 17 | .SH NAME |
18 | varnish\-mib \- net-snmp module for obtaining Varnish Cache statistics | 18 | varnish\-mib \- Net-SNMP module for Varnish Cache monitoring |
19 | .SH SYNOPSIS | 19 | .SH SYNOPSIS |
@@ -29,13 +29,39 @@ loaded into | |||
29 | as shown above (actual path can of course differ, depending on how | 29 | as shown above (actual path can of course differ, depending on how |
30 | the package was configured). The module is written for Varnish | 30 | the package was configured). This version is written for Varnish |
31 | version \fB5.\fIX\fR. | 31 | \fB5.2.0\fR. |
32 | .PP | 32 | .PP |
33 | The module obtains most of the data using Varnish API, and \fBvarnishd\fR | 33 | The values in the OID branches |
34 | administrative interface. You should make sure that \fBsnmpd\fR is | 34 | .BR client , |
35 | able to access both data sources. | 35 | .BR total , |
36 | .BR master , | ||
37 | .BR session , | ||
38 | .BR threads ", and " | ||
39 | .B objects | ||
40 | are obtained from Varnish API. | ||
36 | .PP | 41 | .PP |
37 | The user \fBsnmpd\fR runs as should be able to read contents of the | 42 | The OID branches |
38 | \fB/var/lib/varnish/\fIHOSTNAME\fB/_.vsm_mgt\fR directory and read | 43 | .BR backend , |
39 | files located in it. It must also have read permission on the varnish | 44 | .BR bans ", and " |
40 | secret file. | 45 | .B vcl |
46 | are obtained using \fBvarnishd\fR administrative interface (similar | ||
47 | to | ||
48 | .BR varnishadm (8)). | ||
49 | .PP | ||
50 | To retrieve this information, the module must | ||
51 | have enough permissions to scan the Varnish management directory and | ||
52 | read files located in it. This directory is normally named | ||
53 | \fB/var/lib/varnish/\fIHOSTNAME\fB/_.vsm_mgt\fR, where \fIHOSTNAME\fR | ||
54 | stands for the server's hostname. Unless | ||
55 | .BR snmpd (8) | ||
56 | is run as root, special measures should be undertaken in order to | ||
57 | grant access rights. For example, if the daemon runs as user | ||
58 | \fBsnmp\fR, running the following two commands after starting | ||
59 | \fBvarnishd\fR will do the trick: | ||
60 | |||
61 | .EX | ||
62 | setfacl -m u:snmp:rx /var/lib/varnish/$(hostname)/_.vsm_mgt | ||
63 | setfacl -m u:snmp:r /var/lib/varnish/$(hostname)/_.vsm_mgt/* | ||
64 | .EE | ||
65 | .PP | ||
66 | |||
41 | .SH CONFIGURATION OPTIONS | 67 | .SH CONFIGURATION OPTIONS |
@@ -45,3 +71,3 @@ must appear in the | |||
45 | .B snmpd.conf | 71 | .B snmpd.conf |
46 | file below the | 72 | file, after the |
47 | .B dlmod | 73 | .B dlmod |
@@ -66,4 +92,4 @@ Default is 5 seconds. | |||
66 | .PP | 92 | .PP |
67 | The following two statements are not normally needed, since | 93 | The following two statements are not normally needed, but are |
68 | \fBvarnish-mib\fR obtains this information automatically. | 94 | provided for completeness sake: |
69 | .TP | 95 | .TP |
@@ -74,3 +100,3 @@ socket. | |||
74 | \fBvarnishCLISecretFile\fR \fIFILE\fR | 100 | \fBvarnishCLISecretFile\fR \fIFILE\fR |
75 | Pathname of the Varnish secret file. | 101 | Sets the pathname of the Varnish secret file. |
76 | .SH DEBUGGING | 102 | .SH DEBUGGING |
@@ -79,9 +105,9 @@ The module defines the following debugging tokens: | |||
79 | .B varnish_mib | 105 | .B varnish_mib |
80 | General debugging information. | 106 | Produces general debugging information. |
81 | .TP | 107 | .TP |
82 | .B varnish_mib:ban | 108 | .B varnish_mib:ban |
83 | Debug ban table loading. | 109 | Outputs verbose report about loading th ban table. |
84 | .TP | 110 | .TP |
85 | .B varnish_mib:vcli | 111 | .B varnish_mib:vcli |
86 | Varnish | 112 | Displays additional information regarding varnish |
87 | .B CLI | 113 | .B CLI |
@@ -90,8 +116,10 @@ interaction. | |||
90 | .B varnish_mib:vcli:transcript | 116 | .B varnish_mib:vcli:transcript |
91 | Enables full transcript of CLI interaction. | 117 | Enables full transcript of varnish CLI session. |
92 | .TP | 118 | .TP |
93 | .B varnish_mib:backend | 119 | .B varnish_mib:backend |
94 | Debug loading the backend information. | 120 | Outputs verbose information about loading the backend information. |
95 | .SH OIDS | 121 | .SH OIDS |
96 | The following OIDs are defined: | 122 | The following OIDs are defined in the |
123 | .B VARNISH-MIB.txt | ||
124 | file: | ||
97 | .SS Branch \(dqclient\(dq | 125 | .SS Branch \(dqclient\(dq |
@@ -124,5 +152,5 @@ to invalidate caches of all \fBpng\fR images: | |||
124 | 152 | ||
125 | .EE | ||
126 | snmpset \fBhostname\fR VARNISH\-MIB::clientBan.0 s 'req.url ~ \(dq\\.png$\(dq' | ||
127 | .EX | 153 | .EX |
154 | snmpset \fIhostname\fR VARNISH\-MIB::clientBan.0 s 'req.url ~ \(dq\\.png$\(dq' | ||
155 | .EE | ||
128 | .SS Branch \(dqbackend\(dq | 156 | .SS Branch \(dqbackend\(dq |
@@ -260,3 +288,4 @@ Number of sessions closed. | |||
260 | .B sessPipeline | 288 | .B sessPipeline |
261 | Session pipeline. This variable is available only in Varnish version \fR4.0\fR. | 289 | This OID was used in Varnish \fR4.1\fR, but disappeared from version |
290 | \fB5.0\fR. | ||
262 | .TP | 291 | .TP |
@@ -275,4 +304,4 @@ Number of session accept failures. | |||
275 | .B sessPipeOverflow | 304 | .B sessPipeOverflow |
276 | Number of session pipe overflows. This variable is available only in | 305 | This OID was used in Varnish \fR4.1\fR, but disappeared in version |
277 | Varnish version \fR4.0\fR. | 306 | \fB5.0\fR. |
278 | .SS Branch \(dqthreads\(dq | 307 | .SS Branch \(dqthreads\(dq |
@@ -369,3 +398,3 @@ seconds. It can be configured in the \fBsnmpd.conf\fR file | |||
369 | .SS Branch \(dqagent\(dq | 398 | .SS Branch \(dqagent\(dq |
370 | The \fBagent\fR branch is reserved for OIDs for | 399 | The \fBagent\fR branch is reserved for |
371 | implementation-specific management. It is not used currently. | 400 | implementation-specific management. It is not used currently. |