api: API trace improvements
[vpp.git] / docs / reference / cmdreference / trace / trace.rst
1 .. _interface:
2
3 .. toctree::
4
5 .. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_ .
6
7
8 API Trace
9 ===========
10
11 Summary/Usage
12 --------------
13
14 api trace [tx][on|off][first <n>][last <n>][status][free]
15         [post-mortem-on][dump|dump-file|dump-json|save|tojson|save-json|replay <file>][nitems <n>][initializers <file>]
16
17 Description
18 ------------
19
20 Display, replay, or save a binary API trace.
21
22 Declaration and Implementation
23 -------------------------------
24
25 **Declaration:** api_trace_command (src/vlibmemory/vlib_api_cli.c line 783)
26
27 **Implementation:** api_trace_command_fn
28
29 Clear Trace
30 =============
31
32 Summary/Usage
33 --------------
34 Clear trace buffer and free memory.
35 Declaration and implementation
36
37 **Declaration:** clear_trace_cli (src/vlib/trace.c line 519)
38
39 **Implementation:** cli_clear_trace_buffer
40
41 Show Trace
42 ===========
43
44 `Show Trace <../show/show.html#show-trace>`_
45
46 Trace Add
47 ===========
48
49 Summary/Usage
50 --------------
51
52 Trace given number of packets.
53
54 Declaration and Implementation
55 -------------------------------
56
57 **Declaration:** add_trace_cli (src/vlib/trace.c line 405)
58
59 **Implementation:** cli_add_trace_buffer