[master] a45319c50 doc: Release notes for varnishstat

Dridi Boukelmoune dridi.boukelmoune at gmail.com
Wed Sep 9 14:08:06 UTC 2020


commit a45319c50786d11056a140e9f874c00e522fbd13
Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
Date:   Wed Sep 9 16:04:23 2020 +0200

    doc: Release notes for varnishstat

diff --git a/doc/sphinx/whats-new/changes-trunk.rst b/doc/sphinx/whats-new/changes-trunk.rst
index afbbd0bb2..e1b2bb440 100644
--- a/doc/sphinx/whats-new/changes-trunk.rst
+++ b/doc/sphinx/whats-new/changes-trunk.rst
@@ -57,7 +57,23 @@ varnishadm
 varnishstat
 ===========
 
-**XXX changes concerning varnishstat(1) and/or varnish-counters(7)**
+A help screen is now available in interactive mode via the ``h`` key.
+
+Again in interactive mode, verbosity is increased from the default value
+during startup when the filtering of counters would otherwise display
+nothing.
+
+Filtering using the ``-f`` option is now deprecated in favor of ``-I`` and
+``-X`` options that are treated in order. While still present, the ``-f``
+option now also work in order instead of exclusive filters first and then
+inclusive filters. It was also wrongly documented as inclusive first.
+
+The JSON output slightly changed to more easily be consumed with programming
+languages that may map JSON objects to types. See upgrade notes for more
+details.
+
+There are two new ``MAIN.beresp_uncacheable`` and ``MAIN.beresp_shortlived``
+counters.
 
 varnishtest
 ===========
diff --git a/doc/sphinx/whats-new/upgrading-trunk.rst b/doc/sphinx/whats-new/upgrading-trunk.rst
index 6143fde99..a38b67457 100644
--- a/doc/sphinx/whats-new/upgrading-trunk.rst
+++ b/doc/sphinx/whats-new/upgrading-trunk.rst
@@ -30,4 +30,35 @@ to:**
 * Changes in public APIs that may require changes in VMODs or VAPI/VUT
   clients.
 
+varnishstat
+===========
+
+The JSON output (``-j`` option) changed to avoid having the ``timestamp``
+field mixed with the counters fields. As such the schema version was bumped
+from 0 to 1, and a ``version`` top-level field was added to keep track of
+future schema changes. Counters are in a new ``counters`` top-level field.
+
+Before::
+
+  {
+    "timestamp": "YYYY-mm-ddTHH:MM:SS",
+    "MGT.uptime": {
+      ...
+    },
+    ...
+  }
+
+After::
+
+  {
+    "version": 1,
+    "timestamp": "YYYY-mm-ddTHH:MM:SS",
+    "counters": {
+      "MGT.uptime": {
+        ...
+      },
+      ...
+    }
+  }
+
 *eof*


More information about the varnish-commit mailing list