@newrelic/native-metrics
Advanced tools
@newrelic/native-metrics is an npm package that provides native bindings to collect system and process metrics for Node.js applications. It is designed to work with New Relic's monitoring tools to provide detailed insights into the performance and health of your Node.js applications.
Collecting GC Metrics
This feature allows you to collect garbage collection (GC) metrics. The code sample demonstrates how to set up an event listener for GC events, which logs information about each GC event.
const nativeMetrics = require('@newrelic/native-metrics')();
nativeMetrics.on('gc', (gc) => {
console.log('Garbage collection occurred:', gc);
});Collecting Event Loop Metrics
This feature allows you to collect event loop metrics. The code sample shows how to set up an event listener for event loop metrics, which logs information about the event loop.
const nativeMetrics = require('@newrelic/native-metrics')();
nativeMetrics.on('loop', (loop) => {
console.log('Event loop metrics:', loop);
});Collecting System Metrics
This feature allows you to collect system-level metrics such as CPU and memory usage. The code sample demonstrates how to set up an event listener for system metrics, which logs information about the system's performance.
const nativeMetrics = require('@newrelic/native-metrics')();
nativeMetrics.on('system', (system) => {
console.log('System metrics:', system);
});event-loop-stats is a package that provides statistics about the event loop in Node.js applications. It is similar to @newrelic/native-metrics in that it collects event loop metrics, but it focuses solely on the event loop and does not provide other types of metrics.
os-utils is a package that provides basic operating system metrics such as CPU and memory usage. It is similar to @newrelic/native-metrics in that it collects system metrics, but it does not provide the same level of detail or integration with New Relic's monitoring tools.
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:
$ npm install @newrelic/native-metrics --build-from-source
For more information, please see the agent installation guide and compatibility and requirements.
var getMetricEmitter = require('@newrelic/native-metrics')
var emitter = getMetricEmitter()
if (emitter.gcEnabled) {
setInterval(() => {
var gcMetrics = emitter.getGCMetrics()
for (var type in gcMetrics) {
console.log('GC type name:', type)
console.log('GC type id:', gcMetrics[type].typeId)
console.log('GC metrics:', gcMetrics[type].metrics)
}
}, 1000)
}
if (emitter.usageEnabled) {
emitter.on('usage', (usage) => console.log(usage))
}
if (emitter.loopEnabled) {
setInterval(() => {
var loopMetrics = emitter.getLoopMetrics()
console.log('Total time:', loopMetrics.usage.total)
console.log('Min time:', loopMetrics.usage.min)
console.log('Max time:', loopMetrics.usage.max)
console.log('Sum of squares:', loopMetrics.usage.sumOfSquares)
console.log('Count:', loopMetrics.usage.count)
}, 1000)
}
The metric emitter keeps a referenced timer running for its periodic sampling
events. For a graceful shutdown of the process call NativeMetricEmitter#unbind.
getMetricEmitter().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.
var emitter = getMetricEmitter({timeout: 15000})
emitter.unbind()
emitter.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.
FAQs
A module for generating metrics from V8.
The npm package @newrelic/native-metrics receives a total of 706,402 weekly downloads. As such, @newrelic/native-metrics popularity was classified as popular.
We found that @newrelic/native-metrics demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.