diff --git a/src/data/nav.yml b/src/data/nav.yml index 351c807e7..cd76ef0eb 100644 --- a/src/data/nav.yml +++ b/src/data/nav.yml @@ -147,21 +147,21 @@ - title: See all open source apps url: https://opensource.newrelic.com/nerdpacks/ -- title: Contribute to Instant Observability +- title: Contribute to quickstarts icon: zap - url: '/contribute-to-io' + url: '/contribute-to-quickstarts' pages: - title: Build a quickstart - url: '/contribute-to-io/build-a-quickstart' + url: '/contribute-to-quickstarts/build-a-quickstart' pages: - title: Deploy your application - url: /contribute-to-io/build-a-quickstart/deploy-your-application + url: /contribute-to-quickstarts/build-a-quickstart/deploy-your-application - title: Create a dashboard - url: /contribute-to-io/build-a-quickstart/create-a-dashboard + url: /contribute-to-quickstarts/build-a-quickstart/create-a-dashboard - title: Create alerts - url: /contribute-to-io/build-a-quickstart/create-alerts + url: /contribute-to-quickstarts/build-a-quickstart/create-alerts - title: Create a quickstart - url: /contribute-to-io/build-a-quickstart/create-quickstart + url: /contribute-to-quickstarts/build-a-quickstart/create-quickstart - title: Try our APIs icon: nr-share url: '/try-our-apis' diff --git a/src/images/contribute-to-io/add-a-chart.png b/src/images/contribute-to-quickstarts/add-a-chart.png similarity index 100% rename from src/images/contribute-to-io/add-a-chart.png rename to src/images/contribute-to-quickstarts/add-a-chart.png diff --git a/src/images/contribute-to-io/add-more-alert-conditions-nrql.png b/src/images/contribute-to-quickstarts/add-more-alert-conditions-nrql.png similarity index 100% rename from src/images/contribute-to-io/add-more-alert-conditions-nrql.png rename to src/images/contribute-to-quickstarts/add-more-alert-conditions-nrql.png diff --git a/src/images/contribute-to-io/add-more-alert-conditions.png b/src/images/contribute-to-quickstarts/add-more-alert-conditions.png similarity index 100% rename from src/images/contribute-to-io/add-more-alert-conditions.png rename to src/images/contribute-to-quickstarts/add-more-alert-conditions.png diff --git a/src/images/contribute-to-io/add-more-charts.png b/src/images/contribute-to-quickstarts/add-more-charts.png similarity index 100% rename from src/images/contribute-to-io/add-more-charts.png rename to src/images/contribute-to-quickstarts/add-more-charts.png diff --git a/src/images/contribute-to-io/add-new-chart.png b/src/images/contribute-to-quickstarts/add-new-chart.png similarity index 100% rename from src/images/contribute-to-io/add-new-chart.png rename to src/images/contribute-to-quickstarts/add-new-chart.png diff --git a/src/images/contribute-to-io/add-notification-channel.png b/src/images/contribute-to-quickstarts/add-notification-channel.png similarity index 100% rename from src/images/contribute-to-io/add-notification-channel.png rename to src/images/contribute-to-quickstarts/add-notification-channel.png diff --git a/src/images/contribute-to-io/add-warning-threshold.png b/src/images/contribute-to-quickstarts/add-warning-threshold.png similarity index 100% rename from src/images/contribute-to-io/add-warning-threshold.png rename to src/images/contribute-to-quickstarts/add-warning-threshold.png diff --git a/src/images/contribute-to-io/alert-conditions.png b/src/images/contribute-to-quickstarts/alert-conditions.png similarity index 100% rename from src/images/contribute-to-io/alert-conditions.png rename to src/images/contribute-to-quickstarts/alert-conditions.png diff --git a/src/images/contribute-to-quickstarts/alert-id.png b/src/images/contribute-to-quickstarts/alert-id.png new file mode 100644 index 000000000..54e64b221 Binary files /dev/null and b/src/images/contribute-to-quickstarts/alert-id.png differ diff --git a/src/images/contribute-to-io/alerts-main.png b/src/images/contribute-to-quickstarts/alerts-main.png similarity index 100% rename from src/images/contribute-to-io/alerts-main.png rename to src/images/contribute-to-quickstarts/alerts-main.png diff --git a/src/images/contribute-to-io/average-response-time-chart.png b/src/images/contribute-to-quickstarts/average-response-time-chart.png similarity index 100% rename from src/images/contribute-to-io/average-response-time-chart.png rename to src/images/contribute-to-quickstarts/average-response-time-chart.png diff --git a/src/images/contribute-to-io/cache-hit-ratio-graphql.png b/src/images/contribute-to-quickstarts/cache-hit-ratio-graphql.png similarity index 100% rename from src/images/contribute-to-io/cache-hit-ratio-graphql.png rename to src/images/contribute-to-quickstarts/cache-hit-ratio-graphql.png diff --git a/src/images/contribute-to-io/cache-hits-chart.png b/src/images/contribute-to-quickstarts/cache-hits-chart.png similarity index 100% rename from src/images/contribute-to-io/cache-hits-chart.png rename to src/images/contribute-to-quickstarts/cache-hits-chart.png diff --git a/src/images/contribute-to-io/chart-formats.png b/src/images/contribute-to-quickstarts/chart-formats.png similarity index 100% rename from src/images/contribute-to-io/chart-formats.png rename to src/images/contribute-to-quickstarts/chart-formats.png diff --git a/src/images/contribute-to-io/chart.png b/src/images/contribute-to-quickstarts/chart.png similarity index 100% rename from src/images/contribute-to-io/chart.png rename to src/images/contribute-to-quickstarts/chart.png diff --git a/src/images/contribute-to-io/copy-flashdb-json.png b/src/images/contribute-to-quickstarts/copy-flashdb-json.png similarity index 100% rename from src/images/contribute-to-io/copy-flashdb-json.png rename to src/images/contribute-to-quickstarts/copy-flashdb-json.png diff --git a/src/images/contribute-to-io/create-alert-condition-nrql.png b/src/images/contribute-to-quickstarts/create-alert-condition-nrql.png similarity index 100% rename from src/images/contribute-to-io/create-alert-condition-nrql.png rename to src/images/contribute-to-quickstarts/create-alert-condition-nrql.png diff --git a/src/images/contribute-to-io/create-alert-condition.png b/src/images/contribute-to-quickstarts/create-alert-condition.png similarity index 100% rename from src/images/contribute-to-io/create-alert-condition.png rename to src/images/contribute-to-quickstarts/create-alert-condition.png diff --git a/src/images/contribute-to-io/create-alert-policy.png b/src/images/contribute-to-quickstarts/create-alert-policy.png similarity index 100% rename from src/images/contribute-to-io/create-alert-policy.png rename to src/images/contribute-to-quickstarts/create-alert-policy.png diff --git a/src/images/contribute-to-io/create-dashboard.png b/src/images/contribute-to-quickstarts/create-dashboard.png similarity index 100% rename from src/images/contribute-to-io/create-dashboard.png rename to src/images/contribute-to-quickstarts/create-dashboard.png diff --git a/src/images/contribute-to-io/create-pull-request.png b/src/images/contribute-to-quickstarts/create-pull-request.png similarity index 100% rename from src/images/contribute-to-io/create-pull-request.png rename to src/images/contribute-to-quickstarts/create-pull-request.png diff --git a/src/images/contribute-to-io/critical-threshold.png b/src/images/contribute-to-quickstarts/critical-threshold.png similarity index 100% rename from src/images/contribute-to-io/critical-threshold.png rename to src/images/contribute-to-quickstarts/critical-threshold.png diff --git a/src/images/contribute-to-io/database-size.png b/src/images/contribute-to-quickstarts/database-size.png similarity index 100% rename from src/images/contribute-to-io/database-size.png rename to src/images/contribute-to-quickstarts/database-size.png diff --git a/src/images/contribute-to-io/email-notification-channel.png b/src/images/contribute-to-quickstarts/email-notification-channel.png similarity index 100% rename from src/images/contribute-to-io/email-notification-channel.png rename to src/images/contribute-to-quickstarts/email-notification-channel.png diff --git a/src/images/contribute-to-io/errors-chart.png b/src/images/contribute-to-quickstarts/errors-chart.png similarity index 100% rename from src/images/contribute-to-io/errors-chart.png rename to src/images/contribute-to-quickstarts/errors-chart.png diff --git a/src/images/contribute-to-io/fdb-methods.png b/src/images/contribute-to-quickstarts/fdb-methods.png similarity index 100% rename from src/images/contribute-to-io/fdb-methods.png rename to src/images/contribute-to-quickstarts/fdb-methods.png diff --git a/src/images/contribute-to-io/final-flashdb-dashboard.png b/src/images/contribute-to-quickstarts/final-flashdb-dashboard.png similarity index 100% rename from src/images/contribute-to-io/final-flashdb-dashboard.png rename to src/images/contribute-to-quickstarts/final-flashdb-dashboard.png diff --git a/src/images/contribute-to-io/final-flashdb-quickstart.png b/src/images/contribute-to-quickstarts/final-flashdb-quickstart.png similarity index 100% rename from src/images/contribute-to-io/final-flashdb-quickstart.png rename to src/images/contribute-to-quickstarts/final-flashdb-quickstart.png diff --git a/src/images/contribute-to-io/flashdb-alert-slow-response.png b/src/images/contribute-to-quickstarts/flashdb-alert-slow-response.png similarity index 100% rename from src/images/contribute-to-io/flashdb-alert-slow-response.png rename to src/images/contribute-to-quickstarts/flashdb-alert-slow-response.png diff --git a/src/images/contribute-to-io/flashdb-dashboard-directory.png b/src/images/contribute-to-quickstarts/flashdb-dashboard-directory.png similarity index 100% rename from src/images/contribute-to-io/flashdb-dashboard-directory.png rename to src/images/contribute-to-quickstarts/flashdb-dashboard-directory.png diff --git a/src/images/contribute-to-io/flashdb-dashboard.png b/src/images/contribute-to-quickstarts/flashdb-dashboard.png similarity index 100% rename from src/images/contribute-to-io/flashdb-dashboard.png rename to src/images/contribute-to-quickstarts/flashdb-dashboard.png diff --git a/src/images/contribute-to-io/flashdb-directory.png b/src/images/contribute-to-quickstarts/flashdb-directory.png similarity index 100% rename from src/images/contribute-to-io/flashdb-directory.png rename to src/images/contribute-to-quickstarts/flashdb-directory.png diff --git a/src/images/contribute-to-io/flashdb-quickstart-dashboard-directory.png b/src/images/contribute-to-quickstarts/flashdb-quickstart-dashboard-directory.png similarity index 100% rename from src/images/contribute-to-io/flashdb-quickstart-dashboard-directory.png rename to src/images/contribute-to-quickstarts/flashdb-quickstart-dashboard-directory.png diff --git a/src/images/contribute-to-io/flashdb-quickstart-template.png b/src/images/contribute-to-quickstarts/flashdb-quickstart-template.png similarity index 100% rename from src/images/contribute-to-io/flashdb-quickstart-template.png rename to src/images/contribute-to-quickstarts/flashdb-quickstart-template.png diff --git a/src/images/contribute-to-io/fork-github-quickstart.png b/src/images/contribute-to-quickstarts/fork-github-quickstart.png similarity index 100% rename from src/images/contribute-to-io/fork-github-quickstart.png rename to src/images/contribute-to-quickstarts/fork-github-quickstart.png diff --git a/src/images/contribute-to-io/graphiql.png b/src/images/contribute-to-quickstarts/graphiql.png similarity index 100% rename from src/images/contribute-to-io/graphiql.png rename to src/images/contribute-to-quickstarts/graphiql.png diff --git a/src/images/contribute-to-io/keys-chart.png b/src/images/contribute-to-quickstarts/keys-chart.png similarity index 100% rename from src/images/contribute-to-io/keys-chart.png rename to src/images/contribute-to-quickstarts/keys-chart.png diff --git a/src/images/contribute-to-io/lab-narrative.png b/src/images/contribute-to-quickstarts/lab-narrative.png similarity index 100% rename from src/images/contribute-to-io/lab-narrative.png rename to src/images/contribute-to-quickstarts/lab-narrative.png diff --git a/src/images/contribute-to-io/latest-database-size.png b/src/images/contribute-to-quickstarts/latest-database-size.png similarity index 100% rename from src/images/contribute-to-io/latest-database-size.png rename to src/images/contribute-to-quickstarts/latest-database-size.png diff --git a/src/images/contribute-to-io/low-cache-hit-ratio-nrql.png b/src/images/contribute-to-quickstarts/low-cache-hit-ratio-nrql.png similarity index 100% rename from src/images/contribute-to-io/low-cache-hit-ratio-nrql.png rename to src/images/contribute-to-quickstarts/low-cache-hit-ratio-nrql.png diff --git a/src/images/contribute-to-io/low-cache-hit-ratio-threshold.png b/src/images/contribute-to-quickstarts/low-cache-hit-ratio-threshold.png similarity index 100% rename from src/images/contribute-to-io/low-cache-hit-ratio-threshold.png rename to src/images/contribute-to-quickstarts/low-cache-hit-ratio-threshold.png diff --git a/src/images/contribute-to-io/modify-importer-script.png b/src/images/contribute-to-quickstarts/modify-importer-script.png similarity index 100% rename from src/images/contribute-to-io/modify-importer-script.png rename to src/images/contribute-to-quickstarts/modify-importer-script.png diff --git a/src/images/contribute-to-io/more-charts.png b/src/images/contribute-to-quickstarts/more-charts.png similarity index 100% rename from src/images/contribute-to-io/more-charts.png rename to src/images/contribute-to-quickstarts/more-charts.png diff --git a/src/images/contribute-to-io/name-dashboard.png b/src/images/contribute-to-quickstarts/name-dashboard.png similarity index 100% rename from src/images/contribute-to-io/name-dashboard.png rename to src/images/contribute-to-quickstarts/name-dashboard.png diff --git a/src/images/contribute-to-io/newrelic-homepage.png b/src/images/contribute-to-quickstarts/newrelic-homepage.png similarity index 100% rename from src/images/contribute-to-io/newrelic-homepage.png rename to src/images/contribute-to-quickstarts/newrelic-homepage.png diff --git a/src/images/contribute-to-quickstarts/newrelic-io.png b/src/images/contribute-to-quickstarts/newrelic-io.png new file mode 100644 index 000000000..6086e2793 Binary files /dev/null and b/src/images/contribute-to-quickstarts/newrelic-io.png differ diff --git a/src/images/contribute-to-io/piechart-dashboard.png b/src/images/contribute-to-quickstarts/piechart-dashboard.png similarity index 100% rename from src/images/contribute-to-io/piechart-dashboard.png rename to src/images/contribute-to-quickstarts/piechart-dashboard.png diff --git a/src/images/contribute-to-io/piechart.png b/src/images/contribute-to-quickstarts/piechart.png similarity index 100% rename from src/images/contribute-to-io/piechart.png rename to src/images/contribute-to-quickstarts/piechart.png diff --git a/src/images/contribute-to-io/pull-request.png b/src/images/contribute-to-quickstarts/pull-request.png similarity index 100% rename from src/images/contribute-to-io/pull-request.png rename to src/images/contribute-to-quickstarts/pull-request.png diff --git a/src/images/contribute-to-io/quickstart-description.png b/src/images/contribute-to-quickstarts/quickstart-description.png similarity index 100% rename from src/images/contribute-to-io/quickstart-description.png rename to src/images/contribute-to-quickstarts/quickstart-description.png diff --git a/src/images/contribute-to-io/quickstart-template-directory.png b/src/images/contribute-to-quickstarts/quickstart-template-directory.png similarity index 100% rename from src/images/contribute-to-io/quickstart-template-directory.png rename to src/images/contribute-to-quickstarts/quickstart-template-directory.png diff --git a/src/images/contribute-to-io/slow-read-response-graphql.png b/src/images/contribute-to-quickstarts/slow-read-response-graphql.png similarity index 100% rename from src/images/contribute-to-io/slow-read-response-graphql.png rename to src/images/contribute-to-quickstarts/slow-read-response-graphql.png diff --git a/src/images/contribute-to-io/slow-read-response-nrql.png b/src/images/contribute-to-quickstarts/slow-read-response-nrql.png similarity index 100% rename from src/images/contribute-to-io/slow-read-response-nrql.png rename to src/images/contribute-to-quickstarts/slow-read-response-nrql.png diff --git a/src/images/contribute-to-io/terminal-output.png b/src/images/contribute-to-quickstarts/terminal-output.png similarity index 100% rename from src/images/contribute-to-io/terminal-output.png rename to src/images/contribute-to-quickstarts/terminal-output.png diff --git a/src/images/contribute-to-io/update-policy.png b/src/images/contribute-to-quickstarts/update-policy.png similarity index 100% rename from src/images/contribute-to-io/update-policy.png rename to src/images/contribute-to-quickstarts/update-policy.png diff --git a/src/images/contribute-to-io/warning-threshold.png b/src/images/contribute-to-quickstarts/warning-threshold.png similarity index 100% rename from src/images/contribute-to-io/warning-threshold.png rename to src/images/contribute-to-quickstarts/warning-threshold.png diff --git a/src/markdown-pages/contribute-to-io/build-a-quickstart/create-a-dashboard.mdx b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-a-dashboard.mdx similarity index 69% rename from src/markdown-pages/contribute-to-io/build-a-quickstart/create-a-dashboard.mdx rename to src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-a-dashboard.mdx index 2bca743b8..5d0b2a85a 100644 --- a/src/markdown-pages/contribute-to-io/build-a-quickstart/create-a-dashboard.mdx +++ b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-a-dashboard.mdx @@ -1,5 +1,5 @@ --- -path: '/contribute-to-io/build-a-quickstart/create-a-dashboard' +path: '/contribute-to-quickstarts/build-a-quickstart/create-a-dashboard' title: 'Create a dashboard' template: 'GuideTemplate' description: 'create a dashboard to observe your data in New Relic' @@ -8,9 +8,9 @@ duration: '15 min' -This procedure is a part of lab that teaches you how to build a quickstart. If you haven't already, checkout the [_lab introduction_](/contribute-to-io/build-a-quickstart) +This procedure is a part of lab that teaches you how to build a quickstart. If you haven't already, checkout the [_lab introduction_](/contribute-to-quickstarts/build-a-quickstart) -Each procedure in this lab builds on top of the last one, so make sure you [_Deploy your application_](/contribute-to-io/build-a-quickstart/deploy-your-application) before proceeding with this one. +Each procedure in this lab builds on top of the last one, so make sure you [_Deploy your application_](/contribute-to-quickstarts/build-a-quickstart/deploy-your-application) before proceeding with this one. @@ -22,15 +22,15 @@ In this procedure, you create a dashboard in New Relic. Navigate to [New Relic](https://one.newrelic.com/) and sign in with your account. Here, you see different tabs such as **Browse Data**, **Dashboards**, **Alerts & AI**. -![New Relic UI](../../../images/contribute-to-io/newrelic-homepage.png) +![New Relic UI](../../../images/contribute-to-quickstarts/newrelic-homepage.png) Move to **Dashboards** and click **Create a dashboard** in the top right corner. -![create a dashboard](../../../images/contribute-to-io/create-dashboard.png) +![create a dashboard](../../../images/contribute-to-quickstarts/create-dashboard.png) Name your dashboard "FlashDB" and click create. -![name your dashboard](../../../images/contribute-to-io/name-dashboard.png) +![name your dashboard](../../../images/contribute-to-quickstarts/name-dashboard.png) ## Add charts to your dashboard @@ -46,11 +46,11 @@ Once the dashboard is in place, you can start creating charts. You're going to a Hover over the dashboard and click **Add a new chart**. -![add a new chart](../../../images/contribute-to-io/add-new-chart.png) +![add a new chart](../../../images/contribute-to-quickstarts/add-new-chart.png) From this screen, you add charts using our query builder, or you choose to add text, images, or links using Markdown. Click **Add a chart**. -![add a chart](../../../images/contribute-to-io/add-a-chart.png) +![add a chart](../../../images/contribute-to-quickstarts/add-a-chart.png) It may open the query builder option. Switch to the NRQL editor and edit the query as follows: @@ -58,25 +58,25 @@ It may open the query builder option. Switch to the NRQL editor and edit the que SELECT count(*) FROM fdb_method FACET method ``` -![database methods chart](../../../images/contribute-to-io/fdb-methods.png) +![database methods chart](../../../images/contribute-to-quickstarts/fdb-methods.png) Click **Run** to see above results. Here, you see the count of each FlashDB query, grouped by method. You can choose to present your results in different formats such as table, billboard, or pie chart. -![chart formats](../../../images/contribute-to-io/chart-formats.png) +![chart formats](../../../images/contribute-to-quickstarts/chart-formats.png) Change the chart type to pie, name your chart "Database methods", and click save. -![pie chart](../../../images/contribute-to-io/piechart.png) +![pie chart](../../../images/contribute-to-quickstarts/piechart.png) The chart is now visible on your dashboard. -![piechart dashboard](../../../images/contribute-to-io/piechart-dashboard.png) +![piechart dashboard](../../../images/contribute-to-quickstarts/piechart-dashboard.png) You can add more charts to your dashboard following the same pattern. To do so, click **+** in upper right hand corner. -![add more charts](../../../images/contribute-to-io/add-more-charts.png) +![add more charts](../../../images/contribute-to-quickstarts/add-more-charts.png) This takes you to the same **Add to your dashboard** page. Add another chart to your dashboard. @@ -87,7 +87,7 @@ Run the following query to observe the average response time of FlashDB queries. SELECT average(fdb_create_responses), average(fdb_read_responses), average(fdb_update_responses), average(fdb_delete_responses) FROM Metric TIMESERIES ``` -![average response time chart](../../../images/contribute-to-io/average-response-time-chart.png ) +![average response time chart](../../../images/contribute-to-quickstarts/average-response-time-chart.png ) Here, you observe the average response time for different FlashDB queries. Click **Save** to add this chart to your dashboard. Follow the same procedure to add the rest of the charts. @@ -101,7 +101,7 @@ SELECT sum(fdb_create_errors), sum(fdb_read_errors), sum(fdb_update_errors), sum Here, you observe errors for all database queries. -![errors chart](../../../images/contribute-to-io/errors-chart.png ) +![errors chart](../../../images/contribute-to-quickstarts/errors-chart.png ) ### Database size @@ -111,7 +111,7 @@ Use the following query to get Database size chart. SELECT latest(fdb_size) FROM Metric ``` -![database size chart](../../../images/contribute-to-io/latest-database-size.png ) +![database size chart](../../../images/contribute-to-quickstarts/latest-database-size.png ) This chart shows you the database size. @@ -123,7 +123,7 @@ For the Cache hits chart, use the following query: SELECT sum(fdb_cache_hits) FROM Metric TIMESERIES ``` -![cache hits chart](../../../images/contribute-to-io/cache-hits-chart.png ) +![cache hits chart](../../../images/contribute-to-quickstarts/cache-hits-chart.png ) Here, you observe the total number of cache hits using a line chart. @@ -135,13 +135,13 @@ Use the following query to count the number of keys in your database. SELECT count(fdb_keys) FROM Metric TIMESERIES ``` -![keys chart](../../../images/contribute-to-io/keys-chart.png ) +![keys chart](../../../images/contribute-to-quickstarts/keys-chart.png ) Here, you observe the FlashDB key count. Your final dashboard will look similar to the following: -![dashboard with charts](../../../images/contribute-to-io/final-flashdb-dashboard.png ) +![dashboard with charts](../../../images/contribute-to-quickstarts/final-flashdb-dashboard.png ) ## Summary @@ -149,6 +149,6 @@ In this procedure, you created a dashboard and added multiple charts to it to ob -This procedure is a part of lab that teaches you how to build a quickstart. Continue on to next procedure: [_Create alerts_](/contribute-to-io/build-a-quickstart/create-alerts). +This procedure is a part of lab that teaches you how to build a quickstart. Continue on to next procedure: [_Create alerts_](/contribute-to-quickstarts/build-a-quickstart/create-alerts). \ No newline at end of file diff --git a/src/markdown-pages/contribute-to-io/build-a-quickstart/create-a-quickstart.mdx b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-a-quickstart.mdx similarity index 88% rename from src/markdown-pages/contribute-to-io/build-a-quickstart/create-a-quickstart.mdx rename to src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-a-quickstart.mdx index 85f9670fc..1dc405cab 100644 --- a/src/markdown-pages/contribute-to-io/build-a-quickstart/create-a-quickstart.mdx +++ b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-a-quickstart.mdx @@ -1,5 +1,5 @@ --- -path: '/contribute-to-io/build-a-quickstart/create-quickstart' +path: '/contribute-to-quickstarts/build-a-quickstart/create-quickstart' title: 'Create a quickstart' template: 'GuideTemplate' description: 'Package up your dashboards and alerts and create a quickstart' @@ -8,9 +8,9 @@ duration: '30 min' -This procedure is a part of lab that teaches you how to build quickstart. If you haven't already, checkout the [_lab introduction_](/contribute-to-io/build-a-quickstart) +This procedure is a part of lab that teaches you how to build quickstart. If you haven't already, checkout the [_lab introduction_](/contribute-to-quickstarts/build-a-quickstart) -As this procedure builds on top of the last ones in the lab, make sure you create a [dashboard](contribute-to-io/build-a-quickstart/create-a-dashboard) and [alerts](/contribute-to-io/build-a-quickstart/create-alerts) before proceeding with this one. +As this procedure builds on top of the last ones in the lab, make sure you create a [dashboard](contribute-to-quickstarts/build-a-quickstart/create-a-dashboard) and [alerts](/contribute-to-quickstarts/build-a-quickstart/create-alerts) before proceeding with this one. @@ -19,19 +19,19 @@ You've already created a useful dashboard and alert policy for your database. No To get started, navigate to GitHub repository of [New Relic One quickstarts](https://github.com/newrelic/newrelic-observability-packs) and fork it. -![fork github quickstart repo](../../../images/contribute-to-io/fork-github-quickstart.png) +![fork github quickstart repo](../../../images/contribute-to-quickstarts/fork-github-quickstart.png) Now, clone your own repository to your local machine using `git clone` and open it in the IDE of your choice. Notice the directory structure. The __template_ folder is of special importance since it contains the templates for observability building blocks in the quickstart. -![quickstart template](../../../images/contribute-to-io/quickstart-template-directory.png) +![quickstart template](../../../images/contribute-to-quickstarts/quickstart-template-directory.png) The _\_template_ directory contains the folders for dashboards and alerts. Each of these folders contain templates that you can use to create entities for your quickstart. Copy the _\_template_ directory and it's content to a new directory within the _quickstarts_ folder. Name the directory as _flashdb_. -![flashdb quickstart directory](../../../images/contribute-to-io/flashdb-quickstart-template.png) +![flashdb quickstart directory](../../../images/contribute-to-quickstarts/flashdb-quickstart-template.png) ## Add your dashboard to the quickstart @@ -39,7 +39,7 @@ In a previous procedure, you created a dashboard for monitoring FlashDB. Now, yo First, look up your dashboard in New Relic and copy its JSON. Then, save it as a JSON file in the _dashboards_ directory. -![copy flashdb dashboard](../../../images/contribute-to-io/copy-flashdb-json.png) +![copy flashdb dashboard](../../../images/contribute-to-quickstarts/copy-flashdb-json.png) Here, you copied your dashboard's JSON to clipboard. Replace the content of existing JSON file in _dashboards_ directory and rename it as _flashDB.json_. Your _flashDB.json_ file should contain the following content: @@ -217,7 +217,7 @@ Here, you copied your dashboard's JSON to clipboard. Replace the content of exis Next, create a screenshot of your dashboard and add it to _dashboards_ directory. Give it the same name as your JSON file. Your _dashboard_ directory should look similar to the following: -![FlashDB dashboard](../../../images/contribute-to-io/flashdb-quickstart-dashboard-directory.png) +![FlashDB dashboard](../../../images/contribute-to-quickstarts/flashdb-quickstart-dashboard-directory.png) ## Add your alerts to the quickstart @@ -232,7 +232,7 @@ Nerdgraph is New Relic's GraphQL API. Open the Nerdgraph explorer and select your key from the dropdown menu. -![graphiql interface](../../../images/contribute-to-io/graphiql.png) +![graphiql interface](../../../images/contribute-to-quickstarts/graphiql.png) Building a query is simple in the explorer. Check the appropriate boxes to build a GraphQL query: @@ -263,42 +263,47 @@ Building a query is simple in the explorer. Check the appropriate boxes to build } ``` + + +Under your alert policy, click on the condition to get its ID. + +![find alert id](../../../images/contribute-to-quickstarts/alert-id.png) + + + Running the above query in Graphql will respond with the details of your alert condition that you can use to update your quickstart. -![cache hit ratio in graphql](../../../images/contribute-to-io/cache-hit-ratio-graphql.png) +![slow read response graphql](../../../images/contribute-to-quickstarts/slow-read-response-graphql.png) For static condition, take the static-alert.yml file and start populating it using the information returned from above query. -First, name the file as **Cache Hit Ratio.yml** and populate it: +First, name the file as _read-response.yml_ and populate it: ```yml --- # Name of the alert -name: low cache hit ratio +name: slow read response # Description and details details: |+ - This alert is triggered whenever the cache hit ratio for database is < 0.85. - The cache hit ratio can be measured simply by: # of cache hits/ # of total read responses. - It represents the proportion of block requests satisfied by the cache without requiring a disk read. - A low cache hit score means that the database is inefficient. + This alert is triggered when read operation takes > 0.85. # Type of alert type: STATIC # NRQL query nrql: - query: "SELECT sum(fdb_cache_hits)/sum(fdb_read_responses) FROM Metric" + query: "SELECT average(fdb_read_responses) FROM Metric" -# Function used to aggregate the NRQL query value(s) for comparison to the terms.threshold +# Function used to aggregate the NRQL query value(s) for comparison to the terms.threshold (Default: SINGLE_VALUE) valueFunction: SINGLE_VALUE # List of Critical and Warning thresholds for the condition terms: - priority: CRITICAL # Operator used to compare against the threshold. - operator: BELOW + operator: ABOVE # Value that triggers a violation - threshold: 0.75 + threshold: 0.85 # Time in seconds; 120 - 3600 thresholdDuration: 300 # How many data points must be in violation for the duration @@ -306,50 +311,52 @@ terms: # Adding a Warning threshold is optional - priority: WARNING - operator: BELOW - threshold: 0.85 - thresholdDuration: 300 - thresholdOccurrences: ALL + operator: ABOVE + threshold: 0.75 + thresholdDuration: 300 + thresholdOccurrences: ALL # Duration after which a violation automatically closes # Time in seconds; 300 - 2592000 (Default: 86400 [1 day]) violationTimeLimitSeconds: 259200 -___ ``` -Here, you added the pre-existing low cache hit ratio alert to the quickstart. Follow the same procedure to add the slow read response alert. +Here, you added the pre-existing slow read response alert to the quickstart. Follow the same procedure to add the low cache hit ratio alert. For your reference, here's the graphql response. -![slow read response graphql](../../../images/contribute-to-io/slow-read-response-graphql.png) +![cache hit ratio in graphql](../../../images/contribute-to-quickstarts/cache-hit-ratio-graphql.png) -Create your **Read response.yml** file based on the above response. +Create your _cache-hit-ratio.yml_ file based on the above response. ```yml --- # Name of the alert -name: slow read response +name: low cache hit ratio # Description and details details: |+ - This alert is triggered when read operation takes > 0.85. + This alert is triggered whenever the cache hit ratio for database is < 0.85. + The cache hit ratio can be measured simply by: # of cache hits/ # of total read responses. + It represents the proportion of block requests satisfied by the cache without requiring a disk read. + A low cache hit score means that the database is inefficient. # Type of alert type: STATIC # NRQL query nrql: - query: "SELECT average(fdb_read_responses) FROM Metric" + query: "SELECT sum(fdb_cache_hits)/sum(fdb_read_responses) FROM Metric" -# Function used to aggregate the NRQL query value(s) for comparison to the terms.threshold (Default: SINGLE_VALUE) +# Function used to aggregate the NRQL query value(s) for comparison to the terms.threshold valueFunction: SINGLE_VALUE # List of Critical and Warning thresholds for the condition terms: - priority: CRITICAL # Operator used to compare against the threshold. - operator: ABOVE + operator: BELOW # Value that triggers a violation - threshold: 0.85 + threshold: 0.75 # Time in seconds; 120 - 3600 thresholdDuration: 300 # How many data points must be in violation for the duration @@ -357,14 +364,15 @@ terms: # Adding a Warning threshold is optional - priority: WARNING - operator: ABOVE - threshold: 0.75 - thresholdDuration: 300 - thresholdOccurrences: ALL + operator: BELOW + threshold: 0.85 + thresholdDuration: 300 + thresholdOccurrences: ALL # Duration after which a violation automatically closes # Time in seconds; 300 - 2592000 (Default: 86400 [1 day]) violationTimeLimitSeconds: 259200 + ``` ## Add a description @@ -423,7 +431,7 @@ references: ``` Here's how your final _flashdb_ quickstart folder should look like. -![flashdb quickstart directory](../../../images/contribute-to-io/final-flashdb-quickstart.png) +![flashdb quickstart directory](../../../images/contribute-to-quickstarts/final-flashdb-quickstart.png) ## Contribute quickstart to GitHub @@ -444,12 +452,13 @@ To help us manage your contributions efficiently, we encourage you to label your Push your changes to GitHub: ```bash - git push +git tag lab +git push ``` Once you've pushed your changes to GitHub, you can [create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). -![pull request](../../../images/contribute-to-io/create-pull-request.png) +![pull request](../../../images/contribute-to-quickstarts/create-pull-request.png) Submit and wait for the review. Thanks a lot for your submission! diff --git a/src/markdown-pages/contribute-to-io/build-a-quickstart/create-alerts.mdx b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-alerts.mdx similarity index 70% rename from src/markdown-pages/contribute-to-io/build-a-quickstart/create-alerts.mdx rename to src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-alerts.mdx index fa60e27f7..bbcab4a9e 100644 --- a/src/markdown-pages/contribute-to-io/build-a-quickstart/create-alerts.mdx +++ b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/create-alerts.mdx @@ -1,5 +1,5 @@ --- -path: '/contribute-to-io/build-a-quickstart/create-alerts' +path: '/contribute-to-quickstarts/build-a-quickstart/create-alerts' title: 'Create alerts' template: 'GuideTemplate' description: 'create alerts in New Relic One' @@ -8,9 +8,9 @@ duration: '15 min' -This procedure is a part of a lab that teaches you how to build a quickstart. If you haven't already, checkout the [_lab introduction_](/contribute-to-io/build-a-quickstart) +This procedure is a part of a lab that teaches you how to build a quickstart. If you haven't already, checkout the [_lab introduction_](/contribute-to-quickstarts/build-a-quickstart) -Each procedure in this lab builds on top of the last one, so make sure you [_Create a dashboard_](/contribute-to-io/build-a-quickstart/create-a-dashboard) before proceeding with this one. +Each procedure in this lab builds on top of the last one, so make sure you [_Create a dashboard_](/contribute-to-quickstarts/build-a-quickstart/create-a-dashboard) before proceeding with this one. @@ -28,11 +28,11 @@ Before you set alert conditions, you must create a policy. From **Alert & AI**, go to the **Alerts** section and click **Policies** from left-hand navigation. Then, click **New alert policy**. -![new alert policy](../../../images/contribute-to-io/alerts-main.png) +![new alert policy](../../../images/contribute-to-quickstarts/alerts-main.png) Name your policy FlashDB alert policy. Use the default values for the rest of the fields and click **Create alert policy**. -![create an alert policy](../../../images/contribute-to-io/create-alert-policy.png) +![create an alert policy](../../../images/contribute-to-quickstarts/create-alert-policy.png) The next step is to add conditions to the alert policy. @@ -46,11 +46,11 @@ You're going to add the following alert conditions: Under **FlashDB alert policy**, click **Create a condition**. -![create alert condition](../../../images/contribute-to-io/create-alert-condition.png) +![create alert condition](../../../images/contribute-to-quickstarts/create-alert-condition.png) The next page asks you to choose a category for your condition. Choose NRQL, which allows you to create a condition using a NRQL query. Then, click **Next, define thresholds**. -![alert condition using nrql](../../../images/contribute-to-io/create-alert-condition-nrql.png) +![alert condition using nrql](../../../images/contribute-to-quickstarts/create-alert-condition-nrql.png) You want New Relic to notify you if the read operation is taking longer than expected. Name your alert condition "slow read responses" and enter the following NRQL query for your condition. @@ -58,39 +58,39 @@ You want New Relic to notify you if the read operation is taking longer than exp SELECT average(fdb_read_responses) FROM Metric ``` -![slow read response nrql](../../../images/contribute-to-io/slow-read-response-nrql.png) +![slow read response nrql](../../../images/contribute-to-quickstarts/slow-read-response-nrql.png) Here, you selected the average read response for FlashDB. Scroll down on the same page to define threshold. Select **Static** as the threshold type. It is the simplest threshold type and creates a condition based on the numeric value returned by the query. Set the critical threshold value at 0.9: -![slow read response critical threshold](../../../images/contribute-to-io/critical-threshold.png) +![slow read response critical threshold](../../../images/contribute-to-quickstarts/critical-threshold.png) Here, you defined a condition that will open violation whenever read response time is above 0.9 for at least 5 minutes. Next, click **Add warning threshold**. -![add warning threshold](../../../images/contribute-to-io/add-warning-threshold.png) +![add warning threshold](../../../images/contribute-to-quickstarts/add-warning-threshold.png) Enter the threshold value at 0.8 to get a warning when the read response is above 0.8 for at least 5 minutes. Then, click **Save condition**. -![slow read response warning threshold](../../../images/contribute-to-io/warning-threshold.png) +![slow read response warning threshold](../../../images/contribute-to-quickstarts/warning-threshold.png) Now, You can see your new condition under your FlashDB alert policy. -![flashdb slow response alert](../../../images/contribute-to-io/flashdb-alert-slow-response.png) +![flashdb slow response alert](../../../images/contribute-to-quickstarts/flashdb-alert-slow-response.png) ### Create a cache hit ratio condition You claimed that your database is fastest in the space, so you also want New Relic to notify you if your cache hit ratio is too low. Add another condition under the same policy by clicking **Add a condition**. -![add more alert conditions](../../../images/contribute-to-io/add-more-alert-conditions.png) +![add more alert conditions](../../../images/contribute-to-quickstarts/add-more-alert-conditions.png) The next page asks you to choose the category for your condition. Choose NRQL and click **Next, define threshold**. -![add alert condition using nrql](../../../images/contribute-to-io/add-more-alert-conditions-nrql.png) +![add alert condition using nrql](../../../images/contribute-to-quickstarts/add-more-alert-conditions-nrql.png) Enter the name "Low cache hit ratio" for your condition and use the following NRQL query. @@ -98,15 +98,15 @@ Enter the name "Low cache hit ratio" for your condition and use the following NR SELECT sum(fdb_cache_hits)/sum(fdb_read_responses) FROM Metric ``` -![low cache hit ratio nrql](../../../images/contribute-to-io/low-cache-hit-ratio-nrql.png) +![low cache hit ratio nrql](../../../images/contribute-to-quickstarts/low-cache-hit-ratio-nrql.png) Next, add threshold values for critical violation and warning. The procedure is same as before. The only difference is that you want New Relic to notify you if the query returns a value _below_ 0.85 and open a critical violation if the value falls _below_ 0.75 for at least 5 minutes. -![low cache hit ratio threshold](../../../images/contribute-to-io/low-cache-hit-ratio-threshold.png) +![low cache hit ratio threshold](../../../images/contribute-to-quickstarts/low-cache-hit-ratio-threshold.png) Save the condition to add it to your alert policy which now looks like the following. -![alert policy conditions](../../../images/contribute-to-io/alert-conditions.png) +![alert policy conditions](../../../images/contribute-to-quickstarts/alert-conditions.png) ## Add a notification channel @@ -114,15 +114,17 @@ To receive notifications for any opened violations, you also need to add a notif First, move to the **Notification channels** tab and click **Add notification channels**. -![add notification channel](../../../images/contribute-to-io/add-notification-channel.png) +![add notification channel](../../../images/contribute-to-quickstarts/add-notification-channel.png) From the list of channel options, click Email. -![email notification channel](../../../images/contribute-to-io/email-notification-channel.png) +![email notification channel](../../../images/contribute-to-quickstarts/email-notification-channel.png) Select the email you want to receive your notifications on, and click **Update policy**. -![update policy](../../../images/contribute-to-io/update-policy.png) +![update policy](../../../images/contribute-to-quickstarts/update-policy.png) + +Notification channel is now added. ## Summary @@ -130,6 +132,6 @@ During this procedure, you created FlashDB alert policy and added slow read resp -This procedure is a part of lab that teaches you how to build a quickstart. Continue on to next lesson: [_Create a quickstart_](/contribute-to-io/build-a-quickstart/create-quickstart) +This procedure is a part of lab that teaches you how to build a quickstart. Continue on to next lesson: [_Create a quickstart_](/contribute-to-quickstarts/build-a-quickstart/create-quickstart) \ No newline at end of file diff --git a/src/markdown-pages/contribute-to-io/build-a-quickstart/deploy-your-application.mdx b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/deploy-your-application.mdx similarity index 93% rename from src/markdown-pages/contribute-to-io/build-a-quickstart/deploy-your-application.mdx rename to src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/deploy-your-application.mdx index c02a5b2ec..b884ffe0c 100644 --- a/src/markdown-pages/contribute-to-io/build-a-quickstart/deploy-your-application.mdx +++ b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/deploy-your-application.mdx @@ -1,5 +1,5 @@ --- -path: '/contribute-to-io/build-a-quickstart/deploy-your-application' +path: '/contribute-to-quickstarts/build-a-quickstart/deploy-your-application' title: 'Deploy your application' template: 'GuideTemplate' description: 'Spin up your demo services to follow along the lab' @@ -8,7 +8,7 @@ duration: '5 min' -This procedure is a part of lab that teaches you how to build a quickstart. If you haven't already, check out the [_lab introduction_](/contribute-to-io/build-a-quickstart). +This procedure is a part of lab that teaches you how to build a quickstart. If you haven't already, check out the [_lab introduction_](/contribute-to-quickstarts/build-a-quickstart). @@ -70,6 +70,6 @@ Next, you observe this data in New Relic using dashboard. -This procedure is a part of lab that teaches you how to build a quickstart. Continue on to next lesson: [_Create a dashboard_](/contribute-to-io/build-a-quickstart/create-a-dashboard). +This procedure is a part of lab that teaches you how to build a quickstart. Continue on to next lesson: [_Create a dashboard_](/contribute-to-quickstarts/build-a-quickstart/create-a-dashboard). diff --git a/src/markdown-pages/contribute-to-io/build-a-quickstart/index.mdx b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/index.mdx similarity index 90% rename from src/markdown-pages/contribute-to-io/build-a-quickstart/index.mdx rename to src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/index.mdx index 1ac3f985c..eb3a66cd4 100644 --- a/src/markdown-pages/contribute-to-io/build-a-quickstart/index.mdx +++ b/src/markdown-pages/contribute-to-quickstarts/build-a-quickstart/index.mdx @@ -1,5 +1,5 @@ --- -path: '/contribute-to-io/build-a-quickstart' +path: '/contribute-to-quickstarts/build-a-quickstart' title: 'Build a quickstart' template: 'GuideTemplate' description: 'Quickstarts gives you a jump start in your observability journey with New Relic. You can use them to quickly and easily observe and monitor your services' @@ -7,7 +7,7 @@ description: 'Quickstarts gives you a jump start in your observability journey w You’ve developed a new database called FlashDB, the lightest and fastest database in the space. Your database is already very popular among the developers. Now, you want to help users of FlashDB to quickly and easily observe it in New Relic. -![build a quickstart](../../../images/contribute-to-io/lab-narrative.png) +![build a quickstart](../../../images/contribute-to-quickstarts/lab-narrative.png) To achieve your goal, contribute a quickstart to New Relic I/O so other users can quickly monitor FlashDB. @@ -43,7 +43,7 @@ Before you begin: -This procedure is a part of lab that teaches you how to build a quickstart. Continue on to first lesson: [_Deploy your application_](/contribute-to-io/build-a-quickstart/deploy-your-application) +This procedure is a part of lab that teaches you how to build a quickstart. Continue on to first lesson: [_Deploy your application_](/contribute-to-quickstarts/build-a-quickstart/deploy-your-application) diff --git a/src/markdown-pages/contribute-to-io/index.mdx b/src/markdown-pages/contribute-to-quickstarts/index.mdx similarity index 73% rename from src/markdown-pages/contribute-to-io/index.mdx rename to src/markdown-pages/contribute-to-quickstarts/index.mdx index 7eb3b6a95..3aac5a7c8 100644 --- a/src/markdown-pages/contribute-to-io/index.mdx +++ b/src/markdown-pages/contribute-to-quickstarts/index.mdx @@ -1,17 +1,18 @@ --- -path: '/contribute-to-io' -title: 'Instant observability' +path: '/contribute-to-quickstarts' +title: 'Quickstarts' template: 'OverviewTemplate' description: '' --- -New Relic have been providing different solutions for you to kick start your observability journey. +New Relic provides different solutions for you to kick start your observability journey. But wouldn't it be cool if you wouldn't have to manually set up the observability building block? Instead you could just click, install and get value from your data. New Relic I/O equips you with integrations, dashboards, and other observability building blocks to get value from your data faster. We have a growing number of quickstarts that you can use for instant observability. Didn't find what you're looking for? You're always welcome to create a quickstart and contribute it to help others instantly monitor and observe their services. +![New Relic IO](../../../images/contribute-to-quickstarts/newrelic-io.png)