Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@creditas/new-relic-react-lib

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@creditas/new-relic-react-lib

React component for New Relic script

1.1.0
npm

Version published: 4 years ago

Weekly downloads: 0; decreased by-100%

Maintainers: 5

Weekly downloads

Created: 5 years ago

Source

`@creditas/new-relic-react-lib`

New Relic - React integration plugin

The package is based on new-relic-react package by reggi and later forked by wanderio. This variation includes a recent version of New Relic Browser plugin to inject JavaScript snippet to instrument your app's webpages. The javascript provided in this library include all Pro and SPA features of new relic's browser agent.

It includes also rollup.js to bundle source code as React component.

Getting Started

new-relic-react-lib can be installed as any other npm package:

npm install --save @creditas/new-relic-react-lib

Application Structure

.
├── src                     # Source files
│   ├── index.js            # New Relic - React component source code
├── package.json            # Package information with list of dependencies
├── LICENSE.md
└── README.md

Props

licenseKey: String (required)
applicationID: String (required)
onlyConfig: Bool (optional)
- Default: false
beacon: String (optional)
- Default: 'bam.nr-data.net'
errorBeacon: String (optional)
- Default: 'bam.nr-data.net'
sa: Number (optional)
- Default: 1
agent: String (optional)
- Default: 'js-agent.newrelic.com/nr-1208.min.js'

Usage

Just import NewRelic into your component

Retrieve this information from your New Relic account

licenseKey: New Relic account license key
applicationID: Current New Relic application ID

<NewRelic licenseKey="{licenseKey}" applicationID="{applicationID}" onlyConfig /> where licenseKey and applicationID are real IDs you retrieved and onlyConfig defines if it will return a component or only the script of New Relic.

Following code is a super simple example of integration

import React from 'react'
import { NewRelic } from 'new-relic-agent-react'

const Html = () => {
  return (
    <html>
      <head>
        <meta charSet="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <meta httpEquiv="x-ua-compatible" content="ie=edge" />
        <NewRelic licenseKey="xxxx" applicationID="yyyy" />
        <title>Web App</title>
      </head>
      <body>
        <div id="app">{children}</div>
      </body>
    </html>
  )
}

export default Html

import React from 'react'
import { NewRelic } from 'new-relic-agent-react'

const Html = () => {
  return (
    <html>
      <head>
        <meta charSet="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <meta httpEquiv="x-ua-compatible" content="ie=edge" />
        <script type="text/javascript">
          <NewRelic licenseKey="xxxx" applicationID="yyyy" onlyConfig />
        </script>
        <title>Web App</title>
      </head>
      <body>
        <div id="app">{children}</div>
      </body>
    </html>
  )
}

export default Html

Contributing

All contributions must be done through opening pull requests.

Deploy

Deploy is automaticaly made by CircleCI when you set a tag in your git project. First hand, change the version in the package.json. To ensure consistency check JFrog to see which is the latest version released, then, add a tag to git

git checkout master
git tag vX.Y.Z
git checkout vX.Y.Z
git push origin vX.Y.Z

License

MIT - http://opensource.org/licenses/mit-license.php

based on https://github.com/wanderio/new-relic-react

FAQs

What is @creditas/new-relic-react-lib?

Is @creditas/new-relic-react-lib popular?

Is @creditas/new-relic-react-lib well maintained?

Package last updated on 18 May 2021

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.

Install