tracing: Add --trace-json for visualising traces and add more spans
#3327
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
Bravo555
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
Codecov ReportAttention: Patch coverage is Additional details and impacted files📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
This PR would deserve some clean-up to focus on its main ideas (better use of tracing spans and trace visualization using tracing-chrome).
I agree that tracing span is a powerful tool to improve thin-edge debug-ability. However, I need more evidence to be convinced by visual traces.
I think efforts need to be made elsewhere first, on what is traced and on the level of details.
Bravo555
force-pushed
the
improve/tracing-output-json
branch
from
6574b60 to
5f1e805
Compare
Bravo555
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
Bravo555
force-pushed
the
improve/tracing-output-json
branch
from
5f1e805 to
a98c989
Compare
Bravo555
requested a deployment
to
Test Pull Request
GitHub Actions
Waiting
This is to make diff smaller for the next commit that adds a chrome layer that outputs a JSON trace file Signed-off-by: Marcel Guzik <[email protected]>
If `--trace-json` option is used, a `trace-TIMESTAMP.json` file will be created which can be opened by tools like ui.perfetto.dev Signed-off-by: Marcel Guzik <[email protected]>
`TEDGE_TRACE_DIR` environment variable is added to enable trace file output in addition to already present `--trace-json`. It also allows the user to specify the directory where the trace file will be written. I decided on the environment variable because it may be tricky to add the flag to all of the invocation of thin-edge services, particularly if we want to trace all the services and when they are started indirectly, like by systemd. Signed-off-by: Marcel Guzik <[email protected]>
Bravo555
force-pushed
the
improve/tracing-output-json
branch
from
a98c989 to
cd50be0
Compare
Bravo555
requested a deployment
to
Test Pull Request
GitHub Actions
Waiting
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.
TODO
Proposed changes
Add
--trace-jsonoption that when used causes atrace-TIMESTAMP.jsonfile will be created which can be opened by tools like https://ui.perfetto.dev.Also added more spans, particularly on the
Actor::runmethod, so that we can easily see which actor emitted new span/event.Example: Before new spans
trace-1736783287825075.json
Example: After new spans
trace-1736784244896393.json
Types of changes
Paste Link to the issue
Checklist
cargo fmtas mentioned in CODING_GUIDELINEScargo clippyas mentioned in CODING_GUIDELINESFurther comments