Add trace messages for automation #12732
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pullapprove
bot
requested review from
anush-apple,
balducci-apple,
bzbarsky-apple,
carol-apple,
chrisdecenzo,
chulspro,
Damian-Nordic,
electrocucaracha,
emargolis,
franck-apple,
hawk248,
holbrookt,
jelderton,
jepenven-silabs,
jmartinez-silabs,
kghost,
LuDuda,
mlepage-google,
mrjerryjohns,
msandstedt,
mspang,
pan-apple,
robszewczyk,
sagar-apple,
saurabhst,
selissia and
tecimovic
|
PR #12732: Size comparison from e4f3246 to 4db3546 Full report (25 builds for efr32, esp32, k32w, nrfconnect, p6, qpg, telink)
|
woody-apple
approved these changes
Dec 9, 2021
rgoliver
force-pushed
the
chip-trace-message
branch
4 times, most recently
from
0e1a07b to
7658deb
Compare
|
PR #12732: Size comparison from f2e7df8 to 7658deb Increases above 0.2%:
Increases (1 build for linux)
Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
mspang
reviewed
Dec 9, 2021
rgoliver
force-pushed
the
chip-trace-message
branch
2 times, most recently
from
6a9e4a5 to
cc70f8f
Compare
mspang
reviewed
Dec 9, 2021
pullapprove
bot
requested review from
Byungjoo-Lee,
chshu,
dhrishi,
gjc13 and
xylophone21
rgoliver
force-pushed
the
chip-trace-message
branch
from
cc70f8f to
15f5298
Compare
Add a trace backend to linux/chip-tool which provides a simple
and flexible way to trace chip messages. The backend provides
handlers, which can be registered to handle the different
types of messages and extract the relevant data needed for
test automation.
Added additional optional flags to chip-tool which allows turning
on these traces and piping them either to a log or file. These
flags and tracing are only enabled when tracing is enabled at
compile time. Include trace compile with:
gn gen out/with_trace/ --args='import("//with_pw_trace.gni")'
The trace point is before the encrypt in SecureMessageCodec and
only enabled when chip_enable_transport_trace is defined at compile
time and a pw_trace backend is configured.
rgoliver
force-pushed
the
chip-trace-message
branch
from
15f5298 to
715c7ef
Compare
|
PR #12732: Size comparison from 857d6c5 to 715c7ef Increases above 0.2%:
Increases (2 builds for linux)
Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
|
@andy31415 @yunhanw-google @woody-apple @tcarmelveilleux this broke critical TE 7.5 testing functionality. See #13016 |
vivien-apple
added a commit
to vivien-apple/connectedhomeip-1
that referenced
this pull request
Dec 15, 2021
andy31415
pushed a commit
that referenced
this pull request
Dec 15, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Specific data from messages are needed for test validation, it is desirable to have a simple and flexible way to extract this data without requiring logging wrapped in macros directly in the protocols #11510, #11553, #11552.
Change overview
Add a trace backend to chip-tool which provides a simple and flexible way to trace chip messages. The backend provides handlers, which can be registered to handle the different types of messages and extract the relevant data needed for test automation.
Added additional optional flags to chip-tool which allows turning on these traces and piping them either to a log or file. These flags and tracing are only enabled when tracing is enabled at compile time. Include trace compile with:
The trace point is before the encrypt in SecureMessageCodec and only enabled when
PW_TRACE_CHIP_ENABLEDis defined at compile time and a pw_trace backend is configured.Note: This is just adding the plumbing to get the message data in a centralized spot with a framework to write and register handlers which can interpret the messages. Writing these handlers for the different messages will be the next step.
Testing
Compiled chip-tool with and without tracing enabled, piped tracing to log and to file and commissioned a device:
Which generated the following trace.log file: