diff --git a/README.md b/README.md index 41aebf0..4e15aec 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,9 @@ [![New Relic One Catalog Project header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/New_Relic_One_Catalog_Project.png)](https://opensource.newrelic.com/oss-category/#new-relic-one-catalog-project) -# New Relic One Browser Analyzer (nr1-browser-analyzer) +# New Relic Browser Analyzer ![CI](https://github.com/newrelic/nr1-browser-analyzer/workflows/CI/badge.svg) ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/newrelic/nr1-browser-analyzer?include_prereleases&sort=semver) [![Snyk](https://snyk.io/test/github/newrelic/nr1-browser-analyzer/badge.svg)](https://snyk.io/test/github/newrelic/nr1-browser-analyzer) - - -This application is maintained by the New Relic Labs team. Connect with us directly by [creating issues](../../issues) or [starting a discussion](../../discussions) in this repo. - ## Usage Using the [`Apdex`](https://docs.newrelic.com/docs/apm/new-relic-apm/apdex/apdex-measure-user-satisfaction) score generated by [`Browser's`](https://newrelic.com/products/browser-monitoring) _PageView_ event, Browser Analyzer displays an analysis of performance, and forecasts how performance improvements can impact Key Performance Indicators, like bounce rate or traffic. @@ -16,71 +12,45 @@ This application allows you to explore the performance of individual site pages, ![Screenshot #1](catalog/screenshots/nr1-browser-analyzer-01.png) -> Note that this NerdPack is not served as a launcher on the homepage of [New Relic One](https://one.newrelic.com). Instead, you'll have to navigate to a Browser app via the Entity Explorer in New Relic One. - -## Open Source License - -This project is distributed under the [Apache 2 license](LICENSE). - ## Dependencies Requires [`New Relic Browser`](https://newrelic.com/products/browser-monitoring). -## Getting started - -First, ensure that you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [NPM](https://www.npmjs.com/get-npm) installed. If you're unsure whether you have one or both of them installed, run the following command(s) (If you have them installed these commands will return a version number, if not, the commands won't be recognized): - -```bash -git --version -npm -v -``` +## Enabling this App -Next, install the [NR1 CLI](https://one.newrelic.com/launcher/developer-center.launcher) by going to [this link](https://one.newrelic.com/launcher/developer-center.launcher) and following the instructions (5 minutes or less) to install and setup your New Relic development environment. +This App is available via the New Relic Catalog. -Next, to clone this repository and run the code locally against your New Relic data, execute the following command: +To enable it in your account, go to `Add Data > Apps and Visualzations` and search for "Browser Analyzer". Click the card, and then click the "Add this App" button to add it to your account(s). -```bash -nr1 nerdpack:clone -r https://github.com/newrelic/nr1-browser-analyzer.git -cd nr1-browser-analyzer -nr1 nerdpack:serve -``` +Once subscribed: +1. navigate to a Browser app via the Entity Explorer in New Relic One +2. locate the "Site Analyzer" menu item in the secondary left-nav, found under "More Views" +3. click "Site Analyzer" to open the app (note: on the first time accessing the app, you may be prompted to enable it) -Visit [https://one.newrelic.com/?nerdpacks=local](https://one.newrelic.com/?nerdpacks=local), navigate to the Nerdpack, and :sparkles: +#### Manual Deployment +If you need to customize this application, you can fork the codebase and follow the instructions on how to [Customize a Nerdpack](https://developer.newrelic.com/build-apps/customize-nerdpack). If you have a change you feel everyone can benefit from, please submit a PR! -## Deploying this Nerdpack +## Support -Open a command prompt in the nerdpack's directory and run the following commands. - -```bash -# To create a new uuid for the nerdpack so that you can deploy it to your account: -nr1 nerdpack:uuid -g [--profile=your_profile_name] - -# To see a list of APIkeys / profiles available in your development environment: -# nr1 profiles: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](https://one.newrelic.com), navigate to the Nerdpack, and :sparkles: - -## Community Support - -The discussions page on this repository is enabled for customers to interact with New Relic employees as well as other customers to get help and share best practices. You can check out the discussions page for this repo [here](../../discussions). + -You can also interact with us and other customers to troubleshoot issues and share best practices on [New Relic Explorers Hub](https://discuss.newrelic.com). +This project is actively maintained by the New Relic Labs team. Connect with us directly by [creating issues](../../issues) or [asking questions in the discussions section](../../discussions) of this repo. -## Issues / Enhancement Requests +We also encourage you to bring your experiences and questions to the [Explorers Hub](https://discuss.newrelic.com) where our community members collaborate on solutions and new ideas. -Issues and enhancement requests can be submitted in the [Issues tab of this repository](../../issues). Please search for and review the existing open issues before submitting a new issue. +New Relic has open-sourced this project, which is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. ## Security As noted in our [security policy](https://github.com/newrelic/nr1-browser-analyzer/security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals. If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic). -## Contributing +## Contributing + +Contributions are welcome; please review our [Contributors Guide](CONTRIBUTING.md). -Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself :grin:). Please review our [Contributors Guide](CONTRIBUTING.md). +Keep in mind that when you submit a 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@newrelic.com. -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@newrelic.com. +## Open Source License + +This project is distributed under the [Apache 2 license](LICENSE).