Skip to content

Commit ef75e7c

Browse files
authored
Add tt coredump (#3139)
Resolves #3000
1 parent 1409c55 commit ef75e7c

File tree

2 files changed

+77
-1
lines changed

2 files changed

+77
-1
lines changed

doc/reference/tt_cli/commands.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ help for the given command.
3838
- Print the contents of ``.snap`` or ``.xlog`` files into stdout
3939
* - :doc:`play <play>`
4040
- Play the contents of ``.snap`` or ``.xlog`` files to another Tarantool instance
41+
* - :doc:`coredump <coredump>`
42+
- Manipulate Tarantool core dumps
4143

4244
.. toctree::
4345
:hidden:
@@ -54,4 +56,5 @@ help for the given command.
5456
connect <connect>
5557
rocks <rocks>
5658
cat <cat>
57-
play <play>
59+
play <play>
60+
coredump <coredump>

doc/reference/tt_cli/coredump.rst

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
.. _tt-coredump:
2+
3+
Manipulating Tarantool core dumps
4+
=================================
5+
6+
.. code-block:: bash
7+
8+
tt coredump COMMAND [ARGUMENT]
9+
10+
``tt coredump`` provides commands for manipulating Tarantool core dumps.
11+
12+
.. note::
13+
14+
``tt coredump`` does not support macOS.
15+
16+
Commands
17+
--------
18+
19+
.. container:: table
20+
21+
.. list-table::
22+
:widths: 20 80
23+
:header-rows: 0
24+
25+
* - ``pack``
26+
- Pack a Tarantool core dump and supporting data into a ``tar.gz`` archive
27+
* - ``unpack``
28+
- Unpack a Tarantool core dump archive
29+
* - ``inspect``
30+
- Inspect a Tarantool core dump directory with the
31+
`GNU debugger <https://www.sourceware.org/gdb/>`__ (``gdb``)
32+
33+
34+
Details
35+
-------
36+
37+
To be able to investigate Tarantool crashes, make sure that core dumps are enabled
38+
on the host. Here is the :ref:`instruction on enabling core dumps on Unix systems <admin-core_dumps>`.
39+
40+
``tt coredump pack`` packs the given core dump together with files and data
41+
that can help the crash investigation. This includes:
42+
43+
* Tarantool executable
44+
* Tarantool version information
45+
* OS information
46+
* Shared libraries
47+
48+
``tt coredump inspect`` requires ``gdb`` installed on the host.
49+
The directory being inspected must have the same structure as the core dump archive
50+
created by ``tt coredump pack``.
51+
52+
Examples
53+
--------
54+
55+
* Pack a ``tar.gz`` file with a Tarantool core dump and supporting data:
56+
57+
.. code-block:: bash
58+
59+
tt coredump pack name.core
60+
61+
62+
* Unpack a ``tar.gz`` archive packed by ``tt coredump pack``:
63+
64+
.. code-block:: bash
65+
66+
tt coredump unpack tarantool-core-dump.tar.gz
67+
68+
69+
* Inspect the unpacked core dump with ``gdb``:
70+
71+
.. code-block:: bash
72+
73+
tt coredump inspect tarantool-core-dump

0 commit comments

Comments
 (0)