project-chip/connectedhomeip

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

Open

#30.752 aperta il 30 nov 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C++ (1659 fork)batch import
CI/CD improvementsgood first issue

Metriche repository

Star
 (6410 star)
Metriche merge PR
 (Merge medio 8g 5h) (375 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Inizia leggendo la documentazione di tracciamento esistente in src/tracing/perfetto/README.md ed esaminando il flag trace to in chip tool. Quindi, esplora i file di configurazione CI (ad esempio, .github/workflows) per capire come vengono eseguiti i test e come vengono aggiunti gli allegati. Infine, rivedi come vengono eseguiti i test YAML e considera di implementare un meccanismo per allegare i dati di tracciamento solo in caso di fallimento per minimizzare lo storage.
Tech stack
Nessuno
Dominio
devopstestingci cd
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitCI/CD
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45