From a4adc8e5c61542a14b733b526b342888c3996abd Mon Sep 17 00:00:00 2001 From: mmfred Date: Wed, 13 May 2020 07:46:36 -0700 Subject: [PATCH 1/9] Create guide_template.markdown basic template to get started on guides. This is just for writing and there are some open questions - I'm sure there are some style changes needed to work with the js guide. I'm not sure how we are doing videos, for example. --- src/markdown-pages/guide_template.markdown | 33 ++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 src/markdown-pages/guide_template.markdown diff --git a/src/markdown-pages/guide_template.markdown b/src/markdown-pages/guide_template.markdown new file mode 100644 index 000000000..00e919204 --- /dev/null +++ b/src/markdown-pages/guide_template.markdown @@ -0,0 +1,33 @@ +Use this template to create guides. Make a copy, rename the document, and add your guide content. Add or remove sections, as appropriate. + + +## + +Write an intro paragraph that engages the user, tells them what they'll learn, and what problems they'll solve. + +ADD VIDEO/SCREENSHOT/GIF + +### Before you begin + +Add a list of prerequisites. For example: +- Create a developer account +- Get an API key +- Download the New Relic One CLI + +1. Write the step info. Does not have to be long and verbose. + +``` +Add code example +``` +2. Write the step info. Repeat as many times as needed. Increment up the step number. + +``` +Add code example +``` + +Related info + +- Link to next logical guide +- Link to related content like reference docs +- Link to related opensource.newrelic.com, docs.newrelic.com, blog, git docs, or other related content. + From 10301032e5234c4df1c97ffdb4ed9a82862c384f Mon Sep 17 00:00:00 2001 From: veextee Date: Fri, 12 Jun 2020 14:15:09 -0700 Subject: [PATCH 2/9] Create add-custom-attributes-mdx --- .../components/add-custom-attributes-mdx | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 src/markdown-pages/components/add-custom-attributes-mdx diff --git a/src/markdown-pages/components/add-custom-attributes-mdx b/src/markdown-pages/components/add-custom-attributes-mdx new file mode 100644 index 000000000..aa5a64a7e --- /dev/null +++ b/src/markdown-pages/components/add-custom-attributes-mdx @@ -0,0 +1,42 @@ +collect-data/custom-attributes.mdx +path: '/guides/example' +duration: '' +title: 'How to add custom attributes to your New Relic data' +template: 'GuideTemplate' +description: 'Add metadata for more detailed analysis +There are countless filters and pivots you may want to apply to your data. By adding custom attributes to your data, you can see beyond your code and analyze your business in-depth.' +--- + + + +This guide steps you through how to add your own custom attributes, which you can use for querying and charting. +
+There are countless filters and pivots you may want to apply to your data. By adding custom attributes to your data, you can see beyond your code and analyze your business in-depth. +
+
+You can add a 'userid' custom attribute to your APM-reported data (Transaction and TransactionError events) with the Java APM agent's API. + +
+ +```NewRelic.addCustomParameter("userid", userId); +``` +Learn more about Agent APIs +
+Once added, you can run a NRQL query that uses the 'userid' custom attribute. +
+```-- Get a count of errors experienced by a single filtered userid faceted by date and error message +SELECT count(*) FROM TransactionError WHERE userid = '616e6472-6577-7340-7961-686f6f2e636f' FACET dateOf(timestamp), `error.message` SINCE 1 week ago +``` +
+Learn more about NRQL/a> +

+Once you have added a custom attribute like 'userid', you can use it to filter and facet your NRQL queries. +
+ + + + + +### Related Info + +For more information, see our documentation. From a235c9783de25e09b8b5ef9cc7fc5fc313e79c34 Mon Sep 17 00:00:00 2001 From: mmfred <58010132+mmfred@users.noreply.github.com> Date: Wed, 24 Jun 2020 14:01:06 -0700 Subject: [PATCH 3/9] tweaking some changes per Zack's review. --- .../components/add-custom-attributes-mdx | 21 ++++++++----------- 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/src/markdown-pages/components/add-custom-attributes-mdx b/src/markdown-pages/components/add-custom-attributes-mdx index aa5a64a7e..02f51a22e 100644 --- a/src/markdown-pages/components/add-custom-attributes-mdx +++ b/src/markdown-pages/components/add-custom-attributes-mdx @@ -1,20 +1,17 @@ -collect-data/custom-attributes.mdx -path: '/guides/example' +--- + +path: '/collect-data/custom-attributes.mdx' duration: '' -title: 'How to add custom attributes to your New Relic data' +title: 'Add custom attributes to your New Relic data' template: 'GuideTemplate' -description: 'Add metadata for more detailed analysis -There are countless filters and pivots you may want to apply to your data. By adding custom attributes to your data, you can see beyond your code and analyze your business in-depth.' +description: 'Add metadata for more detailed analysis' --- -This guide steps you through how to add your own custom attributes, which you can use for querying and charting. -
-There are countless filters and pivots you may want to apply to your data. By adding custom attributes to your data, you can see beyond your code and analyze your business in-depth. -
-
-You can add a 'userid' custom attribute to your APM-reported data (Transaction and TransactionError events) with the Java APM agent's API. +There are countless filters and pivots you might want to apply to your data. By adding custom attributes to your data, you can see beyond your code and analyze your business in-depth. + +You can add a `userid` custom attribute to your APM-reported data (`Transaction` and `TransactionError events`) with the Java APM agent's API.
@@ -39,4 +36,4 @@ Once you have added a custom attribute like 'userid', you can use it to filter a ### Related Info -For more information, see our documentation. +For more information, see [New Relic APM: Report custom attributes](https://docs.newrelic.com/docs/insights/insights-data-sources/custom-data/add-custom-attributes-new-relic-apm-data) From 537cef7bdb9453efe5acb640db12a7bd14ee6e16 Mon Sep 17 00:00:00 2001 From: mmfred <58010132+mmfred@users.noreply.github.com> Date: Wed, 24 Jun 2020 14:50:36 -0700 Subject: [PATCH 4/9] another fix link was broken --- src/markdown-pages/components/add-custom-attributes-mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdown-pages/components/add-custom-attributes-mdx b/src/markdown-pages/components/add-custom-attributes-mdx index 02f51a22e..b5aa040c4 100644 --- a/src/markdown-pages/components/add-custom-attributes-mdx +++ b/src/markdown-pages/components/add-custom-attributes-mdx @@ -17,7 +17,7 @@ You can add a `userid` custom attribute to your APM-reported data (`Transaction` ```NewRelic.addCustomParameter("userid", userId); ``` -Learn more about Agent APIs +
Once added, you can run a NRQL query that uses the 'userid' custom attribute.
From 7b638efbcb3b2f044b461e2a4bd91dd5743a8479 Mon Sep 17 00:00:00 2001 From: mmfred <58010132+mmfred@users.noreply.github.com> Date: Wed, 24 Jun 2020 14:52:32 -0700 Subject: [PATCH 5/9] removed br tags --- .../components/add-custom-attributes-mdx | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/markdown-pages/components/add-custom-attributes-mdx b/src/markdown-pages/components/add-custom-attributes-mdx index b5aa040c4..536fd45f8 100644 --- a/src/markdown-pages/components/add-custom-attributes-mdx +++ b/src/markdown-pages/components/add-custom-attributes-mdx @@ -13,22 +13,20 @@ There are countless filters and pivots you might want to apply to your data. By You can add a `userid` custom attribute to your APM-reported data (`Transaction` and `TransactionError events`) with the Java APM agent's API. -
```NewRelic.addCustomParameter("userid", userId); ``` -
+ Once added, you can run a NRQL query that uses the 'userid' custom attribute. -
+ ```-- Get a count of errors experienced by a single filtered userid faceted by date and error message SELECT count(*) FROM TransactionError WHERE userid = '616e6472-6577-7340-7961-686f6f2e636f' FACET dateOf(timestamp), `error.message` SINCE 1 week ago ``` -
Learn more about NRQL/a> -

+ Once you have added a custom attribute like 'userid', you can use it to filter and facet your NRQL queries. -
+ From 2b7531338464bde5ca9b7787d95b5608f3d46e0e Mon Sep 17 00:00:00 2001 From: mmfred <58010132+mmfred@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:41:02 -0700 Subject: [PATCH 6/9] took out .mdx from title --- src/markdown-pages/components/add-custom-attributes-mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdown-pages/components/add-custom-attributes-mdx b/src/markdown-pages/components/add-custom-attributes-mdx index 536fd45f8..4958747e8 100644 --- a/src/markdown-pages/components/add-custom-attributes-mdx +++ b/src/markdown-pages/components/add-custom-attributes-mdx @@ -1,6 +1,6 @@ --- -path: '/collect-data/custom-attributes.mdx' +path: '/collect-data/custom-attributes' duration: '' title: 'Add custom attributes to your New Relic data' template: 'GuideTemplate' From 43a3ea54bebf542a2e8c0787e94569dfdb9d1749 Mon Sep 17 00:00:00 2001 From: mmfred <58010132+mmfred@users.noreply.github.com> Date: Wed, 24 Jun 2020 16:26:21 -0700 Subject: [PATCH 7/9] fixed file name. --- .../{add-custom-attributes-mdx => add-custom-attributes} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/markdown-pages/components/{add-custom-attributes-mdx => add-custom-attributes} (100%) diff --git a/src/markdown-pages/components/add-custom-attributes-mdx b/src/markdown-pages/components/add-custom-attributes similarity index 100% rename from src/markdown-pages/components/add-custom-attributes-mdx rename to src/markdown-pages/components/add-custom-attributes From 6830b2008313ca5d8477080f453f2cbda3ccff1b Mon Sep 17 00:00:00 2001 From: mmfred <58010132+mmfred@users.noreply.github.com> Date: Wed, 24 Jun 2020 16:28:32 -0700 Subject: [PATCH 8/9] another tweak of file name --- .../{add-custom-attributes => add-custom-attributes.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/markdown-pages/components/{add-custom-attributes => add-custom-attributes.mdx} (100%) diff --git a/src/markdown-pages/components/add-custom-attributes b/src/markdown-pages/components/add-custom-attributes.mdx similarity index 100% rename from src/markdown-pages/components/add-custom-attributes rename to src/markdown-pages/components/add-custom-attributes.mdx From 7334dbe267aaef4b6c06d1111799e5421de5122d Mon Sep 17 00:00:00 2001 From: Zack Stickles Date: Thu, 25 Jun 2020 09:21:20 -0700 Subject: [PATCH 9/9] fix: removing example file --- src/markdown-pages/guide_template.markdown | 33 ---------------------- 1 file changed, 33 deletions(-) delete mode 100644 src/markdown-pages/guide_template.markdown diff --git a/src/markdown-pages/guide_template.markdown b/src/markdown-pages/guide_template.markdown deleted file mode 100644 index 00e919204..000000000 --- a/src/markdown-pages/guide_template.markdown +++ /dev/null @@ -1,33 +0,0 @@ -Use this template to create guides. Make a copy, rename the document, and add your guide content. Add or remove sections, as appropriate. - - -## - -Write an intro paragraph that engages the user, tells them what they'll learn, and what problems they'll solve. - -ADD VIDEO/SCREENSHOT/GIF - -### Before you begin - -Add a list of prerequisites. For example: -- Create a developer account -- Get an API key -- Download the New Relic One CLI - -1. Write the step info. Does not have to be long and verbose. - -``` -Add code example -``` -2. Write the step info. Repeat as many times as needed. Increment up the step number. - -``` -Add code example -``` - -Related info - -- Link to next logical guide -- Link to related content like reference docs -- Link to related opensource.newrelic.com, docs.newrelic.com, blog, git docs, or other related content. -