esp-idf/docs/en/api-reference/system/app_trace.rst

Application Level Tracing
=========================

:link_to_translation:`zh_CN:[中文]`

Overview
--------

ESP-IDF provides a useful feature for application behavior analysis called **Application Level Tracing**. The feature can be enabled in menuconfig and allows transfer of arbitrary data between the host and {IDF_TARGET_NAME} via JTAG interface with minimal overhead on program execution.

Developers can use this library to send application specific state of execution to the host, and receive commands or other types of information in the opposite direction at runtime. The main use cases of this library are:

1. Collecting application specific data, see :ref:`app_trace-application-specific-tracing`.
2. Lightweight logging to the host, see :ref:`app_trace-logging-to-host`.
3. System behaviour analysis, see :ref:`app_trace-system-behaviour-analysis-with-segger-systemview`.

Application Examples
--------------------

- :example:`system/app_trace_to_plot` demonstrates how to use the Application Level Tracing Library to send and plot dummy sensor data to a host via JTAG, providing a faster alternative to logging via UART.

- :example:`system/app_trace_basic` demonstrates how to use the Application Level Tracing Library to log messages to a host via JTAG, providing a faster alternative to UART logs.

API Reference
-------------

.. include-build-file:: inc/esp_app_trace.inc
.. include-build-file:: inc/esp_sysview_trace.inc
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load 2017-03-21 23:07:37 -04:00			`Application Level Tracing`
			`=========================`

docs: Provide Chinese translation for docs in api-reference/system 2023-09-04 00:12:32 -04:00			:link_to_translation:`zh_CN:[中文]`

esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load 2017-03-21 23:07:37 -04:00			`Overview`
			`--------`

docs: Provide Chinese translation for docs in api-reference/system 2023-09-04 00:12:32 -04:00			`ESP-IDF provides a useful feature for application behavior analysis called Application Level Tracing. The feature can be enabled in menuconfig and allows transfer of arbitrary data between the host and {IDF_TARGET_NAME} via JTAG interface with minimal overhead on program execution.`
docs: update format issues for EN and CN files under api-reference/system and... 2023-08-02 23:32:07 -04:00
docs: Provide Chinese translation for docs in api-reference/system 2023-09-04 00:12:32 -04:00			`Developers can use this library to send application specific state of execution to the host, and receive commands or other types of information in the opposite direction at runtime. The main use cases of this library are:`
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load 2017-03-21 23:07:37 -04:00
docs: Provide Chinese translation for docs in api-reference/system 2023-09-04 00:12:32 -04:00			1. Collecting application specific data, see :ref:`app_trace-application-specific-tracing`.
			2. Lightweight logging to the host, see :ref:`app_trace-logging-to-host`.
			3. System behaviour analysis, see :ref:`app_trace-system-behaviour-analysis-with-segger-systemview`.
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load 2017-03-21 23:07:37 -04:00
docs: update application examples related to system 2024-07-29 05:05:23 -04:00			`Application Examples`
			`--------------------`

			- :example:`system/app_trace_to_plot` demonstrates how to use the Application Level Tracing Library to send and plot dummy sensor data to a host via JTAG, providing a faster alternative to logging via UART.

			- :example:`system/app_trace_basic` demonstrates how to use the Application Level Tracing Library to log messages to a host via JTAG, providing a faster alternative to UART logs.

esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load 2017-03-21 23:07:37 -04:00			`API Reference`
			`-------------`

docs: add new top-level docs builder that builds docs for a single chip 2019-11-12 22:46:16 -05:00			`.. include-build-file:: inc/esp_app_trace.inc`
docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit 2024-01-19 01:40:33 -05:00			`.. include-build-file:: inc/esp_sysview_trace.inc`