project-chip/connectedhomeip

[CI/CD] Add tracing data as attachments after CI runs

Open

#30,752 opened on Nov 30, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (6,410 stars) (1,659 forks)batch import
CI/CD improvementsgood first issue

Description

chip-tool supports tracing. In particular for hard to debug cases it would be beneficial to be able to view messages (json dump may be sufficient) and timing (perfetto may be useful here).

We probably should start with documentation as I could not find a propper one. https://github.com/project-chip/connectedhomeip/tree/master/src/tracing/perfetto#readme explains the perfetto side of things, however it is not ideal.

We likely need (and we can separate this in milestones/separate bugs):

  • Document how --trace-to actually works in chip-tool. In particular targets of json:<file>, json:log and pefretto:<file> or perfetto (when using a daemon) work
  • Make out tests run with tracing and add tracing data as attachments to runs (need to determine how large these are). In particular for yaml tests, we may want to only attach traces for failures to not use too much storage

Contributor guide

Tech stack
cppgithub actions
Domain
ci cdtesting
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of chip tool tracingFamiliarity with CI configurationBasic knowledge of JSON or Perfetto
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Start by reading the existing tracing documentation at src/tracing/perfetto/README.md and examining the trace to flag in chip tool. Then, explore the CI configuration files (e.g., .github/workflows) to understand how tests are run and how attachments are added. Finally, review how YAML tests are executed and consider implementing a mechanism to attach tracing data only on failure to minimize storage.
[CI/CD] Add tracing data as attachments after CI runs · project-chip/connectedhomeip#30752 | Good First Issue