Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation and error message for protobuf features should be made more clear #246

Open
NexVeridian opened this issue Apr 17, 2024 · 0 comments · May be fixed by #247
Open

Documentation and error message for protobuf features should be made more clear #246

NexVeridian opened this issue Apr 17, 2024 · 0 comments · May be fixed by #247

Comments

@NexVeridian
Copy link

In the readme it says to use feature protobuf

pprof-rs/README.md

Lines 119 to 121 in 4939f73

## Use with `pprof`
With `protobuf` feature enabled, `pprof-rs` can also output [`profile.proto`](https://github.com/google/pprof/blob/master/proto/profile.proto) format.

but when compiling criterion with feature protobuf, you get this error
pprof = { version = "0.13", features = ["criterion", "protobuf"] }

pprof-rs/src/criterion.rs

Lines 48 to 49 in 4939f73

#[cfg(not(any(feature = "_protobuf", feature = "flamegraph")))]
compile_error!("Either feature \"protobuf\" or \"flamegraph\" must be enabled when \"criterion\" feature is enabled.");

Feature protobuf doesn't include feature _protobuf

I think the both of these two spots should be changed to "use feature prost-codec or protobuf-codec"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documentation and error message for protobuf features NexVeridian/pprof-rs
1 participant
@NexVeridian