VARNISHLOG(1)

NAME
varnishlog - Display Varnish logs

SYNOPSIS

varnishlog [-a] [-A] [-b] [-c] [-C] [-d] [-D] [-g <session|request|vxid|raw>] [-h] [-i <taglist>] [-I <[taglist:]regex>] [-k <num>] [-L <limit>] [-n <dir>] [-N <filename>] [-P <file>] [-q <query>] [-r <filename>] [-t <seconds|off>] [-T <seconds>] [-v] [-V] [-w <filename>] [-x <taglist>] [-X <[taglist:]regex>]

OPTIONS

The following options are available:

-a  When writing output to a file with the -w option, append to it rather than overwrite it.

-A  When writing output to a file with the -w option, output data in ascii format.

-b  Only display transactions and log records coming from backend communication.

-c  Only display transactions and log records coming from client communication.

-C  Do all regular expression and string matching caseless.

-d  Process log records at the head of the log and exit.

-D  Daemonize.

-g <session|request|vxid|raw>
    The grouping of the log records. The default is to group by vxid.

-h  Print program usage and exit

-i <taglist>
    Include log records of these tags in output. Taglist is a comma-separated list of tag globs. Multiple -i options may be given.

    If a tag include option is the first of any tag selection options, all tags are first marked excluded.

-I <[taglist:]regex>
    Include by regex matching. Output only records matching taglist and regular expression. Applies to any tag if taglist is absent.

    If a tag include option is the first of any tag selection options, all tags are first marked excluded.

-k <num>
    Process this number of matching log transactions before exiting.

-L <limit>
    Sets the upper limit of incomplete transactions kept before the oldest transaction is force completed. A warning record is synthesized when this happens. This setting keeps an upper bound on the memory usage of running queries. Defaults to 1000 transactions.

-n <dir>
    Specify the varnishd working directory (also known as instance name) to get logs from. If -n is not specified, the host name is used.

-N <filename>
    Specify the filename of a stale VSM instance. When using this option the abandonment checking is disabled.

-P <file>
    Write the process' PID to the specified file.

-q <query>
    Specifies the VSL query to use.

-r <filename>
    Read log in binary file format from this file. The file can be created with varnishlog -w filename.

-t <seconds|off>
    Timeout before returning error on initial VSM connection. If set the VSM connection is retried every 0.5 seconds for this many seconds. If zero the connection is attempted only once and will fail immediately if unsuccessful. If set to "off", the connection will not fail, allowing the utility to start and wait indefinetely for the Varnish instance to appear. Defaults to 5 seconds.

-T <seconds>
    Sets the transaction timeout in seconds. This defines the maximum number of seconds elapsed between a Begin tag and the End tag. If the timeout expires, a warning record is synthesized and the transaction is force completed. Defaults to 120 seconds.

-v  Use verbose output on record set printing, giving the VXID on every log line. Without this option, the VXID will only be given on the header of that transaction.

-V  Print version information and exit.

-w <filename>
    Redirect output to file. The file will be overwritten unless the -a option was specified. If the application receives a SIGHUP in daemon mode the file will be reopened allowing the old one to be rotated away. The file can then be read by varnishlog and other tools with the -r option, unless the -A option was specified. This option is required when running in daemon mode.

-x <taglist>
    Exclude log records of these tags in output. Taglist is a comma-separated list of tag globs. Multiple -x options may be given.

-X <[taglist:]regex>
    Exclude by regex matching. Do not output records matching taglist and regular expression. Applies to any tag if taglist is absent.

SIGNALS

•   SIGHUP

    Rotate the log file (see -w option)

•   SIGUSR1

    Flush any outstanding transactions

SEE ALSO

•   varnishd(1)

•   varnishhist(1)

•   varnishncsa(1)

•   varnishstat(1)

•   varnishtop(1)

•   vsl(7)

•   vsl-query(7)

HISTORY

The varnishlog utility was developed by Poul-Henning Kamp <phk@phk.freebsd.dk> in cooperation with Verdens Gang AS and Varnish Software AS. This manual page was initially written by Dag-Erling Smørgrav, and later updated by Per Buer and Martin Blix Grydeland.

COPYRIGHT

This document is licensed under the same licence as Varnish itself. See LICENCE for details.

•   Copyright (c) 2006 Verdens Gang AS

•   Copyright (c) 2006-2015 Varnish Software AS