@ramitos/cpuprofilify

v1.0.0

Converts output of various profiling/sampling tools to the .cpuprofile format so it can be loaded into Chrome DevTools. For more information about how to use this package see README

Latest version published 9 years ago

License: MIT

Package Health Score

45 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

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

License

MIT

Security Policy

No

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (3)

GitHub Stars: 167
Forks: 16
Contributors: 2

Direct Usage Popularity

The npm package @ramitos/cpuprofilify receives a total of 3 downloads a week. As such, we scored @ramitos/cpuprofilify popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @ramitos/cpuprofilify, we found that it has been starred 167 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @ramitos/cpuprofilify is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 2
Open PR: 1
Last Release: 9 years ago
Last Commit: 8 years ago

Further analysis of the maintenance status of @ramitos/cpuprofilify based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @ramitos/cpuprofilify is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 9 years
Dependencies: 6 Direct
Versions: 2
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

@ramitos/cpuprofilify has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

cpuprofilify

Converts output of various profiling/sampling tools to the .cpuprofile format so it can be loaded into Chrome DevTools.

screenshot

Table of Contents generated with DocToc

Installation

npm install -g cpuprofilify

Instructions

cpuprofilify installs two binary scripts:

profile_1ms.d: DTrace script that samples your process, use either of the following to generate a trace
- sudo profile_1ms.d -c | cpuprofilify > out.cpuprofile
- sudo profile_1ms.d -p | cpuprofilify > out.cpuprofile
cpuprofilify: which will convert a perf or DTrace trace into a .cpuprofile importable into Chrome DevTools

Example

using DTrace script

# In Terminal A
➝  sudo profile_1ms.d -c 'node --perf-basic-prof example/fibonacci' | \
      cpuprofilify &gt; /tmp/example.cpuprofile
pid 
HTTP server listening on port 8000

# In Terminal B
➝  ab -n 6 -c 2 https://:::8000/1000/
This is ApacheBench, Version 2.3 &lt;$Revision: 1554214 $&gt;
Copyright 1996 Adam Twiss, Zeus Technology Ltd, https://www.zeustech.net/
Licensed to The Apache Software Foundation, https://www.apache.org/

Benchmarking :: (be patient).....done
[ .. ]

➝  sudo kill

Now open /tmp/example.cpuprofile in Chrome DevTools Profiles - Load

NOTE: in order to try the above example please clone this repository.

Usage

cat trace.txt | cpuprofilify  &gt; my.cpuprofile 

  Converts the given trace taking according to the given opttions


OPTIONS:

--unresolveds  , --nounresolveds    unresolved addresses like `0x1a23c` are filtered from the trace unless this flag is set (default: false)
--sysinternals , --nosysinternals   sysinternals like `__lib_c_start...` are filtered from the trace unless this flag is set (default: false)
--v8internals  , --nov8internals    v8internals like `v8::internal::...` are filtered from the trace unless this flag is set (default: false)
--v8gc         , --nov8gc           when v8internals are filtered, garbage collection info is as well unless this flag set  (default: true)

--shortStack      , --noshortStack        stacks that have only one line are ignored unless this flag is set (default: false)
--optimizationinfo, --nooptimizationinfo  JS optimization info is removed unless this flag is set (default: false)


--type                              type of input `perf|dtrace|instruments`. If not supplied it will be detected. 
--help                              print this help

EXAMPLE:

  Generate cpuprofile from DTrace data with default options 
  using higher switchrate in order to deal with large amount of data being emitted

    sudo profile_1ms.d -x switchrate=1000hz  -c  | cpuprofilify &gt; out.cpuprofile

  Generate cpuprofile from DTrace data with default options keeping v8 internals

    sudo profile_1ms.d -c  | cpuprofilify --v8internals &gt; out.cpuprofile

  Generate cpuprofile from DTrace data with default options filtering v8 gc events
    
    sudo profile_1ms.d -c  | cpuprofilify --nov8gc &gt; out.cpuprofile

cpuprofilify and `perf`

use this on any system that doesn't have DTrace, but perf instead like Linux

perf record -e cycles:u -g -- node --perf-basic-prof myapp.js
perf script | cpuprofilify &gt; out.cpuprofile

API

CpuProfilifier()

Creates new CpuProfilifier

Source:

index.js , lineno 12

CpuProfilifier::convert(trace, opts) → {Object}

Converts the given trace taking according to the given opts.

var cpuprofilifier = require('cpuprofilifier');
var cpuprofile = cpuprofilifier().convert(trace);
fs.writeFileSync('/tmp/my.cpuprofile', JSON.stringify(cpuprofile));

Parameters:

Name Type Argument Description

trace

Array.<String>

a trace generated via perf script or the profile_1ms.d DTrace script

opts

Object

<optional>

Properties

Name	Type	Description
`map`	string	a map containing symbols information, if not given it will be read from /tmp/perf-.map.
`type`	string	type of input `perf\|dtrace\|instruments`. If not supplied it will be detected.
`shortStack`	Boolean	stacks that have only one line are ignored unless this flag is set
`optimizationinfo`	Boolean	JS optimization info is removed unless this flag is set (default: false)
`unresolveds`	Boolean	unresolved addresses like `0x1a23c` are filtered from the trace unless this flag is set (default: false)
`sysinternals`	Boolean	sysinternals like `__lib_c_start...` are filtered from the trace unless this flag is set (default: false)
`v8internals`	Boolean	v8internals like `v8::internal::...` are filtered from the trace unless this flag is set (default: false)
`v8gc`	Boolean	when v8internals are filtered, garbage collection info is as well unless this flag set (default: true)

Source:

index.js , lineno 30

Returns:

an cpuprofile presentation of the given trace

Type: Object

generated with docme

License

MIT

@ramitos/cpuprofilify dependencies

inherits minimist npmlog resolve-jit-symbols trace-filter-internals xtend

@ramitos/cpuprofilify development dependencies

JSONSelect tape

FAQs

What is @ramitos/cpuprofilify?

Converts output of various profiling/sampling tools to the .cpuprofile format so it can be loaded into Chrome DevTools. Visit Snyk Advisor to see a full health score report for @ramitos/cpuprofilify, including popularity, security, maintenance & community analysis.

Is @ramitos/cpuprofilify popular?

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

Is @ramitos/cpuprofilify well maintained?

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

Is @ramitos/cpuprofilify safe to use?

The npm package @ramitos/cpuprofilify was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 11 November-2024, at 20:51 (UTC).

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

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

Monitor for new issues

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