update to the NRQL predictions and PREDICT syntax docs #20086

maprahamianNR · 2025-02-26T18:28:10Z

This PR updates some of the information about the new NRQL Predictions functionality (i.e. the PREDICT clause along with the details about its usage). The 2 pages being updated are:

Many of the technical details about the new functionality were incorrect and not explained well for a new user to understand.

Additionally, the 2 images used as examples of the predictions functionality are very poor examples that don't do a good job at demonstrating what the feature does.

CLAassistant · 2025-02-26T18:28:16Z

All committers have signed the CLA.

CLAassistant · 2025-02-26T18:28:16Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

github-actions · 2025-02-26T18:28:23Z

Hi @maprahamianNR 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

netlify · 2025-02-26T18:28:35Z

✅ Deploy Preview for docs-website-netlify ready!

Name	Link
🔨 Latest commit	`bf34ff2`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-website-netlify/deploys/67c68e48e64a2e000803cd86
😎 Deploy Preview	https://deploy-preview-20086--docs-website-netlify.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

cehme · 2025-03-03T15:39:36Z

src/content/docs/query-your-data/explore-query-data/use-charts/nrql-predictions.mdx

+      Use the `USING` keyword to specify the amount of historical data you want to use to train the model. For example, `PREDICT USING 1 day` uses the query window along with the data from the preceding day to train the model. Make sure the time span is an `integer unit` of time.
+      amount of time.
+      </Collapser>


Suggested change

Use the `USING` keyword to specify the amount of historical data you want to use to train the model. For example, `PREDICT USING 1 day` uses the query window along with the data from the preceding day to train the model. Make sure the time span is an `integer unit` of time.

amount of time.

</Collapser>

Use the `USING` keyword to specify the amount of historical data you want to use to train the model. For example, `PREDICT USING 1 day` uses the query window along with the data from the preceding day to train the model. Make sure the time span is an `integer unit` of time.

</Collapser>

nit

cehme · 2025-03-03T15:46:40Z

src/content/docs/query-your-data/explore-query-data/use-charts/nrql-predictions.mdx

+            <td>`NONE`</td>
+            <td>
+              Disables the seasonality of the time series and generates a non-seasonal prediction.


Can we add a note/callout here that NONE is mutually exclusive with gamma.

For reference, if you use seasonality: NONE and then include a value for gamma, the model just ignores whatever value you provide for gamma since it is never used. But I don't believe it will error or anything if you included it.

I can confirm we are seeing errors. I have not investigated yet, but currently we are seeing our generic wrapper for IllegalArgumentException from baselines being returned.

You're correct, that is my mistake. If you set seasonality: NONE and try to set a value for gamma, it will error.

maprahamianNR · 2025-03-03T15:47:32Z

src/content/docs/query-your-data/explore-query-data/use-charts/nrql-predictions.mdx

+      </Collapser>
+
+      <Collapser id="by" title={<>Add the <InlineCode>BY</InlineCode> keyword.</>}>
+      Use the `BY` keyword to set how far ahead in time you want the model to predict. For example, `PREDICT BY 3 hours` generates a prediction 3 hours into the future from the latest point in the time series. Make sure, the time span is an `integer unit` of time.


Comma after "Make sure" not needed.

cehme · 2025-03-03T15:51:21Z

src/content/docs/query-your-data/explore-query-data/use-charts/nrql-predictions.mdx

+            * **Lower value**: More damping effect to the prediction curve that gradually levels out to a flat curve.
+            * **Higher value**: Lesser damping effect to the prediction curve.


nit: All the others have higher before lower. Can we use the same ordering for all for consistency? Since the lower value explanation in this section has more detail, I would be in favor of putting lower in first for all the hyperparams.

maprahamianNR · 2025-03-03T16:05:26Z

src/content/docs/query-your-data/explore-query-data/use-charts/nrql-predictions.mdx

@@ -117,7 +117,7 @@ Currently, <DNT>**NRQL predictions**</DNT> only supports the <DNT>**Holt-Winters

 ## Default behavior [#defaults]
 The `PREDICT` clause in a query comes with the following default behaviors:
-* **Seasonality**: Automatically detects and identifies if the data exhibits any seasonality.
+* **Seasonality**: Automatically detects and identifies any seasonality in the data, allowing you to configure forecasts to follow the identified pattern or remove it.


I think this would be better worded as: "Automatically detects if seasonality is present in the data and if seasonality is present, uses the detected season length to construct the predictive model. If no seasonality is detected, a non-seasonal model is used."

cehme · 2025-03-03T16:20:14Z

src/content/docs/nrql/nrql-syntax-clauses-functions.mdx


-            ```sql
-        FROM Transaction SELECT count(*) WHERE error IS TRUE TIMESERIES PREDICT holtwinters(beta: 0.5) BY 3 hours USING 1 day
+    #### Customization [#customization]


Something is not rendering properly?

cehme · 2025-03-03T16:21:27Z

src/content/docs/nrql/nrql-syntax-clauses-functions.mdx

+      Use the `USING` keyword to specify the amount of historical data you want to use to train the model. For example, `PREDICT USING 1 day` uses the query window along with the data from the preceding day to train the model. Make sure the time span is an `integer unit` of time.
+      amount of time.


Suggested change

Use the `USING` keyword to specify the amount of historical data you want to use to train the model. For example, `PREDICT USING 1 day` uses the query window along with the data from the preceding day to train the model. Make sure the time span is an `integer unit` of time.

amount of time.

Use the `USING` keyword to specify the amount of historical data you want to use to train the model. For example, `PREDICT USING 1 day` uses the query window along with the data from the preceding day to train the model. Make sure the time span is an `integer unit` of time.

nit

sujitnewrelic

LGTM

update to the PREDICT docs

403f393

maprahamianNR added 2 commits February 26, 2025 13:44

new images

4fc9c99

additional updates; fix images

c30393a

maprahamianNR marked this pull request as ready for review February 26, 2025 20:52

typos and few small rewordings

f28a4c6

cbehera-newrelic requested a review from sujitnewrelic February 27, 2025 05:40

cbehera-newrelic self-assigned this Feb 27, 2025

cbehera-newrelic added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels Feb 27, 2025

sujitnewrelic added 3 commits February 28, 2025 18:43

Modified the suggested changes

c8a1df9

In progress

6aa41d3

WIP

1bd547e

cehme reviewed Mar 3, 2025

View reviewed changes

maprahamianNR commented Mar 3, 2025

View reviewed changes

cehme reviewed Mar 3, 2025

View reviewed changes

WIP

c4ec692

maprahamianNR commented Mar 3, 2025

View reviewed changes

cehme reviewed Mar 3, 2025

View reviewed changes

Updated the review comments from SME

bf34ff2

sujitnewrelic approved these changes Mar 4, 2025

View reviewed changes

sujitnewrelic merged commit a7ecd3f into newrelic:develop Mar 4, 2025
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update to the NRQL predictions and PREDICT syntax docs #20086

update to the NRQL predictions and PREDICT syntax docs #20086

maprahamianNR commented Feb 26, 2025

CLAassistant commented Feb 26, 2025 •

edited

Loading

CLAassistant commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

netlify bot commented Feb 26, 2025 •

edited

Loading

cehme Mar 3, 2025

cehme Mar 3, 2025

maprahamianNR Mar 3, 2025

cehme Mar 3, 2025

maprahamianNR Mar 3, 2025

sujitnewrelic Mar 4, 2025

maprahamianNR Mar 3, 2025

cehme Mar 3, 2025

maprahamianNR Mar 3, 2025

cehme Mar 3, 2025

cehme Mar 3, 2025

sujitnewrelic left a comment

		* Lower value: More damping effect to the prediction curve that gradually levels out to a flat curve.
		* Higher value: Lesser damping effect to the prediction curve.

		Use the `USING` keyword to specify the amount of historical data you want to use to train the model. For example, `PREDICT USING 1 day` uses the query window along with the data from the preceding day to train the model. Make sure the time span is an `integer unit` of time.
		amount of time.

update to the NRQL predictions and PREDICT syntax docs #20086

update to the NRQL predictions and PREDICT syntax docs #20086

Conversation

maprahamianNR commented Feb 26, 2025

CLAassistant commented Feb 26, 2025 • edited Loading

CLAassistant commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

netlify bot commented Feb 26, 2025 • edited Loading

✅ Deploy Preview for docs-website-netlify ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sujitnewrelic left a comment

Choose a reason for hiding this comment

CLAassistant commented Feb 26, 2025 •

edited

Loading

netlify bot commented Feb 26, 2025 •

edited

Loading