public inbox for linux-bluetooth@vger.kernel.org
 help / color / mirror / Atom feed
From: Luiz Augusto von Dentz <luiz.dentz@gmail.com>
To: linux-bluetooth@vger.kernel.org
Subject: [PATCH BlueZ v1 4/8] doc/btmon: Add a dedicated section for analyze mode
Date: Thu, 19 Feb 2026 11:22:26 -0500	[thread overview]
Message-ID: <20260219162230.3074355-4-luiz.dentz@gmail.com> (raw)
In-Reply-To: <20260219162230.3074355-1-luiz.dentz@gmail.com>

From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>

This adds a dedicated section for analyze mode.
---
 doc/btmon.rst | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/doc/btmon.rst b/doc/btmon.rst
index d93aa34a9412..66a97859a49e 100644
--- a/doc/btmon.rst
+++ b/doc/btmon.rst
@@ -672,6 +672,43 @@ Bluetooth Core Specification, Volume 1, Part F. btmon decodes all
 of them automatically in ``Status:`` and ``Reason:`` fields. The
 source mapping is in ``monitor/packet.c`` (``error2str_table``).
 
+ANALYZE MODE
+============
+
+The ``-a`` (``--analyze``) option reads a btsnoop file and produces a
+statistical summary instead of the full decoded trace.
+
+Usage
+-----
+
+.. code-block::
+
+   $ btmon -a hcidump.log
+
+Output Contents
+---------------
+
+Analyze mode reports, for each controller found in the trace:
+
+- **Packet counts**: Total HCI packets broken down by type (commands,
+  events, ACL, SCO, ISO, vendor diagnostics, system notes, user
+  logs, control messages).
+
+- **Per-connection statistics**: For each connection handle found:
+
+  - Connection type (BR-ACL, LE-ACL, BR-SCO, BR-ESCO, LE-ISO)
+  - Device address
+  - TX and RX packet counts and completion counts
+  - Latency statistics (min, max, median) in milliseconds
+  - Packet size statistics (min, max, average) in octets
+  - Throughput estimate in Kb/s
+
+- **Per-channel statistics**: For each L2CAP channel within a
+  connection, the same packet/latency/size statistics.
+
+- **Latency plots**: If ``gnuplot`` is installed, ASCII-art latency
+  distribution plots are rendered in the terminal.
+
 EXAMPLES
 ========
 
-- 
2.52.0


  parent reply	other threads:[~2026-02-19 16:22 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-19 16:22 [PATCH BlueZ v1 1/8] doc/btmon: Add missing documentation Luiz Augusto von Dentz
2026-02-19 16:22 ` [PATCH BlueZ v1 2/8] doc/btmon: Add dedicate sections for timestamp and frame number Luiz Augusto von Dentz
2026-02-19 16:22 ` [PATCH BlueZ v1 3/8] doc/btmon: Add connection tracking section Luiz Augusto von Dentz
2026-02-19 16:22 ` Luiz Augusto von Dentz [this message]
2026-02-19 16:22 ` [PATCH BlueZ v1 5/8] doc/btmon: Add a section for automated trace analysis Luiz Augusto von Dentz
2026-02-19 16:22 ` [PATCH BlueZ v1 6/8] monitor: Annotate ACL/SCO/ISO data with device address Luiz Augusto von Dentz
2026-02-19 16:22 ` [PATCH BlueZ v1 7/8] monitor: Print connection type in Disconnect Complete Luiz Augusto von Dentz
2026-02-19 16:22 ` [PATCH BlueZ v1 8/8] monitor: Add connection lifecycle to analyze summary Luiz Augusto von Dentz
2026-02-19 17:57 ` [BlueZ,v1,1/8] doc/btmon: Add missing documentation bluez.test.bot

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260219162230.3074355-4-luiz.dentz@gmail.com \
    --to=luiz.dentz@gmail.com \
    --cc=linux-bluetooth@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox