@newrelic/browser-agent
Advanced tools
[](https://opensource.newrelic.com/oss-category/#new-relic-experimental)
The New Relic Browser Agent instruments your website and provides observability into the performance and behavior of your application. This NPM Library is an in-progress implementation of the New Relic Browser Agent, accessible through NPM. Please see the Differences and Features sections to compare how this library differs from the other offerings of the New Relic Browser Agent.
Using npm:
npm install @newrelic/browser-agent
or yarn
yarn add @newrelic/browser-agent
Using unpkg
Default (defaults to ES6)
<script src="https://unpkg.com/@newrelic/browser-agent/bundled"></script>
ES6 compatible (same resolve as default)
<script src="https://unpkg.com/@newrelic/browser-agent/bundled/es6/index.js"></script>
ES5 compatible
<script src="https://unpkg.com/@newrelic/browser-agent/bundled/es5/index.js"></script>
<< App.js >>
// initialize the agent as close to
// the top level of the application as possible
import NR from '@newrelic/browser-agent'
const options = {
// See 'Configuring your application'
}
const nr = new NR()
nr.start(options).then(() => {
console.log("Browser Agent Initialized!")
})
<head>
<script src="https://unpkg.com/@newrelic/browser-agent/bundled"></script>
<script>
const { BrowserAgent } = NRBA;
const options = {
// See 'Configuring your application'
}
const agent = new BrowserAgent()
agent.start(options).then(() => {
console.log("Browser Agent Initialized!")
})
</script>
</head>
The New Relic Browser Agent can maintain separate configuration scopes by creating new instances. Micro front end patterns can rely on separate NR instances and can thus each report their own scoped data to separate New Relic applications.
// <<< MICRO FRONT END APP 1 >>>
// ---- App.js ----
import { BrowserAgent } from '@newrelic/browser-agent'
const options = {
// see 'Configuring your application'
}
const nr = new BrowserAgent()
nr.features.JSERRORS.enabled = true
nr.start(options).then(() => {
console.log("Browser Agent Initialized!")
})
// ---- MyComponent.js ----
class MyComponent() {
try {
...
} catch(err) {
nr.noticeError(err)
// reports to applicationID 1
}
}
The NR interface's start method accepts an options object to configure the agent:
const options = {
licenseKey: String
applicationID: String
beacon: String
}
nr.start(options)
You can find licenseKey, applicationID and beacon values in the New Relic UI's Browser Application Settings page (one.newrelic.com > Browser > (select an app) > Settings > Application settings.)
| Feature | Subfeature | Default | Description |
|---|---|---|---|
| JSERRORS | enabled | true | Enable's noticeError method |
| JSERRORS | auto | false | Reports all global errors |
Features must be set before calling the .start() method.
This NPM package can currently capture JavaScript Error reporting in two ways. These errors will be reported to the appId & licenseKey specified in your configuration.
import { BrowserAgent } from '@newrelic/browser-agent'
const browserAgent = new BrowserAgent()
// enable API scoped to applicationID
browserAgent.features.JSERRORS.enabled = true
// report global errors to applicationID
browserAgent.features.JSERRORS.auto = true
// enable features before starting the agent
browserAgent.start(options)
browserAgent.features.jserrors.enabled = true
browserAgent.noticeError(new Error())
Set browserAgent.jserrors.enabled to true to report specific errors via the noticeError API.
browserAgent.features.jserrors.auto = true
Set browserAgent.jserrors.auto to true to report all errors on the page.
We encourage your contributions to improve the Browser agent! Keep in mind that 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 (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.
For more details on how best to contribute, see CONTRIBUTING.md
The Browser agent is licensed under the Apache 2.0 License.
The Browser agent also uses source code from third-party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the third-party notices document.
FAQs
New Relic Browser Agent
The npm package @newrelic/browser-agent receives a total of 73,747 weekly downloads. As such, @newrelic/browser-agent popularity was classified as popular.
We found that @newrelic/browser-agent 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.