Write one or two short paragraphs that describe what your app does—and more importantly, why users should care. Avoid too much technical jargon: Your content should be understandable to someone who doesn't have much knowledge of New Relic's technologies. And include links to New Relic docs or other apps.
For example:
This application show you "Events" just before the JavaScript error happened. You can easy to know what the customer did. You don't need to ask but just see this Nerdlet to grasp customers operation, then no many time needed to reproduce the error.
This project is distributed under the Apache 2 license.
List any prerequisites for using your app, and include links to other New Relic features when necessary.
For example:
Required:
- New Relic Browser agent(s) installed on your web application and the related access to New Relic One.
Include a step-by-step procedure on how to get your app installed and deployed. The clone and deploy steps are similar across all apps. If your app has additional steps required to get started, include them here or in their own section.
- Ensure that you have Git and NPM installed. If you're unsure whether you have one or both of them installed, run the following commands. (If you have them installed, these commands return a version number; if not, the commands aren't recognized.)
git --version
npm -v
- Install the NR1 CLI by going to the developer center, and following the instructions to install and set up your New Relic development environment. This should take about 5 minutes.
- Execute the following command to clone this repository and run the code locally against your New Relic data:
nr1 nerdpack:clone -r https://github.com/newrelic-experimental/nr1-js-error-tracking.git
cd nr1-js-error-tracking
nr1 nerdpack:serve
Visit https://one.newrelic.com/?nerdpacks=local to launch your app locally.
You can use this nerdlet on Browser application.
Please Go to "Entity explorer" > "Browser applications" > "{{ YOUR_APPLICATION_NAME }}" > "JS Error Tracking"
Include the necessary steps to deploy your app. Generally, you shouldn't need to change any of these steps.
Open a command prompt in the app's directory and run the following commands.
# If you need to create a new uuid for the account to which you're deploying this app, use the following
# nr1 nerdpack:uuid -g [--profile=your_profile_name]
# to see a list of APIkeys / profiles available in your development environment, run nr1 credentials:list
nr1 nerdpack:publish [--profile=your_profile_name]
nr1 nerdpack:deploy [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]
nr1 nerdpack:subscribe [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]
Visit https://one.newrelic.com, and launch your app in New Relic.
New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.
We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.
Work with the Explorer's Hub team to create a tag for your app, then update the link below.
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:
https://discuss.newrelic.com/t/{{ APP_NAME }} (Note: This URL is subject to change before GA)
Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.
Work with the Open Source Office to update the email alias below.
Contributions are encouraged! If you submit an enhancement request, we'll invite you to contribute the change yourself. Please review our Contributors Guide.
Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource+{{ APP_NAME }}@newrelic.com.