National Patience Month

    gatsby-plugin-newrelic

    2.2.2 • Public • Published

    Community Project header

    New Relic Gatsby Plugin

    Known Vulnerabilities npm status badge

    The New Relic Gatsby Plugin provides a simple to use configuration option for instrumenting your Gatsby site with New Relic's Browser Agent.

    Installation

    1. If you don't already have a New Relic account, sign-up for our free forever tier - no credit-card required!

    2. Go to https://one.newrelic.com

    3. Click on "Add more data" to add your website

    4. In the "Browser metrics" section, select "New Relic Browser"

    5. Select "Copy/Paste Javascript code" and copy the code

    6. Follow the steps to configure your instrumentation

    7. Enter your app name

    8. Click "Enable"

    9. Paste the JS snippet provided into a text editor

    10. Open your gatsby-config.js file for your project

    11. You'll need to copy information from the JS snippet, which looks like this:

      ;NREUM.loader_config={accountID:"<your account id>",trustKey:"<some integer>",agentID:"<some integer>",licenseKey:"<your license key>",applicationID:"<some integer>"}
      ;NREUM.info={beacon:"bam.nr-data.net",errorBeacon:"bam.nr-data.net",licenseKey:"<your license key>",applicationID:"<some integer>",sa:1}

      and turn it into a gatsby-config, adding it to gatsby-config.js as a plugin

      {
       resolve: 'gatsby-plugin-newrelic',
       options: {
         config: {
             instrumentationType: 'proAndSPA',
             accountId: '<some integer>',
             trustKey: '<some integer>',
             agentID: '<some integer>',
             licenseKey: '<the license key>',
             applicationID: '<some integer>',
             beacon: 'bam.nr-data.net',
             errorBeacon: 'bam.nr-data.net'
         }
       }
      }

      If you have a need for multiple environments, you can configure this like:

      {
        resolve: 'gatsby-plugin-newrelic',
        options: {
          config: {
              instrumentationType: 'proAndSPA',
              accountId: '<some integer>',
              trustKey: '<some integer>',
              agentID: '<some integer>',
              licenseKey: '<the license key>',
              applicationID: process.env.YOUR_ENVIRONMENT_KEY === "production" ? '<some integer>' : '<some other integer>',
              beacon: 'bam.nr-data.net',
              errorBeacon: 'bam.nr-data.net'
          }
        }
      }

    Getting Started

    Navigate to https://one.newrelic.com, select the Entity Explorer and then select your browser application to monitor metrics of your site.

    Support

    New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:

    Add the url for the support thread here

    Contributing

    Full details about how to contribute to Contributions to improve [Project Name] are encouraged! 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. To execute our corporate CLA, which is required if your contribution is on behalf of a company, or if you have any questions, please drop us an email at opensource@newrelic.com.

    License

    gatsby-plugin-newrelic is licensed under the Apache 2.0 License. gatsby-plugin-newrelic 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.

    Install

    npm i gatsby-plugin-newrelic

    DownloadsWeekly Downloads

    8,722

    Version

    2.2.2

    License

    Apache-2

    Unpacked Size

    179 kB

    Total Files

    23

    Last publish

    Collaborators

    • newrelic