Version 2.0

9 files changed, 99 insertions, 37 deletions

diff --git a/src/Makefile.am b/src/Makefile.am
index 55cdb85..5c79dfc 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -1,5 +1,5 @@
 # This file is part of varnish-mib -*- automake -*-
-# Copyright (C) 2014-2015 Sergey Poznyakoff
+# Copyright (C) 2014-2018 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
diff --git a/src/VARNISH-MIB.txt b/src/VARNISH-MIB.txt
index 6b03f21..b7e77f1 100644
--- a/src/VARNISH-MIB.txt
+++ b/src/VARNISH-MIB.txt
@@ -20,14 +20,14 @@ IMPORTS
                 FROM SNMPv2-CONF;
 
 varnishMIB MODULE-IDENTITY
-        LAST-UPDATED "201802020845Z"
+        LAST-UPDATED "201802052024Z"
         ORGANIZATION "Shared Autonomous sYstems"
         CONTACT-INFO "Morten Hermanrud <mhe@say.no>
                       Sergey Poznyakoff <gray@gnu.org>
                      "
         DESCRIPTION 
                 "This MIB module defines objects for Varnish reverse web proxy."
-        REVISION "201802020845Z"
+        REVISION "201802052024Z"
         DESCRIPTION 
                 "Second revision."
         ::= { varnish 0 }
@@ -854,7 +854,7 @@ objectsPurges OBJECT-TYPE
         MAX-ACCESS read-only
         STATUS  current
         DESCRIPTION
-                "Number of purge operations executed"
+                "Number of purge operations executed."
         ::= { objects 8 }
 
 objectsObjPurged OBJECT-TYPE
diff --git a/src/auth.c b/src/auth.c
index e9abbe4..2ff6aba 100644
--- a/src/auth.c
+++ b/src/auth.c
@@ -1,5 +1,5 @@
 /* This file is part of varnish-mib -*- c -*-
-   Copyright (C) 2014-2015 Sergey Poznyakoff
+   Copyright (C) 2014-2018 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
diff --git a/src/backend.h b/src/backend.h
index d60f613..b13e644 100644
--- a/src/backend.h
+++ b/src/backend.h
@@ -5,8 +5,7 @@ typedef struct be_string {
 
 typedef void (*regfun_t)(be_string_t *, be_string_t *, be_string_t *, void *);
 
-void read_defs(const char *str, size_t len, regfun_t regfun, void *d);
-void varnish_backend_table_timeout_parser(const char *token, char *line);
+struct vsm;
 struct VSC_point;
 void backend_register(char const *name, size_t len, char const *param,
                       const struct VSC_point *vpt);
diff --git a/src/ban.c b/src/ban.c
index 1f4583b..a50b5a3 100644
--- a/src/ban.c
+++ b/src/ban.c
@@ -1,5 +1,5 @@
 /* This file is part of varnish-mib -*- c -*-
-   Copyright (C) 2014-2015 Sergey Poznyakoff
+   Copyright (C) 2014-2018 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
diff --git a/src/belex.l b/src/belex.l
index f35f114..bc0bfc0 100644
--- a/src/belex.l
+++ b/src/belex.l
@@ -1,3 +1,20 @@
+/* This file is part of varnish-mib
+   Copyright (C) 2018 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/>.
+*/
+
 %option nounput
 %option noinput
 
diff --git a/src/modconf.c b/src/modconf.c
index 85b2582..64177c1 100644
--- a/src/modconf.c
+++ b/src/modconf.c
@@ -1,3 +1,20 @@
+/* This file is part of varnish-mib
+   Copyright (C) 2018 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/>.
+*/
+
 #include "varnish_mib.h"
 #include <ctype.h>
 
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,5 +1,5 @@
 .\" This file is part of Varnish-mib -*- nroff -*-
-.\" Copyright (C) 2014-2016 Sergey Poznyakoff
+.\" Copyright (C) 2014-2018 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
@@ -13,9 +13,9 @@
 .\"
 .\" 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 "February 2, 2018" "varnish-mib"
+.TH VARNISH-MIB 8 "February 5, 2018" "varnish-mib"
 .SH NAME
-varnish\-mib \- net-snmp module for obtaining Varnish Cache statistics
+varnish\-mib \- Net-SNMP module for Varnish Cache monitoring
 .SH SYNOPSIS
 In \fBsnmpd.conf\fR(5):
 .PP
@@ -27,23 +27,49 @@ 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 module is written for Varnish
-version \fB5.\fIX\fR.
+the package was configured).  This version is written for Varnish
+\fB5.2.0\fR.
 .PP
-The module obtains most of the data using Varnish API, and \fBvarnishd\fR
-administrative interface. You should make sure that \fBsnmpd\fR is
-able to access both data sources.
+The values in the OID branches
+.BR client ,
+.BR total ,
+.BR master ,
+.BR session ,
+.BR threads ", and "
+.B objects
+are obtained from Varnish API.  
 .PP
-The user \fBsnmpd\fR runs as should be able to read contents of the
-\fB/var/lib/varnish/\fIHOSTNAME\fB/_.vsm_mgt\fR directory and read
-files located in it. It must also have read permission on the varnish
-secret file.
+The OID branches
+.BR backend ,
+.BR bans ", and "
+.B vcl
+are obtained using \fBvarnishd\fR administrative interface (similar
+to
+.BR varnishadm (8)).
+.PP
+To retrieve this information, the module must
+have enough permissions to scan the Varnish management directory and
+read files located in it.  This directory is normally named 
+\fB/var/lib/varnish/\fIHOSTNAME\fB/_.vsm_mgt\fR, where \fIHOSTNAME\fR
+stands for the server's hostname.  Unless
+.BR snmpd (8)
+is run as root, special measures should be undertaken in order to
+grant access rights.  For example, if the daemon runs as user
+\fBsnmp\fR, running the following two commands after starting
+\fBvarnishd\fR will do the trick:
+
+.EX
+  setfacl -m u:snmp:rx /var/lib/varnish/$(hostname)/_.vsm_mgt
+  setfacl -m u:snmp:r /var/lib/varnish/$(hostname)/_.vsm_mgt/*
+.EE
+.PP
+
 .SH CONFIGURATION OPTIONS
 Configuration statements specific to
 .B varnish\-mib
 must appear in the
 .B snmpd.conf
-file below the
+file, after the
 .B dlmod
 statement that loads the module.
 .PP
@@ -64,36 +90,38 @@ Update interval for \fBbackendTable\fR.  Default is 5 seconds.
 Sets timeout for I/O operations with Varnish administrative port.