Version	Vulnerabilities	License Risk
1.0.1	\|	12/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	12/2015	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

Version

Vulnerabilities

License Risk

12/2015

1.1.0

12/2015

Popular

Readme

flamegraph

Generates flamegraphs with Node.js or in the browser.

cat instruments-callgraph.csv | flamegraph -t instruments &gt; flamegraph.svg

Try the online flamegraph app

Installation

npm install flamegraph

Usage

Requires Node.js version 0.11.13 or higher.

flamegraph 

Generates a flamegraph from the callgraph data of the given `inputtype` that is streamed into it.

OPTIONS:

  --inputtype -t      the type of callgraph 'instruments | perf | cpuprofile'

  --file -f           the input csv file (may also be piped)
  --output -o         the output svg file (may also be displayed in stdout)
  --map -m            a mapping / symbols file, named perf-.map, generated using node --perf-basic-prof

  --fonttype          font family used                  default: 'Verdana'
  --fontsize          base text size                    default: 12
  --imagewidth        max width, pixels                 default: 1200
  --frameheight       max height is dynamic             default: 16.0
  --fontwidth         avg width relative to fontsize    default: 0.59
  --minwidth          min function width, pixels        default: 0.1
  --countname         what are the counts in the data?  default: 'samples'
  --colors            color theme                       default: 'hot'
  --bgcolor1          background color gradient start   default: '#eeeeee'
  --bgcolor2          background color gradient stop    default: '#eeeeb0'
  --timemax           (override the) sum of the counts  default: Infinity
  --factor            factor to scale counts by         default: 1
  --hash              color by function name            default: true
  --titletext         centered heading                  default: 'Flame Graph'
  --nametype          what are the names in the data?   default: 'Function:'

  --removenarrows     removes narrow functions instead of adding a 'hidden' class   default: true
  --internals         include internal functions        default: false
  --optimizationinfo  include optimization indicators   default: false

  --help      -h  print this help message

EXAMPLE:

  cat instruments-callgraph.csv | flamegraph -t instruments &gt; flamegraph.svg

  flamegraph -t instruments -f instruments-callgraph.csv -m perf-4499.map -o flamegraph.svg

The input data needs to be generated as follows:

API

flamegraph(arr, opts) → {string}

Converts an array of call graph lines into an svg document.

Parameters:

Name Type Description

arr

Array.<string>

input lines to render svg for

opts

Object

objects that affect the visualization

Properties

Name	Type	Description
`profile`	Object	options passed to cpuprofilify @see cpuprofilify.convert params
`fonttype`	string	type of font to use default: `'Verdana'`
`fontsize`	number	base text size default: `12`
`imagewidth`	number	max width, pixels default: `1200`
`frameheight`	number	max height is dynamic default: `16.0`
`fontwidth`	number	avg width relative to fontsize default: `0.59`
`minwidth`	number	min function width, pixels default: `0.1`
`countname`	string	what are the counts in the data? default: `'samples'`
`colors`	string	color theme default: `'hot'`
`bgcolor1`	string	background color gradient start default: `'#eeeeee'`
`bgcolor2`	string	background color gradient stop default: `'#eeeeb0'`
`timemax`	number	(override the) sum of the counts default: `Infinity`
`factor`	number	factor to scale counts by default: `1`
`hash`	boolean	color by function name default: `true`
`titletext`	string	centered heading default: `'Flame Graph'`
`nametype`	string	what are the names in the data? default: `'Function:'`

Source:

index.js , lineno 16

Returns:

svg the rendered svg

Type: string

flamegraph::fromStream(stream, opts) → {ReadableStream}

Converts a stream of call graph lines into an svg document. Not truly streaming, concats all lines before processing.

Example:

var fromStream = require('flamegraph/from-stream');
fromStream(process.stdin, opts).pipe(process.stdout);

Parameters:

Name	Type	Description
`stream`	ReadableStream	that will emit the call graph lines to be parsed
`opts`	Object	same as `flamegraph`

Source:

from-stream.js , lineno 12

Returns:

stream that emits the lines of generated svg

Type: ReadableStream

flamegraph::svg(collapsedLines, opts) → {string}

Creates a context from a call graph that has been collapsed (stackcollapse-*) and renders svg from it.

Parameters:

Name	Type	Description
`collapsedLines`	Array.<string>	callgraph that has been collapsed
`opts`	Object	options

Source:

lib/svg.js , lineno 23

Returns:

svg

Type: string

generated with docme

Kudos

This library is an adaptation of @brendangregg's FlameGraph perl scripts.

License

MIT

FAQs

What is @ramitos/flamegraph?

Generates flamegraphs with Node.js or in the browser. Visit Snyk Advisor to see a full health score report for @ramitos/flamegraph, including popularity, security, maintenance & community analysis.

Is @ramitos/flamegraph popular?

The npm package @ramitos/flamegraph receives a total of 3 weekly downloads. As such, @ramitos/flamegraph popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @ramitos/flamegraph well maintained?

We found indications that @ramitos/flamegraph is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @ramitos/flamegraph safe to use?

While scanning the latest version of @ramitos/flamegraph, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (3)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

flamegraph

Installation

Usage

API

flamegraph(arr, opts) → {string}

Parameters:

Properties

Returns:

flamegraph::fromStream(stream, opts) → {ReadableStream}

Parameters:

Returns:

flamegraph::svg(collapsedLines, opts) → {string}

Parameters:

Returns:

Kudos

License

@ramitos/flamegraph dependencies

@ramitos/flamegraph development dependencies

FAQs

What is @ramitos/flamegraph?

Is @ramitos/flamegraph popular?

Is @ramitos/flamegraph well maintained?

Is @ramitos/flamegraph safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues