doc/man: use specific revision date for each manual page
[lttng-tools.git] / doc / man / lttng-regenerate.1.txt
1 lttng-regenerate(1)
2 ===================
3 :revdate: 18 January 2018
4
5
6 NAME
7 ----
8 lttng-regenerate - Manage an LTTng tracing session's data regeneration
9
10
11 SYNOPSIS
12 --------
13 Regenerate the metadata of a session:
14
15 [verse]
16 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate metadata* [option:--session='SESSION']
17
18 Regenerate the state dump of a session:
19
20 [verse]
21 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate statedump* [option:--session='SESSION']
22
23 DESCRIPTION
24 -----------
25 The `lttng regenerate` command regenerates specific data of a tracing session.
26
27 As of this version, the `metadata` and `statedump` actions are
28 available.
29
30
31 Regenerating a tracing session's metadata
32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 The `lttng regenerate metadata` action can be used to resample the offset
34 between the system's monotonic clock and the wall-clock time.
35
36 This action is meant to be used to resample the wall-clock time following a
37 major link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP] correction.
38 As such, a system booting with an incorrect wall time can be traced before its
39 wall time is NTP-corrected. Regenerating the tracing session's metadata ensures
40 that trace viewers can accurately determine the events time relative to Unix
41 Epoch.
42
43
44 Regenerating a tracing session's state dump
45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46 The `lttng regenerate statedump` action can be used to collect up-to-date state
47 dump information during the tracing session. This is particularly useful in
48 snapshot (see man:lttng-snapshot(1)) or trace file rotation (see
49 man:lttng-enable-channel(1)) modes where the state dump information may be
50 lost.
51
52
53 include::common-cmd-options-head.txt[]
54
55
56 option:-s 'SESSION', option:--session='SESSION'::
57 Regenerate the data of the tracing session named 'SESSION'
58 instead of the current tracing session.
59
60
61 include::common-cmd-help-options.txt[]
62
63
64 LIMITATIONS
65 -----------
66 The `lttng regenerate metadata` command can only be used on kernel and
67 user space tracing sessions (using per-user buffering), in non-live
68 mode.
69
70 See man:lttng-enable-channel(1) for more information about
71 buffering schemes and man:lttng-create(1) for more information
72 about the different tracing session modes.
73
74
75 include::common-cmd-footer.txt[]
76
77
78 SEE ALSO
79 --------
80 man:lttng(1)
This page took 0.030642 seconds and 4 git commands to generate.