jlfwong/speedscope

Support trailing whitespace & floating point values with Brendan Gregg collapsed stack format

Open

#157 opened on Sep 5, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (4,040 stars) (181 forks)batch import
feature requesthelp wanted

Description

So I have some custom tool that generates data in a output similar to Brendan Gregg's stack format, that works with flamegraph.pl, but is throwing issues with my custom file.

I found there were a few different issues in my file:

  • a trailing newline in the file causing an error
  • my values weren't integers
  • some of my values were negative

Not sure if we could raise a better error message, for those?

Maybe it'd also be useful mentioning that in the docs, I am happy to make a PR, if there is a way to do that in docs?

Contributor guide

Tech stack
typescript
Domain
performance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of TypeScriptFamiliarity with flamegraph profiling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue requests support for trailing whitespace, floating point, and negative values in the collapsed stack format parser. Investigate the parser code likely in files related to importing Brendan Gregg's format, such as `src/import/`. Look for where the format is parsed and how values are handled (e.g., integer parsing). Improve error messages for invalid values and update documentation accordingly. Check if there are existing tests for this format.