[4.0] 3af02e6 Sort options, fix spelling and update formats
Lasse Karstensen
lkarsten at varnish-software.com
Thu Jan 15 16:35:43 CET 2015
commit 3af02e6707cd6ff31c71ba7a54357d4b557845c1
Author: Federico G. Schwindt <fgsch at lodoss.net>
Date: Thu Jan 8 03:39:05 2015 +0000
Sort options, fix spelling and update formats
diff --git a/doc/sphinx/reference/varnishstat.rst b/doc/sphinx/reference/varnishstat.rst
index 8940d80..b8b5ef8 100644
--- a/doc/sphinx/reference/varnishstat.rst
+++ b/doc/sphinx/reference/varnishstat.rst
@@ -65,7 +65,7 @@ CURSES MODE
===========
When neither -1, -j or -x options are given, the application starts up
-in curses mode. This shows a continously updated view of the counter
+in curses mode. This shows a continuously updated view of the counter
values, along with their description.
The top area shows process uptime information.
@@ -119,17 +119,17 @@ The following keys control the interactive display:
<PAGEDOWN> or <SPACE>
Navigate the counter list one page down.
+<d>
+ Toggle between showing and hiding unseen counters. Unseen
+ counters are those that has been zero for the entire runtime
+ of varnishstat. Defaults to hide unseen counters.
+
<g>
Go to the top of the counter list.
<G>
Go to the bottom of the counter list.
-<d>
- Toggle between showing and hiding unseen counters. Unseen
- counters are those that has been zero for the entire runtime
- of varnishstat. Defaults to hide unseen counters.
-
<v>
Cycle through the verbosity levels. Defaults to only showing
informational counters.
@@ -145,11 +145,17 @@ XML Output
When using the -x option, the output is::
- <stat>
- <name>FIELD NAME</name>
- <value>FIELD VALUE</value>
- <description>FIELD DESCRIPTION</description>
- </stat>
+ <varnishstat timestamp="YYYY-MM-DDTHH:mm:SS">
+ <stat>
+ <type>FIELD TYPE</type>
+ <ident>FIELD IDENT</ident>
+ <name>FIELD NAME</name>
+ <value>FIELD VALUE</value>
+ <flag>FIELD FORMAT</flag>
+ <description>FIELD DESCRIPTION</description>
+ </stat>
+ [..]
+ </varnishstat>
JSON OUTPUT
===========
@@ -158,24 +164,15 @@ With -j the output format is::
{
"timestamp": "YYYY-MM-DDTHH:mm:SS",
- "client_conn": {
- "value": 0, "flag": "a",
- "description": "Client connections accepted"
- },
- "client_drop": {
- "value": 0, "flag": "a",
- "description": "Connection dropped, no sess/wrk"
- },
- "LCK.backend.creat": {
- "type": "LCK", "ident": "backend", "value": 1,
- "flag": "a", "description": "Created locks"
- },
+ "FIELD NAME": {"type": "FIELD TYPE", "ident": "FIELD IDENT", "value": FIELD VALUE, "flag": "FIELD FORMAT", "description": "FIELD DESCRIPTION"},
[..]
}
-Timestamp is the time when the report was generated by varnishstat.
+Type and ident are optional. Timestamp is the time when the report was
+generated by varnishstat.
-Repeated output with -1, -x or -j will have a single empty line (\\n) between each block of output.
+Repeated output with -1, -x or -j will have a single empty line (\\n)
+between each block of output.
SEE ALSO
More information about the varnish-commit
mailing list