-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update enablement and support sections
- Loading branch information
Showing
1 changed file
with
21 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| [](https://opensource.newrelic.com/oss-category/#new-relic-one-catalog-project) | ||
|
|
||
| # Observability Maps (nr1-observability-maps) | ||
| # Observability Maps | ||
|
|
||
|   [](https://snyk.io/test/github/newrelic/nr1-observability-maps) | ||
|
|
||
|
|
@@ -12,74 +12,39 @@ Using Observability Maps you can make connections between different types of ent | |
|
|
||
| Right click on nodes and links for further configuration options and shortcuts. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| ## Dashboard Widget | ||
|
|
||
| You can also add this to your favorite dashboard by navigating to Apps > Custom Visualizations and selecting Observability Maps Widget. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Open source license | ||
|
|
||
| This project is distributed under the [Apache 2 license](LICENSE). | ||
|
|
||
| ## Dependencies | ||
|
|
||
| Requires data in NRDB from any or all of the New Relic products. | ||
|
|
||
| ## Getting started | ||
|
|
||
| 1. 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. (If you have them installed these commands will return a version number, if not, the commands won't be recognized.) | ||
| ## Enabling this App | ||
|
|
||
| ```bash | ||
| git --version | ||
| npm -v | ||
| ``` | ||
| This App is available via the New Relic Catalog. | ||
|
|
||
| 2. Install the [New Relic One 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 set up your New Relic development environment. | ||
| To enable it in your account: | ||
| 1. go to `Add Data > Apps and Visualzations` and search for "Observability Maps" | ||
| 2. Click the `Observability Maps` card, and then click the `Add this App` button to add it to your account(s) | ||
| 3. Click `Open App` to launch the app (note: on the first time accessing the app, you may be prompted to enable it) | ||
|
|
||
| 3. Run the following command to clone this repository and run the code locally against your New Relic data: | ||
| Once you have added your accounts, you can also open the app by: | ||
| 1. Open the `Apps` left-hand navigation menu item (you may need to click on the `Add More` ellipsis if it doesn't show up by default) | ||
| 2. In the `Your Apps` section, locate and click on the `Observability Maps` card to open the app | ||
|
|
||
| ```bash | ||
| nr1 nerdpack:clone -r https://github.com/newrelic/nr1-observability-maps.git | ||
| cd nr1-observability-maps | ||
| nr1 nerdpack:serve | ||
| ``` | ||
| **Bonus!** This app can also be added as [a widget to your dashboards](https://docs.newrelic.com/docs/query-your-data/explore-query-data/dashboards/add-custom-visualizations-your-dashboards/) - just navigate to `Apps > Custom Visualizations` and select `Observability Maps Widget`. | ||
|
|
||
| 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 the app, 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. | ||
| <a href="https://github.com/newrelic?q=nrlabs-viz&type=all&language=&sort="><img src="https://user-images.githubusercontent.com/1786630/214122263-7a5795f6-f4e3-4aa0-b3f5-2f27aff16098.png" height=50 /></a> | ||
|
|
||
| ```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] | ||
| 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. | ||
|
|
||
| # To see a list of APIkeys / profiles available in your development environment: | ||
| # nr1 profiles:list | ||
| 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. | ||
|
|
||
| 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 more :sparkles: | ||
| ## Community Support | ||
| New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices. Like all New Relic open source community projects, there's a related topic in the New Relic Explorers Hub. You can find this project's topic/threads here: | ||
| [https://discuss.newrelic.com/t/nr1-observability-maps-nerdpack/93091](https://discuss.newrelic.com/t/nr1-observability-maps-nerdpack/93091) | ||
| Please do not report issues with Observability Maps to New Relic Global Technical Support. Instead, visit the [`Explorers Hub`](https://discuss.newrelic.com/c/build-on-new-relic) for troubleshooting and best-practices. | ||
| ## Issues / enhancement requests | ||
| 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 | ||
|
|
||
|
|
@@ -92,3 +57,6 @@ Contributions are welcome (and if you submit a enhancement request, expect to be | |
|
|
||
| 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 [email protected]. | ||
|
|
||
| ## Open source license | ||
|
|
||
| This project is distributed under the [Apache 2 license](LICENSE). | ||