@creditas/new-relic-react-lib
Advanced tools
Comparing version 1.0.11 to 1.1.0
{ | ||
"name": "@creditas/new-relic-react-lib", | ||
"version": "1.0.11", | ||
"version": "1.1.0", | ||
"description": "React component for New Relic script", | ||
@@ -30,3 +30,3 @@ "author": "@creditas", | ||
"@babel/preset-env": "^7.5.5", | ||
"@testing-library/react": "^9.1.4", | ||
"@testing-library/react": "^11.2.7", | ||
"cross-env": "^5.2.1", | ||
@@ -33,0 +33,0 @@ "kcd-scripts": "^1.6.0", |
@@ -5,7 +5,14 @@ # `@creditas/new-relic-react-lib` | ||
The package is based on [new-relic-react](https://github.com/reggi/new-relic-react) package by [reggi](https://github.com/reggi/) and later forked by [wanderio](https://github.com/wanderio/new-relic-react). | ||
This variation includes a recent version of New Relic Browser plugin to inject [JavaScript snippet](https://docs.newrelic.com/docs/browser/new-relic-browser/page-load-timing/instrumentation-page-load-timing) to instrument your app's webpages. | ||
The javascript provided in this library include all Pro and SPA features of [new relic's browser agent](https://docs.newrelic.com/docs/browser/new-relic-browser/getting-started/introduction-new-relic-browser). | ||
The package is based on | ||
[new-relic-react](https://github.com/reggi/new-relic-react) package by | ||
[reggi](https://github.com/reggi/) and later forked by | ||
[wanderio](https://github.com/wanderio/new-relic-react). This variation includes | ||
a recent version of New Relic Browser plugin to inject | ||
[JavaScript snippet](https://docs.newrelic.com/docs/browser/new-relic-browser/page-load-timing/instrumentation-page-load-timing) | ||
to instrument your app's webpages. The javascript provided in this library | ||
include all Pro and SPA features of | ||
[new relic's browser agent](https://docs.newrelic.com/docs/browser/new-relic-browser/getting-started/introduction-new-relic-browser). | ||
It includes also [rollup.js](http://rollupjs.org/) to bundle source code as React component. | ||
It includes also [rollup.js](http://rollupjs.org/) to bundle source code as | ||
React component. | ||
@@ -31,2 +38,17 @@ ## Getting Started | ||
## 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 | ||
@@ -37,7 +59,9 @@ | ||
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. | ||
`<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. | ||
@@ -61,5 +85,3 @@ Following code is a super simple example of integration | ||
<body> | ||
<div id="app"> | ||
{children} | ||
</div> | ||
<div id="app">{children}</div> | ||
</body> | ||
@@ -92,5 +114,3 @@ </html> | ||
<body> | ||
<div id="app"> | ||
{children} | ||
</div> | ||
<div id="app">{children}</div> | ||
</body> | ||
@@ -110,3 +130,6 @@ </html> | ||
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 | ||
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 | ||
@@ -126,4 +149,4 @@ ```sh | ||
----- | ||
--- | ||
based on https://github.com/wanderio/new-relic-react |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
29802
146