newrelic-reduced
New Relic plugin that can be disabled for some users.
Motivation
Need to reduce costs by disabling NR browser monitoring for some users? This plugin is for you.
How to use
Just do 2 steps:
- Define variables:
window.NRReducedIDis your NR ID. Required.window.NRReducedKeyis your NR Key. Required.window.NRReducedFactoris percent integer value describing probability of NR enabling. E.g. value 50 means NR will be enabled for ~50% of users. 0 <factor< 100. Optional, default is 100.window.NRReducedLoggingis logging boolean setting. Iftrueyou'll seeNR enabledmessage in the console when NR script is enabled. Optional, default isfalse.window.NRReducedOptsis options for original NR script. Check section Additional options below. Optional, defaults see in the source code.
- Import plugin:
- Use CDN:
<script src="https://cdn.jsdelivr.net/npm/newrelic-reduced@x.x.x/lib/index.js"></script>wherex.x.xis version. - Use imports:
import 'newrelic-reduced'orrequire('newrelic-reduced'). - Use any other way to include it into HTML from
lib/index.js.
- Use CDN:
NOTES:
- You should define variables before import!
- You should define NR script before any other scripts, better to place it right after
<head>.
Variables substitutions
Instead of defining global variables prefixied with window.NRReduced you can replace special placeholders in the source code:
#{NRID}is your NR ID. Required.#{NRKey}is your NR Key. Required.#{NRFactor}is percent integer value describing probability of NR enabling. E.g. value 50 means NR will be enabled for ~50% of users. 0 <factor< 100. Can be string value, e.g. "50".#{NRIsLoggingEnabled}is logging boolean setting. Iftrueyou'll seeNR enabledmessage in the console when NR script is enabled. Can be string value, e.g. "true" or "false".#{NROpts}is options for original NR script. Can be string value, e.g. "{ ... }". Check section Additional options below.
Additional options
It's some variables from native NR script, check the source code for more info.
windowNRReducedOpts = beacon: 'api.example.com' jsAgentPath: 'example.com/nr.js' errorBeacon: 'apie.example.com' sa: 2;