project-chip/connectedhomeip

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

Open

#30.752 geöffnet am 30. Nov. 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (1.659 Forks)batch import
CI/CD improvementsgood first issue

Repository-Metriken

Stars
 (6.410 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T 5h) (375 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Beginnen Sie mit dem Lesen der vorhandenen Tracing Dokumentation unter src/tracing/perfetto/README.md und untersuchen Sie das Flag trace to in chip tool. Erkunden Sie dann die CI Konfigurationsdateien (z. B. .github/workflows), um zu verstehen, wie Tests ausgeführt werden und wie Anhänge hinzugefügt werden. Überprüfen Sie abschließend, wie YAML Tests ausgeführt werden, und erwägen Sie die Implementierung eines Mechanismus, um Tracing Daten nur bei Fehlern anzuhängen, um den Speicherbedarf zu minimieren.
Tech Stack
Keine
Domain
devopstestingci cd
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
GitCI/CD
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45