kylejeske/libvmod_mongodb

Varnish vmod logging and fetching into mongodb

vmod_mongodb

Varnish MongoDB Module

Author

Saiaman

Date

2012-10-01

Version

0.1

Manual section

3

SYNOPSIS

import mongodb;

DESCRIPTION

MongoDB Varnish vmod demonstrating how to write an out-of-tree Varnish vmod.

Implements the traditional Hello World as a vmod.

FUNCTIONS

hello

Prototype

hello(STRING S)

Return value

STRING

Description

Returns "Hello, " prepended to S

MongoDB

set resp.http.hello = mongodb.hello("World");

INSTALLATION

This is an mongodb skeleton for developing out-of-tree Varnish vmods. It implements the "Hello, World!" as a vmod callback. Not particularly useful in good hello world tradition, but demonstrates how to get the glue around a vmod working.

The source tree is based on autotools to configure the building, and does also have the necessary bits in place to do functional unit tests using the varnishtest tool.

Usage:

./configure VARNISHSRC=DIR [VMODDIR=DIR]

VARNISHSRC is the directory of the Varnish source tree for which to compile your vmod. Both the VARNISHSRC and VARNISHSRC/include will be added to the include search paths for your module.

Optionally you can also set the vmod install directory by adding VMODDIR=DIR (defaults to the pkg-config discovered directory from your Varnish installation).

Make targets:

• make - builds the vmod
• make install - installs your vmod in VMODDIR
• make check - runs the unit tests in src/tests/*.vtc

In your VCL you could then use this vmod along the following lines:

import mongodb;

sub vcl_deliver {
        # This sets resp.http.hello to "Hello, World"
        set resp.http.hello = mongodb.hello("World");
}

HISTORY

This manual page was released as part of the libvmod-mongodb package, demonstrating how to create an out-of-tree Varnish vmod.

COPYRIGHT

This document is licensed under the same license as the libvmod-mongodb project. See LICENSE for details.

• Copyright (c) 2011 Varnish Software