← Back to branch summary

~ubuntu-branches/ubuntu/trusty/varnish/trusty-proposed

« back to all changes in this revision

Viewing changes to bin/varnishstat/varnishstat.1

  • Committer: Package Import Robot
  • Author(s): Stig Sandbeck Mathisen, Stig Sandbeck Mathisen, Tollef Fog Heen
  • Date: 2013-05-05 15:53:14 UTC
  • mfrom: (0.1.16)
  • Revision ID: package-import@ubuntu.com-20130505155314-i99wuol99cfwzrtv
Tags: 3.0.3-1
http://bugs.debian.org/698577
http://bugs.debian.org/698577
[ Stig Sandbeck Mathisen ]
* New upstream release

[ Tollef Fog Heen ]
* Make varnishlog's and varnishncsa's init script exit with the exit
  status of status_of_proc to make them useful.  Fixes upstream trac
  #1226.

[ Stig Sandbeck Mathisen ]
* Do not rewrite /etc/default/varnish on upgrade.
  Thanks to Andreas Beckmann <anbe@debian.org> (Closes: 698577)
* Undo mangling of /etc/default/varnish that happened during lenny->squeeze
  upgrade.
  Thanks to Andreas Beckmann <anbe@debian.org> (Closes: 698577)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bin/varnishstat/varnishstat.1
1
1
.\" Man page generated from reStructeredText.
2
2
.
3
 
.TH VARNISHSTAT 1 "2010-06-1" "1.0" ""
 
3
.TH VARNISHSTAT 1 "2011-11-07" "1.1" ""
4
4
.SH NAME
5
5
varnishstat \- Varnish Cache statistics
6
6
.
32
32
..
33
33
.SH SYNOPSIS
34
34
.sp
35
 
varnishstat [\-1] [\-x] [\-f field_list] [\-l] [\-n varnish_name] [\-V] [\-w delay]
 
35
varnishstat [\-1] [\-x] [\-j] [\-f field_list] [\-l] [\-n varnish_name] [\-V] [\-w delay]
36
36
.SH DESCRIPTION
37
37
.sp
38
38
The varnishstat utility displays statistics from a running varnishd(1) instance.
41
41
.INDENT 0.0
42
42
.TP
43
43
.B \-1
44
 
.
45
 
Instead of presenting of a continuously updated display, print the statistics once and exit.
 
44
Instead of presenting of a continuously updated display, print the statistics to stdout.
46
45
.TP
47
46
.B \-f
48
 
.
49
47
A comma separated list of the fields to display.  If it starts with \(aq^\(aq it is used as an exclusion
50
48
list.
51
49
.TP
52
50
.B \-l
53
 
.
54
51
Lists the available fields to use with the \-f option.
55
52
.TP
56
53
.B \-n
57
 
.
58
54
Specifies the name of the varnishd instance to get logs from.  If \-n is not specified, the host name
59
55
is used.
60
56
.TP
61
57
.B \-V
62
 
.
63
58
Display the version number and exit.
64
59
.TP
65
60
.BI \-w \ delay
66
 
.
67
 
Wait delay seconds between updates.  The default is 1.
 
61
Wait delay seconds between updates.  The default is 1. Can also be used with \-1, \-x or \-j for repeated output.
68
62
.TP
69
63
.B \-x
70
 
.
71
 
Displays the result as XML once.
 
64
Displays the result as XML.
 
65
.TP
 
66
.B \-j
 
67
Displays the result as JSON.
72
68
.UNINDENT
73
69
.sp
74
70
The columns in the main display are, from left to right:
75
71
.INDENT 0.0
76
72
.IP 1. 3
77
 
.
78
73
Value
79
74
.IP 2. 3
80
 
.
81
75
Per\-second average in the period since last update, or a period if the value can not be averaged
82
76
.IP 3. 3
83
 
.
84
77
Per\-second average over process lifetime, or a period if the value can not be averaged
85
78
.IP 4. 3
86
 
.
87
79
Descriptive text
88
80
.UNINDENT
89
81
.sp
90
82
When using the \-1 option, the columns in the output are, from left to right:
91
83
.INDENT 0.0
92
84
.IP 1. 3
93
 
.
94
85
Symbolic entry name
95
86
.IP 2. 3
96
 
.
97
87
Value
98
88
.IP 3. 3
99
 
.
100
89
Per\-second average over process lifetime, or a period if the value can not be averaged
101
90
.IP 4. 3
102
 
.
103
91
Descriptive text
104
92
.UNINDENT
105
93
.sp
114
102
</stat>
115
103
.ft P
116
104
.fi
 
105
.sp
 
106
With \-j the output format is:
 
107
.sp
 
108
.nf
 
109
.ft C
 
110
{
 
111
  "timestamp": "YYYY\-MM\-DDTHH:mm:SS",
 
112
  "client_conn": {
 
113
      "value": 0, "flag": "a",
 
114
      "description": "Client connections accepted"
 
115
  },
 
116
  "client_drop": {
 
117
      "value": 0, "flag": "a",
 
118
      "description": "Connection dropped, no sess/wrk"
 
119
  },
 
120
  "LCK.backend.creat": {
 
121
      "type": "LCK", "ident": "backend", "value": 1,
 
122
      "flag": "a", "description": "Created locks"
 
123
  },
 
124
  [..]
 
125
}
 
126
.ft P
 
127
.fi
 
128
.sp
 
129
Timestamp is the time when the report was generated by varnishstat.
 
130
.sp
 
131
Repeated output with \-1, \-x or \-j will have a single empty line (\en) between each block of output.
117
132
.SH SEE ALSO
118
133
.INDENT 0.0
119
134
.IP \(bu 2
120
 
.
121
135
varnishd(1)
122
136
.IP \(bu 2
123
 
.
124
137
varnishhist(1)
125
138
.IP \(bu 2
126
 
.
127
139
varnishlog(1)
128
140
.IP \(bu 2
129
 
.
130
141
varnishncsa(1)
131
142
.IP \(bu 2
132
 
.
133
143
varnishtop(1)
134
144
.IP \(bu 2
135
 
.
136
145
curses(3)
137
146
.UNINDENT
138
147
.SH HISTORY
147
156
itself. See LICENCE for details.
148
157
.INDENT 0.0
149
158
.IP \(bu 2
150
 
.
151
159
Copyright (c) 2006 Verdens Gang AS
152
160
.IP \(bu 2
153
 
.
154
 
Copyright (c) 2006\-2008 Varnish Software AS
 
161
Copyright (c) 2006\-2011 Varnish Software AS
155
162
.UNINDENT
156
163
.SH AUTHOR
157
 
Dag-Erling Smørgrav, Per Buer
 
164
Dag-Erling Smørgrav, Per Buer, Lasse Karstensen
158
165
.\" Generated by docutils manpage writer.
159
166
.\" 
160
167
.