Feature update may25 (#66)

jsbnr · akrrev · web-flow · commit d777fff9c750 · 2025-05-07T14:56:13.000+01:00
* fix account bug and added ifthen * index updated * Added capture lesson, aparse() done and capture() still to do * Minor updates to support Transaction events in remaining query examples (#65) * Update queries for aparse() and if() to fully support the Transaction event type * Refer to docs until examples have been added for regex captures * nip and tuck * readme * fix for keyset from PR#52 * updated package lock * readme * workflow updates * prettier --------- Co-authored-by: Alexander Kristiansen <117973016+akrrev@users.noreply.github.com>
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -23,7 +23,7 @@ jobs:
 
       - name: Cache node_modules
         id: cache-node-modules
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         env:
           cache-name: node-modules
         with:
@@ -57,7 +57,7 @@ jobs:
 
       - name: Cache node_modules
         id: cache-node-modules
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         env:
           cache-name: node-modules
         with:
@@ -103,7 +103,7 @@ jobs:
 
       - name: Cache node_modules
         id: cache-node-modules
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         env:
           cache-name: node-modules
         with:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -25,7 +25,7 @@ jobs:
 
       - name: Cache node_modules
         id: cache-node-modules
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         env:
           cache-name: node-modules
         with:
@@ -63,7 +63,7 @@ jobs:
 
       - name: Download Cached Deps
         id: cache-node-modules
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         env:
           cache-name: node-modules
         with:
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+# Ignore all js files:
+**/*.js
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ cd nr1-learn-nrql
 npm install
 nr1 nerdpack:uuid -gf
 nr1 nerdpack:publish
-nr1 nerdpack:subscribe -c STABLE
+nr1 nerdpack:subscribe
 ```
 This last command will subscribe the application to the account you've set as your default profile. You can check this using `nr1 profiles:default`. If you're not ready to deploy it to your account or want to test out changes you've made locally you can use:
 
@@ -82,4 +82,4 @@ This project adheres to the New Relic [security policy](https://github.com/newre
 
 Contributions are encouraged! If you submit an enhancement request, we'll invite you to contribute the change yourself. Please review our [Contributors Guide](CONTRIBUTING.md).
 
-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+learn_nrql@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+learn_nrql@newrelic.com.
diff --git a/nerdlets/nrql-tutorial-nerdlet/components/SampleQuery.js b/nerdlets/nrql-tutorial-nerdlet/components/SampleQuery.js
@@ -71,6 +71,7 @@ export default class SampleQuery extends React.Component {
       .replace(/\*\*/g, '')
       .replace(/\\\*/g, '*')
       .replace(/\\_/g, '_')
+      .replace(/\\\\/g, '\\')
       .replace(/\\\[/g, '[');
 
     const fallbacknrqlPlain = fallbacknrql
diff --git a/nerdlets/nrql-tutorial-nerdlet/index.js b/nerdlets/nrql-tutorial-nerdlet/index.js
@@ -63,7 +63,7 @@ export default class NrqlTutorialNerdlet extends React.Component {
     let hasNoAPM = true;
 
     // Get the 'accounts' from the returned data from the query to NerdGraph
-    const { data: { actor: { accounts } } } = await NerdGraphQuery.query({ query }); // eslint-disable-line prettier/prettier
+    const { data: { actor: { accounts } } } = await NerdGraphQuery.query({ query }); 
     const noAccounts = accounts.length === 0;
 
     // Get the previous level, lesson and language from the User Storage
@@ -81,7 +81,7 @@ export default class NrqlTutorialNerdlet extends React.Component {
       // sanity check that loaded lesson actually exists
       const level = LEVELS[currentLevel];
       if (!level || !level.lessons[currentLesson]) {
-        // eslint-disable-next-line no-console, prettier/prettier
+        // eslint-disable-next-line no-console
         console.log(`Lesson ${currentLesson + 1} of level ${currentLevel + 1} doesn't exist! Resetting to level 1, lesson 1.`);
         currentLevel = 0;
         currentLesson = 0;
@@ -115,11 +115,11 @@ export default class NrqlTutorialNerdlet extends React.Component {
       }
 
       return (
-        <SelectItem value={String(id)} key={id}>{name}</SelectItem> // eslint-disable-line prettier/prettier
+        <SelectItem value={String(id)} key={id}>{name}</SelectItem> 
       );
     });
     // Check if we do not have an account selected when there are accounts (i.e. none contain Transaction event type)
-    if (typeof !noAccounts && selectedAccount !== 'number') {
+    if (!noAccounts && typeof selectedAccount !== 'number') {
       //  If no account selected, use the first account in the list.
       selectedAccount = accounts[0].id;
     }
@@ -231,9 +231,9 @@ export default class NrqlTutorialNerdlet extends React.Component {
                     <GridItem columnSpan={5}>
                       <Select
                         onChange={(key, value) => {
-                          const found = accounts.find(({ key }) => key === value); // eslint-disable-line prettier/prettier
-                          const hasAPMbool = found.props.children.includes('no recent APM data'); // eslint-disable-line prettier/prettier
-                          this.setState({ selectedAccount: value, hasNoAPM: hasAPMbool }); // eslint-disable-line prettier/prettier
+                          const found = accounts.find(({ key }) => key === value); 
+                          const hasAPMbool = found.props.children.includes('no recent APM data'); 
+                          this.setState({ selectedAccount: value, hasNoAPM: hasAPMbool }); 
                         }}
                         value={selectedAccount}
                       >
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level1/lessons/FirstQuery.js b/nerdlets/nrql-tutorial-nerdlet/levels/level1/lessons/FirstQuery.js
@@ -55,7 +55,7 @@ export default function FirstQuery() {
           which is 100 table rows for <code>SELECT *</code> queries or 10
           aggregated values for <code>FACET</code> queries and{' '}
           <code>SELECT (attributes)</code> queries. You can specify any limit up
-          to the maximum. Use <code>LIMIT MAX</code> to return the maximum
+          to the maximum. Use <code>LIMIT MAX</code> to return the maximum (10k) 
           number of results possible.
         </Trans>
       </p>
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level2/lessons/AggregateQuery2.js b/nerdlets/nrql-tutorial-nerdlet/levels/level2/lessons/AggregateQuery2.js
@@ -48,8 +48,8 @@ export default function AggregateQuery2() {
       </p>
 
       <SampleQuery
-        nrql="SELECT **uniques(host)** FROM Transaction SINCE 1 day ago"
-        fallbacknrql="SELECT uniques(http.url) FROM Public_APICall SINCE 1 day ago"
+        nrql="SELECT **uniques(host)** as hosts FROM Transaction SINCE 1 day ago"
+        fallbacknrql="SELECT uniques(http.url) as urls FROM Public_APICall SINCE 1 day ago"
         span="6"
         chartType="table"
       />
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level2/lessons/CompareWith.js b/nerdlets/nrql-tutorial-nerdlet/levels/level2/lessons/CompareWith.js
@@ -25,14 +25,14 @@ export default function CompareWith() {
       <p>
         <Trans i18nKey="Contents.P3">
           Specifically, in the sample query below we compare the last day
-          against the previous week using a relative offset of{' '}
-          <code>1 week ago</code>.
+          against the previous day'ss using a relative offset of{' '}
+          <code>1 day ago</code>.
         </Trans>
       </p>
 
       <SampleQuery
-        nrql="SELECT average(duration) FROM Transaction SINCE 1 DAY AGO **COMPARE WITH 1 WEEK AGO**"
-        fallbacknrql="SELECT average(duration) FROM Public_APICall SINCE 1 day ago COMPARE WITH 1 week ago"
+        nrql="SELECT average(duration) FROM Transaction SINCE 1 DAY AGO **COMPARE WITH 1 DAY AGO**"
+        fallbacknrql="SELECT average(duration) FROM Public_APICall SINCE 1 day ago COMPARE WITH 1 DAY ago"
         span="6"
       />
 
@@ -46,8 +46,8 @@ export default function CompareWith() {
       </p>
 
       <SampleQuery
-        nrql="SELECT average(duration) FROM Transaction SINCE 1 DAY AGO **COMPARE WITH 1 WEEK AGO** TIMESERIES"
-        fallbacknrql="SELECT average(duration) FROM Public_APICall SINCE 1 day ago COMPARE WITH 1 week ago TIMESERIES"
+        nrql="SELECT average(duration) FROM Transaction SINCE 1 DAY AGO **COMPARE WITH 1 DAY AGO** TIMESERIES"
+        fallbacknrql="SELECT average(duration) FROM Public_APICall SINCE 1 day ago COMPARE WITH 1 DAY ago TIMESERIES"
         span="12"
       />
 
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level3/index.js b/nerdlets/nrql-tutorial-nerdlet/levels/level3/index.js
@@ -5,6 +5,7 @@ import FacetCases from './lessons/FacetCases';
 import FilterToEventTypes from './lessons/FilterToEventTypes';
 import OverridingValues from './lessons/OverridingValues';
 import Concatenation from './lessons/Concatenation';
+import IfThen from './lessons/IfThen';
 import NextSteps from './lessons/NextSteps';
 
 export default [
@@ -36,6 +37,10 @@ export default [
     title: 'String concatenation',
     component: Concatenation
   },
+  {
+    title: 'Conditional logic',
+    component: IfThen
+  },
   {
     title: 'Summary',
     component: NextSteps
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level3/lessons/IfThen.js b/nerdlets/nrql-tutorial-nerdlet/levels/level3/lessons/IfThen.js
@@ -0,0 +1,57 @@
+import React from 'react';
+import SampleQuery from '../../../components/SampleQuery';
+import { Trans } from 'react-i18next';
+
+export default function IfThen() {
+  return (
+    <div>
+      <p>
+        <Trans i18nKey="Contents.P1">
+          Sometimes you may not want to display something different depending on the value. You can use <code>IF...THEN</code> in 
+          your query to add logic. The <code>IF()</code> function takes a value then a true and a false condition.  
+        </Trans>
+      </p>
+
+      <SampleQuery
+        nrql="FROM Transaction SELECT COUNT(\*), **IF(COUNT(\*)> 1000000,'High traffic','Low traffic') AS 'Scale'** FACET request.headers.host"
+        fallbacknrql="FROM Public_APICall SELECT COUNT(\*), **IF(COUNT(\*)> 1000000,'High traffic','Low traffic') AS 'Scale'** FACET api"
+        chartType="table"
+        span="12"
+      />
+
+      <p>
+        <Trans i18nKey="Contents.P2">
+          You can enrich your dashboard by using emoji icons in order to make them more impactful. 
+          For example here we show a red icon if the duration is above a threshold we choose. 
+        </Trans>
+      </p>
+      <SampleQuery
+        nrql="FROM Transaction SELECT average(duration), **IF(average(duration)>0.5,'🔴','🟢') AS 'Flag'** FACET request.headers.host"
+        fallbacknrql="FROM Public_APICall SELECT average(duration), **IF(average(duration)> 1,'🔴','🟢') AS 'Flag'** FACET api"
+        chartType="table"
+        span="12"
+      />
+
+      <p>
+        <Trans i18nKey="Contents.P3">
+          It's possible to use the IF() function within the facet clause too. This lets you control how to group assets together for evaluation. 
+          For example here we group the API's by Amazon and Google and group the rest together.
+        </Trans>
+      </p>
+      <SampleQuery
+        nrql="FROM Public_APICall SELECT COUNT(*) **FACET IF(api LIKE 'amazon%', 'Amazon', IF(api LIKE 'google%', 'Google','Everything else')) AS 'Service'**"
+        fallbacknrql="FROM Public_APICall SELECT COUNT(*) **FACET IF(api LIKE 'amazon%', 'Amazon', IF(api LIKE 'google%', 'Google','Everything else')) AS 'Service'**"
+        chartType="pie"
+        span="12"
+      />
+      <h2>
+        <Trans i18nKey="Contents.H1">Lesson Summary</Trans>
+      </h2>
+      <p>
+        <Trans i18nKey="Contents.P4">
+          Using the <code>IF()</code> funciton can help simplify your data, build more flexible queries and make it easier to digest.
+        </Trans>
+      </p>
+    </div>
+  );
+}
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level4/index.js b/nerdlets/nrql-tutorial-nerdlet/levels/level4/index.js
@@ -5,6 +5,7 @@ import Subqueries from './lessons/Subqueries';
 import NestedAggregation from './lessons/NestedAggregation';
 import DiscoverEventsAndAttributes from './lessons/DiscoverEventsAndAttributes';
 import AdvancedMath from './lessons/AdvancedMath';
+import Capture from './lessons/Capture';
 import Summary from './lessons/Summary';
 
 export default [
@@ -36,6 +37,10 @@ export default [
     title: 'Subqueries',
     component: Subqueries
   },
+  {
+    title: 'Capturing data',
+    component: Capture
+  },
   {
     title: 'Summary',
     component: Summary
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/AdvancedMath.js b/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/AdvancedMath.js
@@ -66,8 +66,8 @@ export default function AdvancedMath() {
         </Trans>
       </p>
       <SampleQuery
-        nrql="SELECT **clamp\_max(average(duration), 10)**, **clamp\_min(average(duration), 1)** FROM Transaction SINCE 1 day ago TIMESERIES"
-        fallbacknrql="SELECT clamp_max(average(duration), 10), clamp_min(average(duration), 1) from Public_APICall since 24 hours ago TIMESERIES"
+        nrql="SELECT **clamp\_max(average(duration), 10) as clampMax**, **clamp\_min(average(duration), 1) as clampMin** FROM Transaction SINCE 1 day ago TIMESERIES"
+        fallbacknrql="SELECT clamp_max(average(duration), 10) as clampMax, clamp_min(average(duration), 1) as clampMin from Public_APICall since 24 hours ago TIMESERIES"
         span="12"
       />
 
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/AggregateQuery4.js b/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/AggregateQuery4.js
@@ -76,9 +76,12 @@ export default function AggregateQuery4() {
           400 calls, and group it in 10 buckets. The result is the performance
           of transactions making 0-40, 40-80, 80-120, 120-160, 160-200, 200-240,
           240-280, 280-320, 320-360, and &gt;360 Database Calls. 10 clear
-          buckets divided evenly up to the ceiling.
+          buckets divided evenly up to the ceiling. 
         </Trans>
       </p>
+      <p className="notice">
+        If you dont see much of an output in the chart, change the value 400 to match your data.
+      </p>
       <SampleQuery
         nrql="SELECT average(duration) FROM Transaction SINCE 12 hours ago FACET **buckets(databaseCallCount, 400, 10)**"
         fallbacknrql="SELECT average(duration) from Public_APICall since 24 hours ago FACET buckets(duration, 400, 10)"
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/Capture.js b/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/Capture.js
@@ -0,0 +1,93 @@
+import React from 'react';
+import SampleQuery from '../../../components/SampleQuery';
+import { Trans } from 'react-i18next';
+
+export default function Capture() {
+  return (
+    <div>
+      <p>
+        <Trans i18nKey="Contents.P1">
+          Sometimes you want to extract or display just part of a vlaue. For instance you may want 
+          to extract and display the product ID from a long URL that contains it rather than display the full URL. 
+          There are two NRQL functions that can help with this: <code>aparse()</code> and <code>capture()</code>. <code>aparse()</code> is simple and 
+          more efficient but <code>capture()</code> offers more complex regular expression support.
+        </Trans>
+      </p>
+      <h2>
+        <Trans i18nKey="Contents.H1">Capture with aparse()</Trans>
+      </h2>
+      <p>
+        <Trans i18nKey="Contents.P2">
+          The <code>aparse()</code> function allows you to extract values from a string using a simple syntax. You 
+          provide the string you wish to extract from and a pattern controlling the extraction. The pattern supports 
+          two wild cards:<br />
+          <code>%</code>- Non capturing wild card<br />
+          <code>*</code>- A capturing wild card
+        </Trans>
+      </p>
+      <p>
+        <Trans i18nKey="Contents.P3">
+          Lets take a look at an example. In the Public API data set Amazon API URL's are composed of three parts: 
+          the service, the region and the domain. e.g. "dynamodb.us-east-1.amazonaws.com".  We can use <code>aparse()</code>
+          to query data and group it by service. We use the pattern <code>'*.%'</code> which captures everything before the first 
+          period and disregards the rest:
+        </Trans>
+      </p>
+      <SampleQuery
+        nrql="SELECT COUNT(*) FROM Public_APICall WHERE http.url LIKE '%amazonaws.com' **FACET aparse(http.url,'\*.%') AS 'service'**"
+        fallbacknrql="SELECT COUNT(*) FROM Public_APICall WHERE http.url LIKE '%amazonaws.com' **FACET aparse(http.url,'\*.%') AS 'service'**"
+        span="12"
+        chartType="table"
+      />
+      <p>
+        <Trans i18nKey="Contents.P4">
+          If we wanted to extract the region from the string instead then we need this pattern: <code>'%.*.%'</code> This discards 
+          everthing matched before the first period, captures everything up to the next period, and disregards the rest:
+        </Trans>
+      </p>
+      <SampleQuery
+        nrql="SELECT COUNT(*) FROM Public_APICall WHERE http.url LIKE '%amazonaws.com' **FACET aparse(http.url,'%.\*.%') AS 'region'**"
+        fallbacknrql="SELECT COUNT(*) FROM Public_APICall WHERE http.url LIKE '%amazonaws.com' **FACET aparse(http.url,'%.\*.%') AS 'region'**"
+        span="12"
+        chartType="table"
+      />
+      <p>
+        <Trans i18nKey="Contents.P5">
+          It is possible to extract more than one field using aparse() but you cant use them directly in the facet. This requires 
+          variables which are covered in another section, but whilst we are here lets see how that would look. We need to adjust our 
+          pattern so that it includes two capture groups: <code>'*.*.%'</code>. We set these to the variables 'service' and 'region' 
+          then facet o nthem.
+        
+        </Trans>
+      </p>
+      <SampleQuery
+        nrql="FROM Public_APICall **WITH aparse(http.url,'\*.\*.%') AS (service,region)** SELECT COUNT(*) WHERE http.url LIKE '%amazonaws.com' **FACET service, region**"
+        fallbacknrql="FROM Public_APICall **WITH aparse(http.url,'\*.\*.%') AS (service,region)** SELECT COUNT(*) WHERE http.url LIKE '%amazonaws.com' **FACET service, region**"
+        span="12"
+        chartType="table"
+      />
+      <h2>
+        <Trans i18nKey="Contents.H2">Regex Capture()</Trans>
+      </h2>
+      <p>
+        <Trans i18nKey="Contents.P6">
+          When you want to use more complex regex patterns you can use the <code>capture()</code> function. This function
+          takes a string and a regex pattern. The pattern can contain multiple capture groups using the <a href="https://github.com/google/re2/wiki/Syntax" rel="noreferrer" target="_blank">RE2 named-capture 
+          syntax</a> to capture the contained pattern, given the specified name. 
+        </Trans>
+      </p>
+      <p>
+        <Trans i18nKey="Contents.P7">
+        Multiple values can be captured by specifying additional capture groups in a regular expression as illustrated in this example. Refer to the 
+        <a href="https://docs.newrelic.com/docs/nrql/nrql-syntax-clauses-functions/#func-capture" target="_blank" rel="noreferrer">New Relic documentation</a> for more examples.
+        </Trans>
+      </p>
+      <SampleQuery
+        nrql="FROM Public_APICall WITH **capture(http.url,r'^(?P<service>.*)\\.(?P<region>.*)\\.amazonaws\.com$') as (service,region)** SELECT COUNT(*) WHERE http.url LIKE '%amazonaws.com' FACET service, region since 10 minutes ago"
+        fallbacknrql="FROM Public_APICall WITH **capture(http.url,r'^(?P<service>.*)\\.(?P<region>.*)\\.amazonaws\.com$') as (service,region)** SELECT COUNT(*) WHERE http.url LIKE '%amazonaws.com' FACET service, region since 10 minutes ago"
+        span="12"
+        chartType="table"
+      />
+   </div>
+  );
+}
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/DiscoverEventsAndAttributes.js b/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/DiscoverEventsAndAttributes.js
@@ -50,7 +50,7 @@ export default function DiscoverEventsAndAttributes() {
       </p>
       <SampleQuery
         nrql="SELECT **keyset()** FROM Transaction SINCE 1 week ago"
-        fallbacknrql="SHOW keyset() FROM Public_APICall SINCE 1 week ago"
+        fallbacknrql="SELECT keyset() FROM Public_APICall SINCE 1 week ago"
         chartType="json"
         span="12"
       />
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/NestedAggregation.js b/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/NestedAggregation.js
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/UsingRegex.js b/nerdlets/nrql-tutorial-nerdlet/levels/level4/lessons/UsingRegex.js
diff --git a/nerdlets/nrql-tutorial-nerdlet/levels/resources/refIndex/indexMapping.js b/nerdlets/nrql-tutorial-nerdlet/levels/resources/refIndex/indexMapping.js
diff --git a/nr1.json b/nr1.json
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
