Add message receive and send tracing to chip-tool #13637
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,
Byungjoo-Lee,
bzbarsky-apple,
carol-apple,
cecille,
chrisdecenzo,
chshu,
chulspro,
Damian-Nordic,
dhrishi,
electrocucaracha,
erjiaqing,
franck-apple,
gjc13,
harimau-qirex,
hawk248,
jelderton,
jepenven-silabs,
jmartinez-silabs,
kghost,
kpschoedel,
LuDuda,
lzgrablic02,
mlepage-google,
msandstedt and
mspang
pullapprove
bot
requested review from
pan-apple,
sagar-apple,
saurabhst,
selissia,
tecimovic,
vijs,
vivien-apple,
wbschiller,
woody-apple,
xylophone21,
yufengwangca and
yunhanw-google
andy31415
approved these changes
Jan 17, 2022
|
PR #13637: Size comparison from 7b28de4 to 6ddeb63 Increases (2 builds for linux)
Decreases (5 builds for k32w, qpg, telink)
Full report (14 builds for efr32, k32w, linux, p6, qpg, telink)
|
|
PR #13637: Size comparison from 1c2091b to 133f419 Increases (2 builds for linux)
Decreases (17 builds for esp32, k32w, mbed, nrfconnect, qpg, telink)
Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
Damian-Nordic
approved these changes
Jan 18, 2022
|
/rebase |
- Move tracing from SecureMessageCodec to SessionManager to allow covering both received and sent messages - Add received message tracing - Update trace handling to be flexible to receiving a context pointer. - Refactor trace handling logic in common/tracing to be more flexible to - Add bookend FinishEvent to the TraceStream interface to assist in event flushing. Testing done: - Integration tests pass, unit tests all pass - Validated manually through several runs that with chip-tool (using `--trace_log 1`) that dumped received/sent message traces match the outer higher-level (but less detailed) logs around them
woody-apple
force-pushed
the
cleanup-secure-message-processing2
branch
from
133f419 to
17c0a1d
Compare
|
fast track: this has been up sufficiently for cross timezone review. Functionality is mostly concerning tests/debug rather than functionality. Already has a few checkmarks without open concerns. |
|
PR #13637: Size comparison from 78a6636 to 17c0a1d Increases (3 builds for linux, p6)
Decreases (14 builds for esp32, nrfconnect, qpg, telink)
Full report (27 builds for efr32, esp32, k32w, linux, nrfconnect, p6, qpg, telink)
|
selissia
pushed a commit
to selissia/connectedhomeip
that referenced
this pull request
Jan 28, 2022
* Add message receive and send tracing to chip-tool - Move tracing from SecureMessageCodec to SessionManager to allow covering both received and sent messages - Add received message tracing - Update trace handling to be flexible to receiving a context pointer. - Refactor trace handling logic in common/tracing to be more flexible to - Add bookend FinishEvent to the TraceStream interface to assist in event flushing. Testing done: - Integration tests pass, unit tests all pass - Validated manually through several runs that with chip-tool (using `--trace_log 1`) that dumped received/sent message traces match the outer higher-level (but less detailed) logs around them * Restyled by clang-format * Address review comments Co-authored-by: Restyled.io <[email protected]>
|
Hi @tcarmelveilleux, |
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
Also, there didn't exist a way to see all traffic without encryption hacks for a given node, to assist in debugging.
Change overview
SecureMessageCodectoSessionManagerto allow covering both received and sent messagesFinishEventto theTraceStreaminterface to assist in event flushing.What it looks like in the logs with
--trace_log 1in chip-tool (and tracing enabled, which it isn't by default in the build yet):Two messages, one outgoing, one incoming:
After basic parsing to recover JSON:
[ { "timestamp": 1642198394.740868, "pid": 1851914, "tid": 1851919, "type": "SecureMsg.SecMsgSent", "data": { "msg_counter": 1218820235, "session_id": 0, "msg_flags": 0, "security_flags": 0, "exchange_flags": 5, "exchange_id": 24662, "protocol_id": 0, "protocol_opcode": 32, "is_initiator": true, "is_ack_requested": true, "payload_size": 56, "payload_hex": "1530012069dcc043eed5febc214476b96f3b7dd7d29ca665cf20aece524835cb3c9375e1240201240300280435052501881325022c011818" } }, { "timestamp": 1642198394.742024, "pid": 1851914, "tid": 1851919, "type": "SecureMsg.SecMsgReceived", "data": { "peer_address": "UDP:[fdda:ebcf:9d95:0:a238:3d3c:5a29:1f3d%eno1]:5540", "msg_counter": 2683499691, "session_id": 0, "msg_flags": 0, "security_flags": 0, "exchange_flags": 6, "exchange_id": 24662, "protocol_id": 0, "protocol_opcode": 33, "is_initiator": false, "is_ack_requested": true, "acknowledged_msg_counter": 1218820235, "payload_size": 111, "payload_hex": "1530012069dcc043eed5febc214476b96f3b7dd7d29ca665cf20aece524835cb3c9375e1300220543ba1aa453e12eaa538cedcd674adb6d88f037088fb48e57884972601009c2d24030135042401643002105350414b453250204b65792053616c741835052501881325022c011818" } } ]Testing
--trace_log 1) that dumped received/sent message traces match the outer higher-level (but less detailed) logs around them