Gathering detailed insights and metrics for @newrelic/native-metrics
Gathering detailed insights and metrics for @newrelic/native-metrics
Optional native module for collecting low-level Node & V8 metrics
npm install @newrelic/native-metrics
Typescript
Module System
Min. Node Version
Node Version
NPM Version
95.5
Supply Chain
98.9
Quality
77.6
Maintenance
100
Vulnerability
87.6
License
C++ (98.62%)
JavaScript (1.04%)
Shell (0.23%)
Python (0.09%)
Dockerfile (0.02%)
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Total Downloads
204,650,079
Last Day
184,635
Last Week
933,603
Last Month
3,954,999
Last Year
42,280,244
Apache-2.0 License
62 Stars
514 Commits
41 Forks
14 Watchers
17 Branches
53 Contributors
Updated on Dec 27, 2024
Minified
Minified + Gzipped
Latest Version
11.0.0
Package Id
@newrelic/native-metrics@11.0.0
Unpacked Size
1.75 MB
Size
632.16 kB
File Count
32
NPM Version
10.7.0
Node Version
18.20.4
Published on
Jul 31, 2024
Cumulative downloads
Total Downloads
Last Day
7.5%
184,635
Compared to previous day
Last Week
5.7%
933,603
Compared to previous week
Last Month
9.9%
3,954,999
Compared to previous month
Last Year
4.7%
42,280,244
Compared to previous year
This module provides hooks into the native layer of Node.js to provide metrics for
the New Relic Node.js Agent. It gathers information that isn't
available at the JS layer about the V8 virtual machine and the process health.
It comes packaged with the New Relic Agent since v2, and there is nothing that
needs to be done. For Agent v1 you need only to install the module alongside
newrelic
.
Typically, most users use the version auto-installed by the agent.
In some cases, installing a specific version is ideal. For example, new features or major changes might be released via a major version update to this module, prior to inclusion in the main New Relic Node.js agent.
$ npm install --save @newrelic/native-metrics
Note that this is a native module and thus must be compiled to function. Pre-built binaries are included in the package for the following platforms, across all LTS versions of Node.js:
If your system does not match the above matrix, you will need to have a compiler installed on the machine where this is to be deployed. See node-gyp for more information on compiling native addons.
If you prepare and package deployments on one machine and install them on another, the two machines must have the same operating system and architecture. If they are not, you will need to re-build the native module after deploying in order to get the correct binaries.
During installation, the module will first attempt to locate a prebuilt binary for the target machine within its included list of prebuilt binaries. If that fails, it will attempt a standard node-gyp build. If you do not want to use prebuilt binary, or know that it will need to be built, you can force a build:
1$ npm install @newrelic/native-metrics --build-from-source
For more information, please see the agent installation guide and compatibility and requirements.
1var getMetricEmitter = require('@newrelic/native-metrics') 2 3var emitter = getMetricEmitter() 4if (emitter.gcEnabled) { 5 setInterval(() => { 6 var gcMetrics = emitter.getGCMetrics() 7 for (var type in gcMetrics) { 8 console.log('GC type name:', type) 9 console.log('GC type id:', gcMetrics[type].typeId) 10 console.log('GC metrics:', gcMetrics[type].metrics) 11 } 12 }, 1000) 13} 14if (emitter.usageEnabled) { 15 emitter.on('usage', (usage) => console.log(usage)) 16} 17if (emitter.loopEnabled) { 18 setInterval(() => { 19 var loopMetrics = emitter.getLoopMetrics() 20 console.log('Total time:', loopMetrics.usage.total) 21 console.log('Min time:', loopMetrics.usage.min) 22 console.log('Max time:', loopMetrics.usage.max) 23 console.log('Sum of squares:', loopMetrics.usage.sumOfSquares) 24 console.log('Count:', loopMetrics.usage.count) 25 }, 1000) 26}
The metric emitter keeps a referenced timer running for its periodic sampling
events. For a graceful shutdown of the process call NativeMetricEmitter#unbind
.
1getMetricEmitter().unbind() // Process will now close gracefully.
If you would like to change the period of the sampling, simply unbind and then
call NativeMetricEmitter#bind
with the new period.
1var emitter = getMetricEmitter({timeout: 15000}) 2emitter.unbind() 3emitter.bind(10000) // Samples will now fire once every 10 seconds.
This module includes a list of unit and functional tests. To run these tests, use the following command
$ npm run test
You may also run individual test suites with the following commands
$ npm run unit
$ npm run integration
Should you need assistance with New Relic products, you are in good hands with several support channels.
If the issue has been confirmed as a bug or is a feature request, please file a GitHub issue.
Support Channels
At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise.
We define "Personal Data" as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address and email address.
Please review New Relic’s General Data Privacy Notice for more information.
See our roadmap, to learn more about our product vision, understand our plans, and provide us valuable feedback.
We encourage your contributions to improve Native Metrics for the New Relic Node.js Agent! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.
To all contributors, we thank you! Without your contribution, this project would not be what it is today.
If you would like to contribute to this project, please review these guidelines.
A note about vulnerabilities
As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.
The Native Metrics for New Relic Node.js Agent package is licensed under the Apache 2.0 License.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
all changesets reviewed
Reason
no dangerous workflow patterns detected
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
Reason
packaging workflow detected
Details
Reason
security policy file detected
Details
Reason
SAST tool detected but not run on all commits
Details
Reason
branch protection is not maximal on development and all release branches
Details
Reason
2 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
project is not fuzzed
Details
Score
Last Scanned on 2025-03-03
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More