-
Notifications
You must be signed in to change notification settings - Fork 112
feat(profiling): Add Perfetto trace format support #5659
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
markushi
wants to merge
23
commits into
master
Choose a base branch
from
feat/markushi/perfetto-profiling-support
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
405a5c1
feat(profiling): Add Perfetto trace format support
markushi 1687276
style(profiling): Format Perfetto module with cargo fmt
markushi 2cbf111
fix(profiling): Remove private intra-doc link in expand_perfetto
markushi 9ee2661
Merge remote-tracking branch 'origin/master' into feat/markushi/perfe…
markushi 9d4693c
Merge branch 'master' into feat/markushi/perfetto-profiling-support
markushi 4407d9e
Merge branch 'master' into feat/markushi/perfetto-profiling-support
markushi e67fa58
Extend profile chunk to support blob attachment via meta_length
markushi c4fa16e
Improve code generation script and docs
markushi 1e6df1f
Guard perfetto processing by feature flag
markushi 0a58b24
Address some more PR comments, add missing tests
markushi f729460
Merge branch 'master' into feat/markushi/perfetto-profiling-support
markushi 685ec0a
Merge branch 'master' into feat/markushi/perfetto-profiling-support
markushi 49f3bd9
feat(profiling): Use separate intern tables per Perfetto field and in…
markushi 5c6e457
fix(profiling): Fix clippy lint and add changelog entry
markushi 2f78475
fix(profiling): Apply first timestamp delta in StreamingProfilePacket
markushi 6e5f11c
fix(profiling): Resolve thread ID for StreamingProfilePacket via Trac…
markushi 06467d1
Merge branch 'master' into feat/markushi/perfetto-profiling-support
markushi 253120d
fix(profiling): Resolve Perfetto samples eagerly to survive increment…
markushi ff63cc3
fix(profiling): Avoid redundant full JSON parse to extract content_type
markushi 1c1dad6
fix(profiling): Check content_type before calling expand_perfetto
markushi 1e14dc6
fix(profiling): Read content_type from metadata and remove dead write
markushi b2f35cb
Merge branch 'master' into feat/markushi/perfetto-profiling-support
markushi a58ed23
Merge branch 'master' into feat/markushi/perfetto-profiling-support
markushi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # Perfetto Proto Definitions | ||
|
|
||
| `perfetto_trace.proto` contains a minimal subset of the | ||
| [Perfetto trace proto definitions](https://github.com/google/perfetto/tree/master/protos/perfetto/trace) | ||
| needed to decode profiling data. Field numbers match the upstream definitions. | ||
|
|
||
| The generated Rust code is checked in at `../src/perfetto/proto.rs`. | ||
|
|
||
| ## Regenerating | ||
|
|
||
| Prerequisites: | ||
| - `protoc`: https://github.com/protocolbuffers/protobuf/releases (or `brew install protobuf`) | ||
| - `protoc-gen-prost`: `cargo install protoc-gen-prost` | ||
|
|
||
| Then run: | ||
| ```sh | ||
| ./relay-profiling/protos/generate.sh | ||
| ``` |
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not 100% sure what we discussed. Did we say we wanted the protobuf schema generation in a separate repository, like we have with sentry-conventions? |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # Regenerates the checked-in Rust protobuf bindings for Perfetto trace types | ||
| # using protoc with the protoc-gen-prost plugin. | ||
| # | ||
| # Usage: | ||
| # ./relay-profiling/protos/generate.sh | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" | ||
| PROTO_FILE="$SCRIPT_DIR/perfetto_trace.proto" | ||
| OUTPUT_FILE="$SCRIPT_DIR/../src/perfetto/proto.rs" | ||
|
|
||
| if ! command -v protoc &>/dev/null; then | ||
| echo "error: protoc is not installed." >&2 | ||
| echo " Install it from https://github.com/protocolbuffers/protobuf/releases" >&2 | ||
| echo " or: brew install protobuf" >&2 | ||
| exit 1 | ||
| fi | ||
| echo "Using protoc: $(command -v protoc) ($(protoc --version))" | ||
|
|
||
| if ! command -v protoc-gen-prost &>/dev/null; then | ||
| echo "error: protoc-gen-prost is not installed." >&2 | ||
| echo " Install it with: cargo install protoc-gen-prost" >&2 | ||
| exit 1 | ||
| fi | ||
| echo "Using protoc-gen-prost: $(command -v protoc-gen-prost)" | ||
|
|
||
| if [[ ! -f "$PROTO_FILE" ]]; then | ||
| echo "error: proto file not found at $PROTO_FILE" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| TMPDIR="$(mktemp -d)" | ||
| trap 'rm -rf "$TMPDIR"' EXIT | ||
|
|
||
| echo "Generating Rust bindings..." | ||
| protoc \ | ||
| --prost_out="$TMPDIR" \ | ||
| --proto_path="$SCRIPT_DIR" \ | ||
| "$PROTO_FILE" | ||
|
|
||
| # protoc-gen-prost mirrors the proto package path in the output directory. | ||
| GENERATED=$(find "$TMPDIR" -name '*.rs' -type f | head -1) | ||
|
|
||
| if [[ -z "$GENERATED" || ! -f "$GENERATED" ]]; then | ||
| echo "error: no generated .rs file found in $TMPDIR" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [[ ! -s "$GENERATED" ]]; then | ||
| echo "error: generated file is empty" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| cp "$GENERATED" "$OUTPUT_FILE" | ||
| echo "Updated $OUTPUT_FILE" | ||
| echo "Done." |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| // Minimal subset of the Perfetto trace proto definitions needed to decode | ||
| // profiling data. Field numbers match the upstream definitions at | ||
| // https://github.com/google/perfetto/tree/master/protos/perfetto/trace | ||
|
|
||
| syntax = "proto2"; | ||
| package perfetto.protos; | ||
|
|
||
| message Trace { | ||
| repeated TracePacket packet = 1; | ||
| } | ||
|
|
||
| message TracePacket { | ||
| optional uint64 timestamp = 8; | ||
|
|
||
| oneof optional_trusted_packet_sequence_id { | ||
| uint32 trusted_packet_sequence_id = 10; | ||
| } | ||
|
|
||
| optional InternedData interned_data = 12; | ||
| optional uint32 sequence_flags = 13; | ||
|
|
||
| // Only the oneof variants we care about; prost will skip the rest. | ||
| oneof data { | ||
| ProcessTree process_tree = 2; | ||
| ClockSnapshot clock_snapshot = 6; | ||
| StreamingProfilePacket streaming_profile_packet = 54; | ||
| TrackDescriptor track_descriptor = 60; | ||
| PerfSample perf_sample = 66; | ||
| } | ||
| } | ||
|
|
||
| // --- process tree ------------------------------------------------------------ | ||
|
|
||
| message ProcessTree { | ||
| message Thread { | ||
| optional int32 tid = 1; | ||
| optional string name = 2; | ||
| optional int32 tgid = 3; | ||
| } | ||
| repeated ProcessTree.Thread threads = 2; | ||
| } | ||
|
|
||
| // --- clock sync --------------------------------------------------------------- | ||
|
|
||
| message ClockSnapshot { | ||
| message Clock { | ||
| optional uint32 clock_id = 1; | ||
| optional uint64 timestamp = 2; | ||
| } | ||
| repeated Clock clocks = 1; | ||
| optional uint32 primary_trace_clock = 2; | ||
| } | ||
|
|
||
| // --- interned data ----------------------------------------------------------- | ||
|
|
||
| message InternedData { | ||
| repeated InternedString function_names = 5; | ||
| repeated Frame frames = 6; | ||
| repeated Callstack callstacks = 7; | ||
| repeated InternedString build_ids = 16; | ||
| repeated InternedString mapping_paths = 17; | ||
| repeated Mapping mappings = 19; | ||
| } | ||
|
|
||
| message InternedString { | ||
| optional uint64 iid = 1; | ||
| optional bytes str = 2; | ||
| } | ||
|
|
||
| // --- profiling common -------------------------------------------------------- | ||
|
|
||
| message Frame { | ||
| optional uint64 iid = 1; | ||
| optional uint64 function_name_id = 2; | ||
| optional uint64 mapping_id = 3; | ||
| optional uint64 rel_pc = 4; | ||
| } | ||
|
|
||
| message Mapping { | ||
| optional uint64 iid = 1; | ||
| optional uint64 build_id = 2; | ||
| optional uint64 start_offset = 3; | ||
| optional uint64 start = 4; | ||
| optional uint64 end = 5; | ||
| optional uint64 load_bias = 6; | ||
| repeated uint64 path_string_ids = 7; | ||
| optional uint64 exact_offset = 8; | ||
| } | ||
|
|
||
| message Callstack { | ||
| optional uint64 iid = 1; | ||
| repeated uint64 frame_ids = 2; | ||
| } | ||
|
|
||
| // --- profiling packets ------------------------------------------------------- | ||
|
|
||
| message PerfSample { | ||
| optional uint32 cpu = 1; | ||
| optional uint32 pid = 2; | ||
| optional uint32 tid = 3; | ||
| optional uint64 callstack_iid = 4; | ||
| } | ||
|
|
||
| message StreamingProfilePacket { | ||
| repeated uint64 callstack_iid = 1; | ||
| repeated int64 timestamp_delta_us = 2; | ||
| } | ||
|
|
||
| // --- track descriptors ------------------------------------------------------- | ||
|
|
||
| message TrackDescriptor { | ||
| optional uint64 uuid = 1; | ||
| optional ThreadDescriptor thread = 4; | ||
| } | ||
|
|
||
| message ThreadDescriptor { | ||
| optional int32 pid = 1; | ||
| optional int32 tid = 2; | ||
| optional string thread_name = 5; | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't the change bigger than this?