Nominate a specific, canonical extension for pprof files
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 42/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- go
- Domain
- documentation, performance
Research direction
Use PerfettoMatchUtil.java as the referenced example, then locate pprof documentation that currently uses .pb or .pb.gz examples. Update the relevant examples to the proposed .pprof and .pprof.gz extensions, with completion shown when the documentation consistently presents those as canonical and distinguishing.
Written by the indexing model from the issue text.
Description
Hi, over on internal bug b/487062289 I'm working on benchmarks that output a .pprof file into sponge.
I'd like to have a button where you can click from the benchmark results to go to the pprof web UI. We already have this for Perfetto, it's nice.
I need to match for pprof files. For Perfetto, we have a PerfettoMatchUtil.java:
private static final ImmutableSet<String> PERFETTO_EXTENSIONS =
ImmutableSet.of(
".pftrace.gz", // UTP Perfetto Plugin
".pftrace",
"_perfetto.pb.gz",
"_perfetto.pb",
".perfetto-trace.gz", // Extension used in Perfetto docs
".perfetto-trace");
It's a bit of a mess (indicating they could have chosen a canonical extension earlier), but it works.
I'd like a canonical, distinguishing file extension for pprof profiles. But I need a file extension matcher that doesn't give me too many false positives.
There's a lot of talk in pprof about outputting .pb and .pb.gz. These are perhaps canonical, but not distinct from the myriad other wireformat protocol buffer formats.
Not distinct enough to offer a 'open in pprof' link from generic testing infrastructure; they'd probably have too many false positives.
I propose we just declare that pprof files canonically use extensions:
foo.pproffoo.pprof.gz
And we update the docs that talk about .pb .pb.gz to use these as examples.
Thoughts?
- Dominant language
- Go
- Stars
- 9.3k
- Forks
- 682
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 11
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from google/pprof
-
Make comments more discoverable in the web UIPossibly taken @jabrailkhalil claimed this 16 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 45/100
google/pprof#1029 · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 74/100
google/pprof#1020 · 1 comment ·
Maintainers usually reply within 1 day
-
pprof cannot locate source code for the list command in common Go setupsPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 4/5 3-5 days Newbie friendliness 48/100
google/pprof#1009 · 1 comment ·
Maintainers usually reply within 1 day
-
Label with zero int64 value and no unit get dropped during decodingPossibly taken @ms-hujia claimed this 121 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 55/100
google/pprof#1002 · 6 comments ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
google/pprof#914 · 6 comments ·
Maintainers usually reply within 1 day
Similar issues
-
bug frontend grammar sev-3
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
-
connector docs good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
soma-intelligence/open-health-sync#134 ·
Maintainers usually reply within 1 day
-
bug frontend
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 3 days
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
oss/0 pending team/container-integrations
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DataDog/datadog-agent#58323 ·
Maintainers usually reply within 1 day