Skip to content

Commit

Permalink
(feat:guide) Add new custom visualization guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jaesius committed Mar 26, 2021
1 parent d08a00a commit e229a65
Show file tree
Hide file tree
Showing 8 changed files with 144 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/build-an-app/click-apps-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/build-an-app/click-viz-launcher.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/build-an-app/configure-viz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/build-an-app/review-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/build-an-app/select-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/build-an-app/select-viz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
144 changes: 144 additions & 0 deletions src/markdown-pages/build-apps/add-visualizations-to-dashboard.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
path: '/build-apps/add-visualizations-to-dashboard'
duration: '10 min'
title: 'Add custom visualizations to your dashboards'
template: 'GuideTemplate'
description: 'Add your custom visualization to a New Relic dashboard'
resources:
- title: Add custom visualizations to your dashboards
url: '/build-apps/add-visualizations-to-dashboard'
- title: New Relic One VSCode extension
url: https://marketplace.visualstudio.com/items?itemName=new-relic.nr1
- title: 'Build on New Relic One'
url: https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/build-new-relic-one/new-relic-one-build-your-own-custom-new-relic-one-application
- title: New Relic VSCode extension pack
url: https://marketplace.visualstudio.com/items?itemName=new-relic.new-relic-extension-pack
tags:
- nr1 cli
- NR One Catalog
- visualizations
---

<Intro>

This guide builds off of the previous [Customize visualizations with configuration](build-apps/customize-visualizations-with-configuration) guide. If you haven't followed that guide, please start there as this guide assumes you have the code you built there to get started.

If you don't have a visualization to follow the examples in this gude, a accompanying example visualization is available on [GitHub](https://github.com/newrelic/nru-custom-visualization-course)

Following the previous guide, you reconfigured your visualization to use the platform configurations panel removing the unneeded `SegmentedControl` component. Now that you can customize your visualization using nr1.json configuration, in the following steps, you will configure and add your custom visualization to a New Relic dashboard.

</Intro>

## Before you begin

To get started, make sure you follow the [Customize visualizations with configuration](/build-apps/customize-visualizations-with-configuration) guide. You will need to publish your Nerdpack and subscribe it to your New Relic account.

The steps to publish and subscribe your custom visualization are the same steps as publishing a New Relic application learned in the previous course section. To review the process for publishing Nerdpacks, you follow the [subscribe to the Nerdpack via the CLI](/build-apps/publish-deploy) guide.

<Callout variant="tip">

Note: To publish a Nerdpack you must be a Full user and granted the Nerdpacks “modify” privilege (which is granted by default).

Read our documentation to learn more about [Nerdpacks privileges](https://developer.newrelic.com/build-apps/permission-manage-apps/).

</Callout>

## Add your custom visualization to a dashboard

Once you've published your custom visualization to your account, in the following steps you will configure your visualization and add it to a dashboard. You can add a visualization to a new or existing dashboard within your New Relic account.

<Steps>

<Step>
To find the <strong>My Awesome Visualization</strong> that you have deployed, you need to look for your visualization in the app catalog. From the <a href="https://one.newrelic.com">New Relic One homepage</a>, select the <strong>Apps</strong> button in the top right navigation bar.<br /><br />

<img
src="../../images/build-an-app/click-apps-button.png"
alt="Final custom visualization outcome from this guide"
/><br/>

Once on the <strong>Apps</strong> page, click the <strong>Custom Visualizations</strong> launcher.<br/>

<img
src="../../images/build-an-app/click-viz-launcher.png"
alt="Final custom visualization outcome from this guide"
/><br />

<Callout variant="tip">

Note: if you don't see the <strong>Custom Visualizations</strong> tile, use the search to locate it.

</Callout>

</Step>

<Step>
In <strong>Custom Visualizations</strong>, you will see all of the visualization that have been deployed to your account and any visualizations you are serving locally.<br /><br />

Select the <strong>My Awesome Visualization</strong> to add to a dashboard and then enable it.<br/><br/>

<img
src="../../images/build-an-app/select-viz.png"
alt="Final custom visualization outcome from this guide"
/>

</Step>

<Step>

In the previous guide, you reconfigured your visualization to use the platform configurations panel. Use the configuration options to select your desired chart, select your account, insert a NRQL query, and any other configurations you desire.

As you make your selections, the visualization will update with your changes.<br/><br/>

<img
src="../../images/build-an-app/configure-viz.png"
alt="Final custom visualization outcome from this guide"
/>

</Step>

<Step>
Click <strong>Add to dashboard</strong> and then select a dashboard from the list of available dashboards, or select <strong>New dashboard</strong>.<br /><br />

<img
src="../../images/build-an-app/click-add-to-dashboard.png"
alt="Final custom visualization outcome from this guide"
/><br/>

If you decide to create a new dashboard, select the account where you want to run the dashboard, and give the dashboard a name.<br/>

<img
src="../../images/build-an-app/select-dashboard.png"
alt="Final custom visualization outcome from this guide"
/>

</Step>

<Step>
Click <strong>Add to dashboard</strong>, then click the link to your dashboard to see the custom visualization.<br/><br/>

<img
src="../../images/build-an-app/review-dashboard.png"
alt="Final custom visualization outcome from this guide"
/>

</Step>

</Steps>

## Manage your dashboard visualizations
<strong>Deleting:</strong> To remove a visualization from a dashboard, click the ellipses button in the right-hand corner of the visualization and click delete.<br /><br />

<strong>Editing:</strong> If your visualization needs some tweaking, delete the visualization, then follow the steps above to re-add the visualization, making any updates in Custom Visualizations.

## Summary

Congratulations on completing this final guide and adding your custom visualization to a New Relic dashboard. In the previous lessons, you've used the tools in the New Relic SDK to create a new custom visualization, configured the visualization using the SDK and using the platform configuration panel.

## Additional resources

- New Relic Quick Tips video: [Dashboards and Custom Visualizations](https://www.youtube.com/watch?v=_F61mxtKfGA) (6 minutes)
- New Relic NerdBytes video: [Configuring custom visualizations for dashboards](https://www.youtube.com/watch?v=sFpG_iG7Xa8) (7 minutes)
- New Relic Nerdlog live stream: [Custom Data Visualizations on New Relic](https://www.youtube.com/watch?v=HuR0EdHGz24) (30 minutes)
- New Relic One SDK components: <Link to="explore-docs/intro-to-sdk">Intro to New Relic One SDK Component library</Link>

0 comments on commit e229a65

Please sign in to comment.