~ubuntu-branches/ubuntu/saucy/varnish/saucy

« back to all changes in this revision

Viewing changes to doc/sphinx/reference/varnishtop.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
varnishtop
 
3
============
 
4
 
 
5
-------------------------
 
6
Varnish log entry ranking
 
7
-------------------------
 
8
 
 
9
:Author: Dag-Erling Smørgrav
 
10
:Date:   2010-05-31
 
11
:Version: 1.0
 
12
:Manual section: 1
 
13
 
 
14
 
 
15
 
 
16
SYNOPSIS
 
17
========
 
18
 
 
19
varnishtop [-1] [-b] [-C] [-c] [-d] [-f] [-I regex] 
 
20
[-i tag] [-n varnish_name] [-r file] [-V] [-X regex]
 
21
[-x tag]
 
22
 
 
23
DESCRIPTION
 
24
===========
 
25
 
 
26
The varnishtop utility reads varnishd(1) shared memory logs and
 
27
presents a continuously updated list of the most commonly occurring
 
28
log entries.  With suitable filtering using the -I, -i, -X and -x
 
29
options, it can be used to display a ranking of requested documents,
 
30
clients, user agents, or any other information which is recorded in
 
31
the log.
 
32
 
 
33
The following options are available:
 
34
 
 
35
-1          Instead of presenting of a continuously updated display, 
 
36
            print the statistics once and exit. Implies -d.
 
37
 
 
38
-b          Include log entries which result from communication 
 
39
            with a backend server.  If neither -b nor -c is
 
40
            specified, varnishtop acts as if they both were.
 
41
 
 
42
-C          Ignore case when matching regular expressions.
 
43
 
 
44
-c          Include log entries which result from communication 
 
45
            with a client.  If neither -b nor -c is specified, 
 
46
            varnishtop acts as if they both were.
 
47
 
 
48
-d          Process old log entries on startup.  Normally, varnishtop 
 
49
            will only process entries which are written to the log 
 
50
            after it starts.
 
51
 
 
52
-f          Sort and group only on the first field of each log entry.  
 
53
            This is useful when displaying e.g. stataddr entries, 
 
54
            where the first field is the client IP address.
 
55
 
 
56
-I regex    Include log entries which match the specified regular 
 
57
            expression.  If neither -I nor -i is specified, all log 
 
58
            entries are included.
 
59
 
 
60
-i tag      Include log entries with the specified tag.  If neither -I 
 
61
            nor -i is specified, all log entries are included.
 
62
 
 
63
-n          Specifies the name of the varnishd instance to get logs from.  
 
64
            If -n is not specified, the host name is used.
 
65
 
 
66
-r file     Read log entries from file instead of shared memory.
 
67
 
 
68
-V          Display the version number and exit.
 
69
 
 
70
-X regex    Exclude log entries which match the specified regular expression.
 
71
 
 
72
-x tag      Exclude log entries with the specified tag.
 
73
 
 
74
EXAMPLES
 
75
========
 
76
 
 
77
The following example displays a continuously updated list of the most
 
78
frequently requested URLs:::
 
79
 
 
80
  varnishtop -i RxURL
 
81
 
 
82
The following example displays a continuously updated list of the most
 
83
commonly used user agents:::
 
84
 
 
85
  varnishtop -i RxHeader -C -I ^User-Agent
 
86
 
 
87
SEE ALSO
 
88
========
 
89
 
 
90
* varnishd(1)
 
91
* varnishhist(1)
 
92
* varnishlog(1)
 
93
* varnishncsa(1)
 
94
* varnishstat(1)
 
95
 
 
96
HISTORY
 
97
=======
 
98
 
 
99
The varnishtop utility was originally developed by Poul-Henning Kamp
 
100
in cooperation with Verdens Gang AS and Linpro AS, and later
 
101
substantially rewritten by Dag-Erling Smørgrav.  This manual page was
 
102
written by Dag-Erling Smørgrav.
 
103
 
 
104
COPYRIGHT
 
105
=========
 
106
 
 
107
This document is licensed under the same licence as Varnish
 
108
itself. See LICENCE for details.
 
109
 
 
110
* Copyright (c) 2006 Verdens Gang AS
 
111
* Copyright (c) 2006-2008 Linpro AS
 
112
* Copyright (c) 2008-2010 Redpill Linpro AS
 
113
* Copyright (c) 2010 Varnish Software AS