~ubuntu-branches/debian/sid/varnish/sid

« back to all changes in this revision

Viewing changes to doc/sphinx/reference/varnishncsa.rst

  • Committer: Bazaar Package Importer
  • Author(s): Stig Sandbeck Mathisen
  • Date: 2011-03-21 10:16:07 UTC
  • mfrom: (24.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20110321101607-528fzl583fqanas5
Tags: 2.1.5-2
Release for unstable

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
===========
 
2
varnishncsa
 
3
===========
 
4
 
 
5
---------------------------------------------------------
 
6
Display Varnish logs in Apache / NCSA combined log format
 
7
---------------------------------------------------------
 
8
 
 
9
:Author: Dag-Erling Smørgrav
 
10
:Date:   2010-05-31
 
11
:Version: 1.0
 
12
:Manual section: 1
 
13
 
 
14
 
 
15
SYNOPSIS
 
16
========
 
17
 
 
18
varnishncsa [-a] [-b] [-C] [-c] [-D] [-d] [-f] [-I regex] 
 
19
[-i tag] [-n varnish_name] [-P file] [-r file] [-V] 
 
20
[-w file] [-X regex] [-x tag]
 
21
 
 
22
DESCRIPTION
 
23
===========
 
24
 
 
25
The varnishncsa utility reads varnishd(1) shared memory logs and
 
26
presents them in the Apache / NCSA "combined" log format.
 
27
 
 
28
The following options are available:
 
29
 
 
30
-a          When writing to a file, append to it rather than overwrite it.
 
31
 
 
32
-b          Include log entries which result from communication with a 
 
33
            backend server.  If neither -b nor -c is
 
34
            specified, varnishncsa acts as if they both were.
 
35
 
 
36
-C          Ignore case when matching regular expressions.
 
37
 
 
38
-c          Include log entries which result from communication 
 
39
            with a client.  If neither -b nor -c is specified, 
 
40
            varnishncsa acts as if they both were.
 
41
 
 
42
-D          Daemonize.
 
43
 
 
44
-d          Process old log entries on startup.  Normally, varnishncsa 
 
45
            will only process entries which are written to the log 
 
46
            after it starts.
 
47
 
 
48
-f          Prefer the X-Forwarded-For HTTP header over client.ip in 
 
49
            the log output.
 
50
 
 
51
-I regex    Include log entries which match the specified regular 
 
52
            expression.  If neither -I nor -i is specified, 
 
53
            all log entries are included.
 
54
 
 
55
-i tag      Include log entries with the specified tag.  If neither -I nor 
 
56
            -i is specified, all log entries are included.
 
57
 
 
58
-n          Specifies the name of the varnishd instance to get logs 
 
59
            from.  If -n is not specified, the host name is used.
 
60
 
 
61
-P file     Write the process's PID to the specified file.
 
62
 
 
63
-r file     Read log entries from file instead of shared memory.
 
64
 
 
65
-V          Display the version number and exit.
 
66
 
 
67
-w file     Write log entries to file instead of displaying them.  
 
68
            The file will be overwritten unless the -a
 
69
            option was specified.
 
70
            
 
71
            If varnishncsa receives a SIGHUP while writing to a file, 
 
72
            it will reopen the file, allowing the old one to be 
 
73
            rotated away.
 
74
 
 
75
-X regex    Exclude log entries which match the specified 
 
76
            regular expression.
 
77
 
 
78
-x tag      Exclude log entries with the specified tag.
 
79
 
 
80
SEE ALSO
 
81
========
 
82
 
 
83
* varnishd(1)
 
84
* varnishhist(1)
 
85
* varnishlog(1)
 
86
* varnishstat(1)
 
87
* varnishtop(1)
 
88
 
 
89
HISTORY
 
90
=======
 
91
 
 
92
The varnishncsa utility was developed by Poul-Henning Kamp in
 
93
cooperation with Verdens Gang AS and Linpro AS.  This manual page was
 
94
written by Dag-Erling Smørgrav ⟨des@des.no⟩.
 
95
 
 
96
 
 
97
COPYRIGHT
 
98
=========
 
99
 
 
100
This document is licensed under the same licence as Varnish
 
101
itself. See LICENCE for details.
 
102
 
 
103
* Copyright (c) 2006 Verdens Gang AS
 
104
* Copyright (c) 2006-2008 Linpro AS
 
105
* Copyright (c) 2008-2010 Redpill Linpro AS
 
106
* Copyright (c) 2010 Varnish Software AS