vstatdprobe

SYNOPSIS

vstatdprobe [-h] [-k log-key-prefix] [-p zmq_port] [-P file] [-d] [-F] [-g] vstatd_host

DESCRIPTION

The vstatdprobe utility reads varnishd(1) shared memory logs and produces log records to be consumed by vstatd(8).

Each log record is tagged with a set of keys defined through VCL in the configuration of the local varnishd(1) instance.

OPTIONS

Option Description
-h Display help. Displays a brief list of vstatdprobe’s options, along with default values.
-n varnish_name Specifies the name of the varnishd instance to get logs from. If -n is not specified, the host name is used.
-k log-key-prefix Prefix used for matching varnishlog key definitions. The default value is vcs-key.
-p port Remote port used when connecting to vstatd(8).
-P file Write the process’s PID to the specified file.
-m max_queue Limit for the number of messages vstatdprobe should queue in the event that vstatd is unreachable. After reaching this limit, messages will be dropped. A value of 0 means no limit.
-d Generate default URL, HOST, and ALL keys.
-F Run in foreground. Output will be written to stdout/stderr.
-g Output debug information.
-V Output version information.

VCL CONFIGURATION

Keys are defined in VCL, by writing an std.log() entry prefixed with the string vcs-key. Multiple definitions for the same request are permitted. Typically this is done in vcl_deliver. Use -d to have the default keys generated for you.

Unique counting

Setting up unique counting is done by issuing an std.log() entry prefixed with vcs-unique-id:.