| 1 | lttng-crash(1) |
| 2 | ============== |
| 3 | :revdate: 2 April 2020 |
| 4 | |
| 5 | |
| 6 | NAME |
| 7 | ---- |
| 8 | lttng-crash - Recover and view LTTng 2 trace buffers in the event of a crash |
| 9 | |
| 10 | |
| 11 | SYNOPSIS |
| 12 | -------- |
| 13 | [verse] |
| 14 | *lttng-crash* [option:--extract='PATH' | option:--viewer='VIEWER'] [option:-v | option:-vv | option:-vvv] 'SHMDIR' |
| 15 | |
| 16 | |
| 17 | DESCRIPTION |
| 18 | ----------- |
| 19 | The https://lttng.org/[_Linux Trace Toolkit: next generation_] is an open |
| 20 | source software package used for correlated tracing of the Linux kernel, |
| 21 | user applications, and user libraries. |
| 22 | |
| 23 | LTTng consists of Linux kernel modules (for Linux kernel tracing) and |
| 24 | dynamically loaded libraries (for user application and library tracing). |
| 25 | |
| 26 | The `lttng-crash` command-line tool is used to recover and view |
| 27 | LTTng trace buffers in the event of a system crash. |
| 28 | |
| 29 | `lttng-crash` reads files within the directory 'SHMDIR' and does one |
| 30 | of: |
| 31 | |
| 32 | Without the option:--extract option:: |
| 33 | Launches a trace reader (see the option:--viewer option) to view the |
| 34 | recovered traces. |
| 35 | |
| 36 | With the option:--extract option:: |
| 37 | Extracts them as uncorrupted LTTng traces on the file system. |
| 38 | |
| 39 | 'SHMDIR' is the directory specified as the argument of the |
| 40 | nloption:--shm-path option of the man:lttng-create(1) command used to |
| 41 | create the tracing session for which to recover the traces. |
| 42 | |
| 43 | |
| 44 | OPTIONS |
| 45 | ------- |
| 46 | option:-x 'PATH', option:--extract='PATH':: |
| 47 | Extract recovered traces to path 'PATH'; do not execute the trace |
| 48 | viewer. |
| 49 | |
| 50 | option:-v, option:--verbose:: |
| 51 | Increase verbosity. |
| 52 | + |
| 53 | Three levels of verbosity are available, which are triggered by |
| 54 | appending additional `v` letters to the option |
| 55 | (that is, `-vv` and `-vvv`). |
| 56 | |
| 57 | option:-e 'VIEWER', option:--viewer='VIEWER':: |
| 58 | Use trace viewer 'VIEWER' to view the trace buffers. 'VIEWER' is the |
| 59 | absolute path to the viewer command to use, and it can contain |
| 60 | command arguments as well. The trace directory paths are passed to |
| 61 | the 'VIEWER' command as its last arguments. |
| 62 | + |
| 63 | Without this option, `lttng crash` uses man:babeltrace2(1) if it's |
| 64 | available. Otherwise, it tries to use man:babeltrace(1). |
| 65 | |
| 66 | |
| 67 | Program information |
| 68 | ~~~~~~~~~~~~~~~~~~~ |
| 69 | option:-h, option:--help:: |
| 70 | Show help. |
| 71 | |
| 72 | option:-V, option:--version:: |
| 73 | Show version. |
| 74 | |
| 75 | |
| 76 | EXIT STATUS |
| 77 | ----------- |
| 78 | *0*:: |
| 79 | Success |
| 80 | |
| 81 | *1*:: |
| 82 | Error |
| 83 | |
| 84 | *3*:: |
| 85 | Fatal error |
| 86 | |
| 87 | |
| 88 | include::common-footer.txt[] |
| 89 | |
| 90 | |
| 91 | SEE ALSO |
| 92 | -------- |
| 93 | man:lttng(1), |
| 94 | man:lttng-sessiond(8), |
| 95 | man:lttng-relayd(8), |
| 96 | man:lttng-ust(3), |
| 97 | man:babeltrace2(1) |