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 Varnish source tree. At least Varnish 3.0.1 is required. Varnish 4.0 is OK, too. Supposing that the varnish source tree is available under /usr/src/varnish-3.0.1, run: ./configure --with-varnish-source=/usr/src/varnish-3.0.1 The `--with-varnish-source' option is mandatory: it tells configure where Varnish sources reside. 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. It is not installed by default, as its installation location differs considerably between various distributions. 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 * 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: