aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 579989afd8e77b7e7edc758e0b14d72189202596 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
Varnish-mib README
See the end of file for copying conditions.

* Introduction

This file contains brief information about configuring, testing
and using Varnish-mib. It is *not* intended as a replacement
for the documentation, and is provided as a brief reference only.
For a detailed documentation, please see the varnish-mib(8)
manpage.

If you are building varnish-mib from Git repository, jump to
the section GIT SOURCES, below.

* Overview

Varnish-mib is an agent for net-snmp snmpd daemon, that provides
access to Varnish Cache statistics.  It uses MIBs from varnishsnmp
project (http://varnishsnmp.sourceforge.net).

This and other versions of Varnish-mib is available for download from
<http://download.gnu.org.ua/release/varnish-mib>. The following table
describes the relation between the release number and the version
of Varnish API version it is written for:

  1.0, 1.1                Varnish 4.0 and 4.1
  1.2                     Varnish 4.0, 4.1, 5.1
  2.0                     Varnish 5.2.0
  3.0                     Varnish 5.2.1
  3.1, 4.0 (this release) Varnish 5.2.1 to 6.0.2
  
* Installation

In order to compile the package you need to have Net-SNMP and Varnish
installed.  The installation sequence is as usual:

  ./configure [options]
  make
  make install

(the last step normally requires root privileges).
Read the init/README file to select the initialization script for your
distribution and install it following the instructions from this file.

For generic options to configure, please see the file INSTALL.
Package-specific options are:

** --with-mibdir=DIR

Install MIBs (the file VARNISH-MIB.txt in DIR.  By default it is
installed in $prefix/share/snmp.

To start the daemon, add the following line to your snmpd.conf file:

  master agentx

Then start the agent:

  varnish-mib

See the varnish-mib(8) manual page for detailed discussion of command
line options and configuration directives available.

* GIT SOURCES

If you cloned the sources from GIT, you will need the following
additional tools in order to bootstrap the package:

 + Perl
 + mib2c
 + Perl module Inline::C
 + Flex

Make sure to check out the branch corresponding to the version of
Varnish you are using.  Run ./bootstrap.  Then, proceed as discussed
above.
 
* Bug reporting

Send bug reports and suggestions to <gray@gnu.org>


* Copyright information:

Copyright (C) 2014-2018 Sergey Poznyakoff

   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and this permission notice are preserved,
   thus giving the recipient permission to redistribute in turn.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them.


Local Variables:
mode: outline
paragraph-separate: "[ 	]*$"
version-control: never
End:

Return to:

Send suggestions and report system problems to the System administrator.