| Manual section: | 3 |
|---|
import xcounter [as name] [from "path"]
DURATION elapsed()
new xvsc = xcounter.vsc(ENUM format, ENUM type, ENUM level, STRING oneliner, BOOL hidecold, BOOL hidevclname, STRING groupname)
VOID xvsc.incr(INT d, BOOL threadsafe)
VOID xvsc.decr(INT d, BOOL threadsafe)
VOID xvsc.set(INT)
INT xvsc.get()
| Author: | Shohei Tanaka(@xcir) |
|---|---|
| Date: | 2022-09-16 |
| Version: | 72.5 |
| Support Varnish Version: | 6.0.x~ |
| Check Varnish Version: | see .github/workflows/test.yml |
| Manual section: | 3 |
import xcounter;
This branch is for Vinyl Cache 9.0.x~
[varnish-version].[library-version]
65.1 is v1 for Varnish6.5.x
[VRT-version].[Source-version]
120.65.1 is 65.1 for VRT12.0
| VRT Version | Varnish Version |
| 16.0 | 7.2.x |
| 15.0 | 7.1.x |
| 14.0 | 7.0.x |
| 13.0 | 6.6.x |
| 12.0 | 6.5.x |
| 11.0 | 6.4.x |
| 10.0 | 6.3.x |
| 9.0 | 6.2.x |
| 8.0 | 6.1.x |
| 7.1 | 6.0.4~6.0.x |
| 7.0 | 6.0.0~6.0.3 |
vmod_xcounter enables custom counter in Varnish.
For example, count to the number of requests per domain.
vcl sample:
import xcounter;
sub vcl_init {
new example_net = xcounter.vsc();
}
sub vcl_recv {
if(req.http.host ~ "^example\.net$"){
example_net.incr(1);
}
}
varnishstat output
$ sudo varnishstat -1 -f "XCNT*" XCNT.reload_20181118_042545_24957.example_net.val 1 . xcounter
The counter is linked to the VCL.
Add new entry per new(reload) VCL.
- Description
- Get elapsed time.
- Example
- if(xcnt.elapsed() > 1s){...}
new xvsc = xcounter.vsc(ENUM format, ENUM type, ENUM level, STRING oneliner, BOOL hidecold, BOOL hidevclname, STRING groupname)
new xvsc = xcounter.vsc(
ENUM {bitmap, bytes, duration, integer} format=integer,
ENUM {bitmap, counter, gauge} type=counter,
ENUM {info, debug, diag} level=info,
STRING ,
BOOL hidecold=1,
BOOL hidevclname=0,
STRING groupname=""
)
- Description
Create a counter.
Counter name format
XCNT.boot.group.object.val ("XCNT.%s.%s%s.val", vclname, groupname, objectname)formatCounter format.typeCounter type.levelCounter level.onelinerCounter description.hidecoldHide counter, if state of vcl becomes cold.hidevclnameDo not include vclname(boot,reload... etc) in counter name, if set to true.groupnameAdd group name.- Example
- new xcnt = xcounter.vsc();
- Description
Increment vlaue.
Negative values are ignored
- Example
- xcnt.incr(1);
- Description
Decrement value.
Negative values are ignored.
- Example
- xcnt.decr(1);
- Description
- Set value.
- Example
- xcnt.set(1024);
- Description
- Get current value.
- Example
- if(xcnt.get() > 1024){...}
For other platforms you would use compilation.
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.
Building requires the Varnish header files and uses pkg-config to find the necessary paths.
Usage:
./bootstrap
If you have installed Varnish to a non-standard directory, call
bootstrap with PKG_CONFIG_PATH pointing to
the appropriate path. For instance, when varnishd configure was called
with --prefix=$PREFIX, use
export PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig
export ACLOCAL_PATH=${PREFIX}/share/aclocal
The module will inherit its prefix from Varnish, unless you specify a
different --prefix when running the configure script for this
module.
Make targets:
- make - builds the vmod.
- make install - installs your vmod.
- make check - runs the unit tests in
src/vtc/*.vtc. - make distcheck - run check and prepare a tarball of the vmod.
If you build a dist tarball, you don't need any of the autotools or pkg-config. You can build the module simply by running:
./configure make
This function is beta.
Usage:
./sw_vrt.sh [VRT version] debuild -us -uc
vmod-packager allows you to create VMODs with various distribution and Varnish version combinations.
Sample:
xcir@build01:~/git/tmp$ git clone git@github.com:xcir/vmod-packager.git
xcir@build01:~/git/tmp$ cd vmod-packager/src/
xcir@build01:~/git/tmp/vmod-packager/src$ git clone git@github.com:xcir/libvmod-xcounter.git
xcir@build01:~/git/tmp/vmod-packager/src$ cd ..
## RPM sample
xcir@build01:~/git/tmp/vmod-packager$ ./vmod-packager.sh -d centos_stream9 src/libvmod-xcounter/
Sending build context to Docker daemon 644.6kB
Step 1/6 : FROM quay.io/centos/centos:stream9
...
##################################################
docker image: vmod-packager/centos_stream9:7.2.0-1
Dist: centos_stream9
Varnish Version: 7.2.0
Varnish VRT: 160
VMOD name: libvmod-xcounter
VMOD Version: 160.72.5
Status: SUCCESS
##################################################
VMOD output:
pkgs/rpms/libvmod-xcounter/libvmod-xcounter-160.72.5-1.el9.x86_64.rpm
pkgs/rpms/libvmod-xcounter/libvmod-xcounter-160.72.5-1.el9.src.rpm
## DEB sample
xcir@build01:~/git/tmp/vmod-packager$ ./vmod-packager.sh -v 7.1.0 -d jammy src/libvmod-xcounter/
Sending build context to Docker daemon 831kB
Step 1/4 : FROM ubuntu:jammy
...
##################################################
docker image: vmod-packager/jammy:7.1.0-1
Dist: jammy
Varnish Version: 7.1.0
Varnish VRT: 150
VMOD name: libvmod-xcounter
VMOD Version: 150.72.5
Status: SUCCESS
##################################################
VMOD output:
pkgs/debs/libvmod-xcounter/libvmod-xcounter-dbgsym_150.72.5~jammy-1_amd64.ddeb
pkgs/debs/libvmod-xcounter/libvmod-xcounter_150.72.5~jammy-1_amd64.build
pkgs/debs/libvmod-xcounter/libvmod-xcounter_150.72.5~jammy-1_amd64.buildinfo
pkgs/debs/libvmod-xcounter/libvmod-xcounter_150.72.5~jammy-1_amd64.changes
pkgs/debs/libvmod-xcounter/libvmod-xcounter_150.72.5~jammy-1_amd64.deb
xcir@build01:~/git/tmp/vmod-packager$ tree pkgs/
pkgs/
├── arch
├── debs
│ └── libvmod-xcounter
│ ├── libvmod-xcounter_150.72.5~jammy-1_amd64.build
│ ├── libvmod-xcounter_150.72.5~jammy-1_amd64.buildinfo
│ ├── libvmod-xcounter_150.72.5~jammy-1_amd64.changes
│ ├── libvmod-xcounter_150.72.5~jammy-1_amd64.deb
│ └── libvmod-xcounter-dbgsym_150.72.5~jammy-1_amd64.ddeb
└── rpms
└── libvmod-xcounter
├── libvmod-xcounter-160.72.5-1.el9.src.rpm
└── libvmod-xcounter-160.72.5-1.el9.x86_64.rpm
5 directories, 7 files
By default, the vmod configure script installs the built vmod in the
directory relevant to the prefix. The vmod installation directory can be
overridden by passing the vmoddir variable to make install.
autogen.sh: error: possibly undefined macro: AC_MSG_ERROR
Install
autoconf-archiveconfigure: error: Need varnish.m4 -- see README.rst
Check whether
PKG_CONFIG_PATHandACLOCAL_PATHwere set correctly before callingautogen.shandconfigureIncompatibilities with different Varnish Cache versions
Make sure you build this vmod against its correspondent Varnish Cache version. For instance, to build against Varnish Cache 4.1, this vmod must be built from branch 4.1.
Require GCC
This vmod using GCC Atomic builtins.
Copyright Shohei Tanaka(@xcir) (c) 2018. https://github.com/xcir/libvmod-xcounter/