{"id":16293424,"url":"https://github.com/alekzonder/nprof","last_synced_at":"2026-04-28T08:03:26.080Z","repository":{"id":65369950,"uuid":"71421974","full_name":"alekzonder/nprof","owner":"alekzonder","description":"small promise interface to v8-profiler functions and express.js helper","archived":false,"fork":false,"pushed_at":"2018-01-25T12:17:29.000Z","size":16,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-31T10:29:50.155Z","etag":null,"topics":["cpu-profiling","memory-snapshot","nodejs","profile","profiling","v8-profiler"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alekzonder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-20T03:28:16.000Z","updated_at":"2023-04-11T15:19:23.000Z","dependencies_parsed_at":"2023-01-19T23:15:25.422Z","dependency_job_id":null,"html_url":"https://github.com/alekzonder/nprof","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/alekzonder/nprof","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fnprof","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fnprof/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fnprof/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fnprof/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alekzonder","download_url":"https://codeload.github.com/alekzonder/nprof/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fnprof/sbom","scorecard":{"id":179195,"data":{"date":"2025-08-11","repo":{"name":"github.com/alekzonder/nprof","commit":"581b74b89b5f2e35db87c61fafd08a81f7129798"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 0/27 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-16T18:28:57.854Z","repository_id":65369950,"created_at":"2025-08-16T18:28:57.854Z","updated_at":"2025-08-16T18:28:57.854Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32371673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-27T20:07:02.737Z","status":"online","status_checked_at":"2026-04-28T02:00:07.250Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cpu-profiling","memory-snapshot","nodejs","profile","profiling","v8-profiler"],"created_at":"2024-10-10T20:11:14.645Z","updated_at":"2026-04-28T08:03:26.064Z","avatar_url":"https://github.com/alekzonder.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nprof\n\nsmall promise interface to [v8-profiler](https://github.com/node-inspector/v8-profiler) functions\n\n[![NPM](https://nodei.co/npm/nprof.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/nprof/)\n\n[![Code Climate](https://codeclimate.com/github/alekzonder/nprof/badges/gpa.svg)](https://codeclimate.com/github/alekzonder/nprof)\n[![bitHound Code](https://www.bithound.io/github/alekzonder/nprof/badges/code.svg)](https://www.bithound.io/github/alekzonder/nprof)\n[![bitHound Dependencies](https://www.bithound.io/github/alekzonder/nprof/badges/dependencies.svg)](https://www.bithound.io/github/alekzonder/nprof/master/dependencies/npm)\n\n# install\n\n```\nnpm i --save nprof\n```\n\n# usage\n\n```js\nvar nprof = require('nprof');\n\nnprof.takeMemorySnapshot('/tmp/snapshots')\n    .then((info) =\u003e {})\n    .catch((error) =\u003e {});\n\nnprof.cpuProfile('/tmp/snapshots', 2000)\n    .then((info) =\u003e {})\n    .catch((error) =\u003e {});\n\n```\n\n# api\n\n## takeMemorySnapshot(snapshotPath, options) : Promise\n\n- **snapshotPath** - path to directory (nprof generate filenames)\n- **options**\n    - **filepath** - set this option with filepath, if you need your own filename\n\ntake memory snapshot and save to snapshotPath\n\n### filename mask\n\n```\n${snapshotPath}/v8.cpu.2016-09-20T13-56-53-936.cpuprofile'\n```\n\n## cpuProfile(snapshotPath, timeout, options) : Promise\n\n- **snapshotPath** - path to directory (nprof generate filenames, see)\n- **timeout**      - timeout in ms\n- **options**\n    - **filepath** - set this option with filepath, if you need your own filepath and filename\n\nstart cpu profiling, stop after timeout and save to snapshotPath\n\n### filename mask\n\n```\n${snapshotPath}/v8.cpu.2016-09-20T13-56-53-93.timeout.' + timeout + '.cpuprofile'\n```\n\n## startCpuProfile()\n\nstart cpu profiling\n\n## stopCpuProfile() : CpuProfile\n\nstop cpu proflile\n\n## saveCpuProfile(profile, snapshotPath, options) : Promise\n\nsave profile to file\n\n- **profile** - profile object\n- **snapshotPath** - path to directory (nprof generate filenames)\n- **options**\n    - **filepath** - set this option with filepath, if you need your own filename\n\n\n# express.js helper\n\nexpress.js profiling helper\n\n## usage\n\n```js\n\n// logger is you logger with info, warn and error methods\n\nvar nprofRegister = require('nprof/express/register');\n\nvar app = express();\n\nvar nprofConfig = {\n    snapshotPath: '/tmp/snapshots'\n};\n\nnprofRegister(logger, app, nprofConfig);\n\n```\n\n## REST API\n\n## POST /_service/profile/cpu?timeout={int}\n\n- **timeout** - profile timeout, length of profiling in ms, default = 5000\n\nprofile CPU, save to `nprofConfig.snapshotPath`\n\n## POST /_service/profile/cpu/start\n\nstart cpu profiling until POST /_profile/cpu/stop not executed\n\n## POST /_service/profile/cpu/stop\n\nstop cpu profiling and save to `nprofConfig.snapshotPath`\n\n## POST /_service/profile/mem\n\ntake memory snapshot and save to `nprofConfig.snapshotPath`\n\n## GET /_service/profile/mem/usage\n\nscale GET-param can be number or string (kb, mb, gb)\n\nget actual memory usage via `process.memoryUsage`\n\n## POST /_service/profile/gc/start\n\nexec global.gc() if process started with `--expose-gc` option\n\nreturn before and after `process.memoryUsage`\n\n## GET /_service/profile/status\n\nreturn memory usage and event loop delay\n\nyou can add your own status metrics via config.statusFn hook function\n\nsee examples/status for more information\n\n\n\n# LICENSE\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falekzonder%2Fnprof","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falekzonder%2Fnprof","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falekzonder%2Fnprof/lists"}