summaryrefslogtreecommitdiffabout
path: root/README
blob: b961dcd33c90ac425ea01b2616ac6f426fc38637 (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
103
104
105
106
107
108
109
110
Vmod-binlog README
Copyright (C) 2013-2014 Sergey Poznyakoff
See the end of file for copying conditions.

* Introduction

This file contains brief information about configuring, testing
and using vmod-binlog. It is *not* intended as a replacement
for the documentation, and is provided as a brief reference only.
For accessing complete vmod-binlog documentation, see the section
'Documentation' below.

* Overview

Vmod-binlog is a module for Varnish Cache.  It provides support for
writing binary log files from VCL scripts.

A binary log file consists of an arbitrary number of equally sized
records.  Each record contains a UNIX timestamp in binary form and
arbitrary user-defined  data.  Such files are convenient for storing
big amounts of information arriving at high rates.

The package provides the module itself and the utilities for listing
and searching in binary log files.

* Installation

In order to compile the package you need to have the varnishd and varnishapi
packages installed.

Supposing that condition is met, run:

  ./configure

It should be able to automatically find the necessary components. In case 
it doesn't, tweak the configuration variables as necessary. The most 
important one is PKG_CONFIG_PATH, which contains a path (in the UNIX sense)
where the .pc files are located. It should contain a directory where the
'varnishapi.pc' file lives. Example usage:

  ./configure PKG_CONFIG_PATH=/usr/local/varnish/lib/pkgconfig:$PKG_CONFIG_PATH

Please read the file INSTALL for a detailed discussion of available variables
and command line options.

Once configured, do

  make

This will build the module.  After this step you can optionally run
'make test' to test the package.

Finally, run the following command as root:

  make install

This package contains the 'magic' file for the file(1) utility - doc/magic.  
It is not installed by default, as its installation location differs
considerably between various distributions.  Usually, appending its content
to /etc/magic will do the job:

  cat doc/magic >> /etc/magic

See the documentation in your distribution for detailed instructions.

After properly installing this file, you will be able to use file(1)
to briefly examine binary logs.  For example:

  $ file 10.log
  10.log: NXC binary log file, version 1.0, format L3, 81004 records
  
* Documentation

The following manual pages will be available after successful install:

   vmod-binlog(3)
   binlogcat(1)
   binlogsel(1)
   
You can also read them without actually installing the module, .e.g.:
`man doc/vmod-binlog.3'.
  
An online copy of the documentation is available from
http://www.gnu.org.ua/software/vmod-binlog.

* Bug reporting

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


* Copyright information:

Copyright (C) 2013-2014 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.