Skip to content

Conversation

@radurentea
Copy link
Collaborator

Description

This pull request updates the App Tracing feature documentation and removes parsing of app trace files, since the output coming from esp-idf changed. The changes focus on making the tracing functionality work with the new app_trace_basic example.

App Trace fix

  • Added resetting the target before starting app trace. This is needed because the boards sends some data to openOCD just after reset. run openocd -> reset target -> send command

Documentation Improvements

  • Enhanced the App Tracing documentation with clearer step-by-step instructions for using the app_trace_basic example. [1]
  • Added important configuration note about required settings in .vscode/settings.json for proper tracing functionality. [1]

UI and Visual Improvements

  • Added distinct icons for different trace types - using ThemeIcon("pulse") for heap traces and ThemeIcon("archive") for app traces in the trace archive tree view. [1]
  • Improved trace file handling by setting direct file opening for app trace files while maintaining report view for heap trace files. [1]

Trace Archive Management

  • Enhanced the trace archive tree data provider to better handle both app trace and heap trace files with improved file type detection and display. [1]
  • Added more descriptive tooltips and file information display, including file size and creation time in a human-readable format. [1]

Type of change

Please delete options that are not relevant.

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Steps to test this pull request

Follow steps in app trace documentation and heap trace documentation.

Both app trace and heap trace should work.
App trace files should open inside editor when they get clicked in the "App Trace Archives", while heap trace should still open inside "IDF Tracing" webview

How has this been tested?

As explained above

Test Configuration:

  • ESP-IDF Version: 6.0.0
  • OS (Windows,Linux and macOS): Windows and Mac

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

@radurentea radurentea self-assigned this Aug 27, 2025
@github-actions
Copy link

github-actions bot commented Aug 27, 2025

Download the artifacts for this pull request:
You can test these changes by installing this VSIX by click menu View -> Command Palette..., type Install from VSIX and then select downloaded esp-idf-extension.vsix file to install the extension.

Copy link
Collaborator

@erhankur erhankur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@radurentea thanks for fixing the guide and reset issue.

Copy link
Collaborator

@brianignacio5 brianignacio5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with few suggestions.

@brianignacio5 brianignacio5 added this to the v1.11.0 milestone Aug 29, 2025
@radurentea radurentea requested a review from erhankur August 29, 2025 11:14
@radurentea
Copy link
Collaborator Author

Thank you for the reviews, I've made the modifications requested.

@erhankur can you please take another look?

Copy link
Collaborator

@Fabricio-ESP Fabricio-ESP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed working.

@radurentea radurentea merged commit 52c887a into master Sep 3, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants