https://github.com/dmitryfillo/newrelic-reduced

New Relic plugin that can be disabled for some users. Cut your costs!
https://github.com/dmitryfillo/newrelic-reduced

newrelic

Last synced: about 1 year ago
JSON representation

New Relic plugin that can be disabled for some users. Cut your costs!

• Host: GitHub
• URL: https://github.com/dmitryfillo/newrelic-reduced
• Owner: DmitryFillo
• License: bsd-2-clause
• Created: 2018-07-04T14:30:53.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-09-07T09:01:37.000Z (almost 5 years ago)
• Last Synced: 2025-01-11T01:12:38.371Z (over 1 year ago)
• Topics: newrelic
• Language: JavaScript
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# newrelic-reduced

New Relic plugin that can be disabled for some users.

![New Relic](https://newrelic.com/assets/newrelic/source/NewRelic-logo-bug.svg)

## 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.NRReducedID` is your NR ID. Required.

      * `window.NRReducedKey` is your NR Key. Required.

      * `window.NRReducedFactor` 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. Optional, default is 100.

      * `window.NRReducedLogging` is logging boolean setting. If `true` you'll see `NR enabled` message in the console when NR script is enabled. Optional, default is `false`.

      * `window.NRReducedOpts` is options for original NR script. Check section *Additional options* below. Optional, defaults see in the source code.

  * Import plugin:

      * Use CDN: `` where `x.x.x` is [version](https://github.com/DmitryFillo/newrelic-reduced/releases).

      * Use imports: `import 'newrelic-reduced'` or `require('newrelic-reduced')`.

      * Use any other way to include it into HTML from `lib/index.js`.

**NOTES:**

  * You should define variables before import!

  * You should define NR script before any other scripts, better to place it right after ``.

### 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. If `true` you'll see `NR enabled` message 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.

```javascript

window.NRReducedOpts = {

    beacon: 'api.example.com',

    jsAgentPath: 'example.com/nr.js',

    errorBeacon: 'apie.example.com',

    sa: 2

};

```