diff options
author | Filip Tehlar <ftehlar@cisco.com> | 2021-07-23 08:51:10 +0000 |
---|---|---|
committer | Filip Tehlar <ftehlar@cisco.com> | 2021-09-28 16:06:19 +0000 |
commit | 36217e3ca8a1ca2e7a341b6b44ffc25e6497191c (patch) | |
tree | ba45e2b144e0d66a69c0502a7823c28239d0bc66 /docs/reference/cmdreference | |
parent | 3459ece6da90627b161e2128b5926f1e58e7db65 (diff) |
api: API trace improvements
Type: improvement
* add support for JSON format in API trace
* add ability to replay JSON API trace in both VPP and VAT2
* use CRC for backward compatibility check during JSON API replay
* fix API trace CLI (and remove duplicits)
* remove custom dump
* remove vppapitrace.py
* update docs accordingly
Change-Id: I5294f68bebe6cbe738630f457f3a87720e06486b
Signed-off-by: Filip Tehlar <ftehlar@cisco.com>
Signed-off-by: Ole Troan <ot@cisco.com>
Diffstat (limited to 'docs/reference/cmdreference')
-rw-r--r-- | docs/reference/cmdreference/trace/trace.rst | 117 |
1 files changed, 59 insertions, 58 deletions
diff --git a/docs/reference/cmdreference/trace/trace.rst b/docs/reference/cmdreference/trace/trace.rst index 9d120ed9cab..927342fa3d7 100644 --- a/docs/reference/cmdreference/trace/trace.rst +++ b/docs/reference/cmdreference/trace/trace.rst @@ -1,58 +1,59 @@ -.. _interface:
-
-.. toctree::
-
-.. 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>`_ .
-
-
-API Trace
-===========
-
-Summary/Usage
---------------
-
-api trace [on|off][first <*n*>][last <*n*>][status][free][post-mortem-on][dump|custom-dump|save|replay <*file*>]
-
-Description
-------------
-
-Display, replay, or save a binary API trace.
-
-Declaration and Implementation
--------------------------------
-
-**Declaration:** api_trace_command (src/vlibmemory/vlib_api_cli.c line 783)
-
-**Implementation:** api_trace_command_fn
-
-Clear Trace
-=============
-
-Summary/Usage
---------------
-Clear trace buffer and free memory.
-Declaration and implementation
-
-**Declaration:** clear_trace_cli (src/vlib/trace.c line 519)
-
-**Implementation:** cli_clear_trace_buffer
-
-Show Trace
-===========
-
-`Show Trace <../show/show.html#show-trace>`_
-
-Trace Add
-===========
-
-Summary/Usage
---------------
-
-Trace given number of packets.
-
-Declaration and Implementation
--------------------------------
-
-**Declaration:** add_trace_cli (src/vlib/trace.c line 405)
-
-**Implementation:** cli_add_trace_buffer
\ No newline at end of file +.. _interface: + +.. toctree:: + +.. 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>`_ . + + +API Trace +=========== + +Summary/Usage +-------------- + +api trace [tx][on|off][first <n>][last <n>][status][free] + [post-mortem-on][dump|dump-file|dump-json|save|tojson|save-json|replay <file>][nitems <n>][initializers <file>] + +Description +------------ + +Display, replay, or save a binary API trace. + +Declaration and Implementation +------------------------------- + +**Declaration:** api_trace_command (src/vlibmemory/vlib_api_cli.c line 783) + +**Implementation:** api_trace_command_fn + +Clear Trace +============= + +Summary/Usage +-------------- +Clear trace buffer and free memory. +Declaration and implementation + +**Declaration:** clear_trace_cli (src/vlib/trace.c line 519) + +**Implementation:** cli_clear_trace_buffer + +Show Trace +=========== + +`Show Trace <../show/show.html#show-trace>`_ + +Trace Add +=========== + +Summary/Usage +-------------- + +Trace given number of packets. + +Declaration and Implementation +------------------------------- + +**Declaration:** add_trace_cli (src/vlib/trace.c line 405) + +**Implementation:** cli_add_trace_buffer |