2.8-2.12: "lost packets" is only meaningful for non-snapshot modes

With a snapshot mode tracing session, the channels are in "overwrite"
mode automatically: the tracers continuously overwrite the oldest
sub-buffers, incrementing their sequence numbers meanwhile.

The overwritten sub-buffers between two snapshots are not lost packets
in this case: they were not meant to be recorded in the first place.

Fix `lttng-docs-2.8.txt` to `lttng-docs-2.12.txt` to clarify this, with
new internal links to tracing session mode descriptions.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/2.10/lttng-docs-2.10.txt b/2.10/lttng-docs-2.10.txt
index 2a5c2f4547b15d5366591e6f36c1485d7bf26207..375fcf5cf4d716cae7c746e04ca242b8335203be 100644 (file)
--- a/2.10/lttng-docs-2.10.txt
+++ b/2.10/lttng-docs-2.10.txt
@@ -1,7 +1,7 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
-v2.10, 18 October 2019
+v2.10, 25 February 2021
 
 
 include::../common/copyright.txt[]
@@ -1022,11 +1022,11 @@ LTTng can send the generated trace data to different locations. The
 _tracing session mode_ dictates where to send it. The following modes
 are available in LTTng{nbsp}{revision}:
 
-Local mode::
+[[local-mode]]Local mode::
   LTTng writes the traces to the file system of the machine being traced
   (target system).
 
-Network streaming mode::
+[[net-streaming-mode]]Network streaming mode::
   LTTng sends the traces over the network to a
   <<lttng-relayd,relay daemon>> running on a remote system.
 
@@ -1037,7 +1037,7 @@ Snapshot mode::
   or to send it over the network to a <<lttng-relayd,relay daemon>>
   running on a remote system.
 
-Live mode::
+[[live-mode]]Live mode::
   This mode is similar to the network streaming mode, but a live
   trace viewer can connect to the distant relay daemon to
   <<lttng-live,view event records as LTTng generates them>> by
@@ -1202,13 +1202,18 @@ discard mode, the tracer only discards the event record that doesn't
 fit.
 
 In discard mode, LTTng increments a count of lost event records when an
-event record is lost and saves this count to the trace. In overwrite
-mode, since LTTng 2.8, LTTng increments a count of lost sub-buffers when
-a sub-buffer is lost and saves this count to the trace. In this mode,
-the exact number of lost event records in those lost sub-buffers is not
-saved to the trace. Trace analyses can use the trace's saved discarded
-event record and sub-buffer counts to decide whether or not to perform
-the analyses even if trace data is known to be missing.
+event record is lost and saves this count to the trace. Since
+LTTng{nbsp}2.8, in overwrite mode, LTTng writes to a given sub-buffer
+its sequence number within its data stream. With a <<local-mode,local>>,
+<<net-streaming-mode,network streaming>>, or <<live-mode,live>>
+<<tracing-session,tracing session>>, a trace reader can use such
+sequence numbers to report lost packets. In overwrite mode, LTTng
+doesn't write to the trace the exact number of lost event records in
+those lost sub-buffers.
+
+Trace analyses can use saved discarded event record and sub-buffer
+(packet) counts of the trace to decide whether or not to perform the
+analyses even if trace data is known to be missing.
 
 There are a few ways to decrease your probability of losing event
 records.

diff --git a/2.11/lttng-docs-2.11.txt b/2.11/lttng-docs-2.11.txt
index ea3f409a249c42bc68d5b5497a490930a8e70afc..9d5d08393ee953812bfd979068d119031dac4a24 100644 (file)
--- a/2.11/lttng-docs-2.11.txt
+++ b/2.11/lttng-docs-2.11.txt
@@ -1,7 +1,7 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
-v2.11, 5 August 2020
+v2.11, 25 February 2021
 
 
 include::../common/copyright.txt[]
@@ -1303,11 +1303,11 @@ LTTng can send the generated trace data to different locations. The
 _tracing session mode_ dictates where to send it. The following modes
 are available in LTTng{nbsp}{revision}:
 
-Local mode::
+[[local-mode]]Local mode::
   LTTng writes the traces to the file system of the machine it traces
   (target system).
 
-Network streaming mode::
+[[net-streaming-mode]]Network streaming mode::
   LTTng sends the traces over the network to a
   <<lttng-relayd,relay daemon>> running on a remote system.
 
@@ -1318,7 +1318,7 @@ Snapshot mode::
   target's file system or to send it over the network to a
   <<lttng-relayd,relay daemon>> running on a remote system.
 
-Live mode::
+[[live-mode]]Live mode::
   This mode is similar to the network streaming mode, but a live
   trace viewer can connect to the distant relay daemon to
   <<lttng-live,view event records as LTTng generates them>>.
@@ -1476,13 +1476,18 @@ discard mode, the tracer only discards the event record that doesn't
 fit.
 
 In discard mode, LTTng increments a count of lost event records when an
-event record is lost and saves this count to the trace. In overwrite
-mode, since LTTng{nbsp}2.8, LTTng increments a count of lost sub-buffers
-when a sub-buffer is lost and saves this count to the trace. In this
-mode, LTTng does not write to the trace the exact number of lost event
-records in those lost sub-buffers. Trace analyses can use the trace's
-saved discarded event record and sub-buffer counts to decide whether or
-not to perform the analyses even if trace data is known to be missing.
+event record is lost and saves this count to the trace. Since
+LTTng{nbsp}2.8, in overwrite mode, LTTng writes to a given sub-buffer
+its sequence number within its data stream. With a <<local-mode,local>>,
+<<net-streaming-mode,network streaming>>, or <<live-mode,live>>
+<<tracing-session,tracing session>>, a trace reader can use such
+sequence numbers to report lost packets. In overwrite mode, LTTng
+doesn't write to the trace the exact number of lost event records in
+those lost sub-buffers.
+
+Trace analyses can use saved discarded event record and sub-buffer
+(packet) counts of the trace to decide whether or not to perform the
+analyses even if trace data is known to be missing.
 
 There are a few ways to decrease your probability of losing event
 records.

diff --git a/2.12/lttng-docs-2.12.txt b/2.12/lttng-docs-2.12.txt
index d80ba3057249f04637d3311265deb8c29d5ee8b8..4b879478158f6ee3ad11e39a80eb9a646d8085aa 100644 (file)
--- a/2.12/lttng-docs-2.12.txt
+++ b/2.12/lttng-docs-2.12.txt
@@ -1441,11 +1441,11 @@ LTTng can send the generated trace data to different locations. The
 _tracing session mode_ dictates where to send it. The following modes
 are available in LTTng{nbsp}{revision}:
 
-Local mode::
+[[local-mode]]Local mode::
   LTTng writes the traces to the file system of the machine it traces
   (target system).
 
-Network streaming mode::
+[[net-streaming-mode]]Network streaming mode::
   LTTng sends the traces over the network to a
   <<lttng-relayd,relay daemon>> running on a remote system.
 
@@ -1457,7 +1457,7 @@ that is, a copy of the current sub-buffers of the tracing session, and
 to write it to the file system of the target or to send it over the
 network to a <<lttng-relayd,relay daemon>> running on a remote system.
 
-Live mode::
+[[live-mode]]Live mode::
   This mode is similar to the network streaming mode, but a live
   trace viewer can connect to the distant relay daemon to
   <<lttng-live,view event records as LTTng generates them>>.
@@ -1615,14 +1615,18 @@ discard mode, the tracer only discards the event record that doesn't
 fit.
 
 In discard mode, LTTng increments a count of lost event records when an
-event record is lost and saves this count to the trace. In overwrite
-mode, since LTTng{nbsp}2.8, LTTng increments a count of lost sub-buffers
-when a sub-buffer is lost and saves this count to the trace. In this
-mode, LTTng doesn't write to the trace the exact number of lost event
-records in those lost sub-buffers. Trace analyses can use saved
-discarded event record and sub-buffer counts of the trace to decide
-whether or not to perform the analyses even if trace data is known to be
-missing.
+event record is lost and saves this count to the trace. Since
+LTTng{nbsp}2.8, in overwrite mode, LTTng writes to a given sub-buffer
+its sequence number within its data stream. With a <<local-mode,local>>,
+<<net-streaming-mode,network streaming>>, or <<live-mode,live>>
+<<tracing-session,tracing session>>, a trace reader can use such
+sequence numbers to report lost packets. In overwrite mode, LTTng
+doesn't write to the trace the exact number of lost event records in
+those lost sub-buffers.
+
+Trace analyses can use saved discarded event record and sub-buffer
+(packet) counts of the trace to decide whether or not to perform the
+analyses even if trace data is known to be missing.
 
 There are a few ways to decrease your probability of losing event
 records.

diff --git a/2.8/lttng-docs-2.8.txt b/2.8/lttng-docs-2.8.txt
index f8f6d92f9aa46c23edd959f8440a402c3c17c653..9ccf4caa8017f6bc9e250bd3f6398c4f08fb0897 100644 (file)
--- a/2.8/lttng-docs-2.8.txt
+++ b/2.8/lttng-docs-2.8.txt
@@ -1,7 +1,7 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
-v2.8, 24 July 2017
+v2.8, 25 February 2021
 
 
 include::../common/copyright.txt[]
@@ -1074,11 +1074,11 @@ LTTng can send the generated trace data to different locations. The
 _tracing session mode_ dictates where to send it. The following modes
 are available in LTTng{nbsp}{revision}:
 
-Local mode::
+[[local-mode]]Local mode::
   LTTng writes the traces to the file system of the machine being traced
   (target system).
 
-Network streaming mode::
+[[net-streaming-mode]]Network streaming mode::
   LTTng sends the traces over the network to a
   <<lttng-relayd,relay daemon>> running on a remote system.
 
@@ -1089,7 +1089,7 @@ Snapshot mode::
   or to send it over the network to a <<lttng-relayd,relay daemon>>
   running on a remote system.
 
-Live mode::
+[[live-mode]]Live mode::
   This mode is similar to the network streaming mode, but a live
   trace viewer can connect to the distant relay daemon to
   <<lttng-live,view event records as LTTng generates them>> by
@@ -1245,13 +1245,18 @@ discard mode, the tracer only discards the event record that doesn't
 fit.
 
 In discard mode, LTTng increments a count of lost event records when an
-event record is lost and saves this count to the trace. In overwrite
-mode, since LTTng 2.8, LTTng increments a count of lost sub-buffers when
-a sub-buffer is lost and saves this count to the trace. In this mode,
-the exact number of lost event records in those lost sub-buffers is not
-saved to the trace. Trace analyses can use the trace's saved discarded
-event record and sub-buffer counts to decide whether or not to perform
-the analyses even if trace data is known to be missing.
+event record is lost and saves this count to the trace. Since
+LTTng{nbsp}2.8, in overwrite mode, LTTng writes to a given sub-buffer
+its sequence number within its data stream. With a <<local-mode,local>>,
+<<net-streaming-mode,network streaming>>, or <<live-mode,live>>
+<<tracing-session,tracing session>>, a trace reader can use such
+sequence numbers to report lost packets. In overwrite mode, LTTng
+doesn't write to the trace the exact number of lost event records in
+those lost sub-buffers.
+
+Trace analyses can use saved discarded event record and sub-buffer
+(packet) counts of the trace to decide whether or not to perform the
+analyses even if trace data is known to be missing.
 
 There are a few ways to decrease your probability of losing event
 records.

diff --git a/2.9/lttng-docs-2.9.txt b/2.9/lttng-docs-2.9.txt
index dcff639d5d9fa1a6d224333b75efbeb2c810913f..53d575f2d1edad7c5eedf1251defe4ac67b7a281 100644 (file)
--- a/2.9/lttng-docs-2.9.txt
+++ b/2.9/lttng-docs-2.9.txt
@@ -1,7 +1,7 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
-v2.9, 22 January 2018
+v2.9, 25 February 2021
 
 
 include::../common/copyright.txt[]
@@ -1033,11 +1033,11 @@ LTTng can send the generated trace data to different locations. The
 _tracing session mode_ dictates where to send it. The following modes
 are available in LTTng{nbsp}{revision}:
 
-Local mode::
+[[local-mode]]Local mode::
   LTTng writes the traces to the file system of the machine being traced
   (target system).
 
-Network streaming mode::
+[[net-streaming-mode]]Network streaming mode::
   LTTng sends the traces over the network to a
   <<lttng-relayd,relay daemon>> running on a remote system.
 
@@ -1048,7 +1048,7 @@ Snapshot mode::
   or to send it over the network to a <<lttng-relayd,relay daemon>>
   running on a remote system.
 
-Live mode::
+[[live-mode]]Live mode::
   This mode is similar to the network streaming mode, but a live
   trace viewer can connect to the distant relay daemon to
   <<lttng-live,view event records as LTTng generates them>> by
@@ -1204,13 +1204,18 @@ discard mode, the tracer only discards the event record that doesn't
 fit.
 
 In discard mode, LTTng increments a count of lost event records when an
-event record is lost and saves this count to the trace. In overwrite
-mode, since LTTng 2.8, LTTng increments a count of lost sub-buffers when
-a sub-buffer is lost and saves this count to the trace. In this mode,
-the exact number of lost event records in those lost sub-buffers is not
-saved to the trace. Trace analyses can use the trace's saved discarded
-event record and sub-buffer counts to decide whether or not to perform
-the analyses even if trace data is known to be missing.
+event record is lost and saves this count to the trace. Since
+LTTng{nbsp}2.8, in overwrite mode, LTTng writes to a given sub-buffer
+its sequence number within its data stream. With a <<local-mode,local>>,
+<<net-streaming-mode,network streaming>>, or <<live-mode,live>>
+<<tracing-session,tracing session>>, a trace reader can use such
+sequence numbers to report lost packets. In overwrite mode, LTTng
+doesn't write to the trace the exact number of lost event records in
+those lost sub-buffers.
+
+Trace analyses can use saved discarded event record and sub-buffer
+(packet) counts of the trace to decide whether or not to perform the
+analyses even if trace data is known to be missing.
 
 There are a few ways to decrease your probability of losing event
 records.