project-chip/connectedhomeip

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

Open

#30.752 aberto em 30 de nov. de 2023

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (1.659 forks)batch import
CI/CD improvementsgood first issue

Métricas do repositório

Stars
 (6.410 stars)
Métricas de merge de PR
 (Mesclagem média 8d 5h) (375 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Comece lendo a documentação de rastreamento existente em src/tracing/perfetto/README.md e examinando o sinalizador trace to no chip tool. Em seguida, explore os arquivos de configuração do CI (por exemplo, .github/workflows) para entender como os testes são executados e como os anexos são adicionados. Por fim, revise como os testes YAML são executados e considere implementar um mecanismo para anexar dados de rastreamento apenas em caso de falha para minimizar o armazenamento.
Pilha de tecnologia
None
Domain
devopstestingci cd
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GitCI/CD
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
45