docs: Provide New Relic scaler #591

JoshuaJackson-jobvite · 2021-11-22T20:20:44Z

Why do we need this change?

Newrelic is a common Application Performance Monitoring(APM) tool that provides capabilities for team's to take relevant actions based on the gathered data/metrics from within their system.

What effects does this change have?

Add's in newrelic scaler documentation for 2.6+ release of keda

Checklist

Commits are signed with Developer Certificate of Origin (DCO)

Relates to kedacore/keda#2387
Relates to kedacore/keda#2290

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JoshuaJackson-jobvite · 2021-11-22T20:22:04Z

Supporting documentation for: kedacore/keda#2286 and kedacore/keda#2290

…iona and set values Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JorTurFer

Is the prefix nr required? I mean, this is New Relic scaler, so I understand that parameters are related with it.
WDYT?
BTW, thanks for this amazing contribution!! ❤️

content/docs/2.5/scalers/newrelic.md

tomkerkhove

Did a first run, but mainly nits - THanks for your PR!

content/docs/2.5/scalers/newrelic.md

…bit more look at the code Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

…ew Relic Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

content/docs/2.5/scalers/newrelic.md

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

…riable> names Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

… newrelic Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

tomkerkhove

Just a few remarks

content/docs/2.5/scalers/newrelic.md

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

…work natively Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

tomkerkhove

Almost there, just a few alignments.

Thanks!

content/docs/2.5/scalers/newrelic.md

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JorTurFer · 2021-11-25T19:34:45Z

hi @JoshuaJackson-jobvite,
We have just released the v2.5, could you update your PR and point your changes against v2.6 please?
Basically, you will need to move the file to the folder 2.6 and the version where this is available from.
Thanks a lot!

JoshuaJackson-jobvite · 2021-11-25T20:33:32Z

hi @JoshuaJackson-jobvite, We have just released the v2.5, could you update your PR and point your changes against v2.6 please? Basically, you will need to move the file to the folder 2.6 and the version where this is available from. Thanks a lot!

Done, thanks for the heads up that 2.5 was marked/released. Updated the main message for the pr to reflect the same change to 2.6 instead of 2.5 as well.

content/docs/2.6/scalers/newrelic.md

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

tomkerkhove · 2021-11-26T07:15:36Z

Don't forget about this consistency comment please?
#591 (comment)

And thank you for all your effort!

tomkerkhove

Requesting some consistency changes as per #591 (comment)

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JoshuaJackson-jobvite · 2021-11-26T16:55:37Z

Requesting some consistency changes as per #591 (comment)

@tomkerkhove hopefully the new update is more in line with what you are looking for.

…everaged n the crd, no reason to really mention it as such Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

tomkerkhove · 2021-11-29T06:49:14Z

Thanks a ton @JoshuaJackson-jobvite !

tomkerkhove

LGTM 🎉

Thanks for this!

zroubalik · 2021-12-09T10:14:42Z

content/docs/2.6/scalers/new-relic.md

+      account: 1234567
+      # Required: QueryKey - Api key to connect to New Relic
+      queryKey: "NRAK-xxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      # Optional: nrRegion - Region to query data for


Might be nice, to mention that US is default in here as well.

shall I rename queryKey to userApiKey to make it more similar to the name it have in new relic?
In new relic this is 'ApiKey' of type 'User' it

We now mention that US is the default in this yaml section

zroubalik

I don't see noDataErr in here and I'd name it probably noDataError or somethig similar, no need to shorten it here. I

marcelobartsch-jt · 2021-12-09T12:40:16Z

I don't see noDataErr in here and I'd name it probably noDataError or somethig similar, no need to shorten it here. I

Agreed, I'm changing this to noDataError in the scaler.

Why do we need this change? ======================= A new property was added for what to do when No data is returned by the nrql message. Need to document this What effects does this change have? ======================= * Add noDataError information for users * Update the yaml section to mention the default value for region is US Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

that's explicit in the documentation Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

…ed to add Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

zroubalik · 2021-12-09T15:47:04Z

content/docs/2.6/scalers/new-relic.md

+      # Required: metricName
+      metricName: "duration"


metricName is not being used anymore

zroubalik · 2021-12-09T15:47:18Z

content/docs/2.6/scalers/new-relic.md

+- `account` - The account within New Relic that the request should be targeted against.
+- `queryKey` - The API key that will be leveraged to connect to New Relic and make requests. [official documentation](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/)
+- `region` - The region to connect to for the New Relic apis. (Values: `LOCAL`, `EU`, `STAGING`, `US`, Default: `US`, Optional)
+- `metricName` - The metric to pull from the query result.


same as above

content/docs/2.6/scalers/new-relic.md

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com> Signed-off-by: Daniel Yavorovych <daniel@dysnix.com>

JoshuaJackson-jobvite requested review from ahmelsayed, jeffhollan, tomkerkhove and zroubalik as code owners November 22, 2021 20:20

:Documentation for proposed newrelic scaler to help move it along

d59a05e

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JoshuaJackson-jobvite mentioned this pull request Nov 22, 2021

feat: Provide New Relic scaler kedacore/keda#2286

Closed

5 tasks

JoshuaJackson-jobvite added 2 commits November 22, 2021 12:26

::minor changes to format to better match other scalers with both opt…

06bfee0

…iona and set values Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

::remove * around the type so its just a normal string

f53a867

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

tomkerkhove changed the title ~~Newrelic Scaler Supporting documentation~~ docs: Provide New Relic scaler Nov 22, 2021

::add trailing . for the nrAccount

e3d3cc2

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JorTurFer requested changes Nov 22, 2021

View reviewed changes

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

tomkerkhove reviewed Nov 22, 2021

View reviewed changes

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

JoshuaJackson-jobvite added 2 commits November 22, 2021 14:04

::add default values for the values that do create it after taking a …

4b233f6

…bit more look at the code Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

::Updates based on additional review/nitpicks to change Newrelic to N…

0a66108

…ew Relic Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JorTurFer requested changes Nov 22, 2021

View reviewed changes

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

JoshuaJackson-jobvite added 3 commits November 22, 2021 17:04

::Update optional arguments and order for Optional being last argument

4f77a3b

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

:::Updates based on the scaler changing to use generic names vs nr<va…

2cd216f

…riable> names Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

:::::also update for the new name of the scaler which is new-relic vs…

33650e0

… newrelic Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

tomkerkhove reviewed Nov 24, 2021

View reviewed changes

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

zroubalik reviewed Nov 24, 2021

View reviewed changes

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

zroubalik reviewed Nov 24, 2021

View reviewed changes

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

JoshuaJackson-jobvite added 3 commits November 24, 2021 08:21

::Fix for camelcase variables

8ceb85e

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

::Fix description to make it New Relic not NewRelic

30ca3cc

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

::Based on my reading of the way GetFromAuthOrMeta works this should …

e7495e6

…work natively Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JoshuaJackson-jobvite requested a review from JorTurFer November 24, 2021 21:44

tomkerkhove suggested changes Nov 25, 2021

View reviewed changes

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

content/docs/2.5/scalers/newrelic.md Outdated Show resolved Hide resolved

::ensure the trigger matches the trigger name case statement

4af873e

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JoshuaJackson-jobvite requested a review from tomkerkhove November 25, 2021 15:13

JorTurFer requested changes Nov 25, 2021

View reviewed changes

content/docs/2.6/scalers/newrelic.md Outdated Show resolved Hide resolved

::bah missed updating the scaler mention to 2.6 as well

243e7f4

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JoshuaJackson-jobvite requested a review from JorTurFer November 26, 2021 02:03

JorTurFer approved these changes Nov 26, 2021

View reviewed changes

tomkerkhove suggested changes Nov 26, 2021

View reviewed changes

::Trigger formatting to hopefully better align with other documentation

4506016

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JoshuaJackson-jobvite requested a review from tomkerkhove November 26, 2021 16:55

::since the only secret really is the queryKey, while others can be l…

860290a

…everaged n the crd, no reason to really mention it as such Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

tomkerkhove approved these changes Nov 29, 2021

View reviewed changes

JorTurFer mentioned this pull request Dec 8, 2021

feat: Provide New Relic scaler kedacore/keda#2387

Merged

5 tasks

zroubalik reviewed Dec 9, 2021

View reviewed changes

zroubalik requested changes Dec 9, 2021

View reviewed changes

JoshuaJackson-jobvite requested a review from zroubalik December 9, 2021 15:12

JoshuaJackson-jobvite added 2 commits December 9, 2021 07:16

:Added configuration to example, as its a string conversion make sure

6a4ea4d

that's explicit in the documentation Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

::Add . to the end of the default value in yaml to avoid potential ne…

e45e63a

…ed to add Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

zroubalik requested changes Dec 9, 2021

View reviewed changes

::metricName is still in tests, but not in actual code as a attribute

e3288b0

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com>

JoshuaJackson-jobvite requested a review from zroubalik December 9, 2021 19:26

zroubalik approved these changes Jan 3, 2022

View reviewed changes

zroubalik merged commit 02244a9 into kedacore:main Jan 3, 2022

daniel-yavorovich pushed a commit to dysnix/keda-docs that referenced this pull request Jan 18, 2022

docs: Provide New Relic scaler (kedacore#591)

f4434c1

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com> Signed-off-by: Daniel Yavorovych <daniel@dysnix.com>

daniel-yavorovich pushed a commit to dysnix/keda-docs that referenced this pull request Jan 18, 2022

docs: Provide New Relic scaler (kedacore#591)

7c029df

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com> Signed-off-by: Daniel Yavorovych <daniel@dysnix.com>

daniel-yavorovich pushed a commit to dysnix/keda-docs that referenced this pull request Jan 26, 2022

docs: Provide New Relic scaler (kedacore#591)

66f2309

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com> Signed-off-by: Daniel Yavorovych <daniel@dysnix.com>

daniel-yavorovich pushed a commit to dysnix/keda-docs that referenced this pull request Jan 26, 2022

docs: Provide New Relic scaler (kedacore#591)

a6b85d3

Signed-off-by: Joshua Jackson <joshua.jackson@jobvite-inc.com> Signed-off-by: Daniel Yavorovych <daniel@dysnix.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Provide New Relic scaler #591

docs: Provide New Relic scaler #591

JoshuaJackson-jobvite commented Nov 22, 2021 •

edited by tomkerkhove

Loading

JoshuaJackson-jobvite commented Nov 22, 2021

JorTurFer left a comment •

edited

Loading

tomkerkhove left a comment

tomkerkhove left a comment

tomkerkhove left a comment

JorTurFer commented Nov 25, 2021

JoshuaJackson-jobvite commented Nov 25, 2021 •

edited

Loading

tomkerkhove commented Nov 26, 2021

tomkerkhove left a comment

JoshuaJackson-jobvite commented Nov 26, 2021

tomkerkhove commented Nov 29, 2021

tomkerkhove left a comment

zroubalik Dec 9, 2021

marcelobartsch-jt Dec 9, 2021 •

edited

Loading

JoshuaJackson-jobvite Dec 9, 2021

zroubalik left a comment •

edited

Loading

marcelobartsch-jt commented Dec 9, 2021

zroubalik Dec 9, 2021

zroubalik Dec 9, 2021

docs: Provide New Relic scaler #591

docs: Provide New Relic scaler #591

Conversation

JoshuaJackson-jobvite commented Nov 22, 2021 • edited by tomkerkhove Loading

Why do we need this change?

What effects does this change have?

Checklist

JoshuaJackson-jobvite commented Nov 22, 2021

JorTurFer left a comment • edited Loading

Choose a reason for hiding this comment

tomkerkhove left a comment

Choose a reason for hiding this comment

tomkerkhove left a comment

Choose a reason for hiding this comment

tomkerkhove left a comment

Choose a reason for hiding this comment

JorTurFer commented Nov 25, 2021

JoshuaJackson-jobvite commented Nov 25, 2021 • edited Loading

tomkerkhove commented Nov 26, 2021

tomkerkhove left a comment

Choose a reason for hiding this comment

JoshuaJackson-jobvite commented Nov 26, 2021

tomkerkhove commented Nov 29, 2021

tomkerkhove left a comment

Choose a reason for hiding this comment

zroubalik Dec 9, 2021

Choose a reason for hiding this comment

marcelobartsch-jt Dec 9, 2021 • edited Loading

Choose a reason for hiding this comment

JoshuaJackson-jobvite Dec 9, 2021

Choose a reason for hiding this comment

zroubalik left a comment • edited Loading

Choose a reason for hiding this comment

marcelobartsch-jt commented Dec 9, 2021

zroubalik Dec 9, 2021

Choose a reason for hiding this comment

zroubalik Dec 9, 2021

Choose a reason for hiding this comment

JoshuaJackson-jobvite commented Nov 22, 2021 •

edited by tomkerkhove

Loading

JorTurFer left a comment •

edited

Loading

JoshuaJackson-jobvite commented Nov 25, 2021 •

edited

Loading

marcelobartsch-jt Dec 9, 2021 •

edited

Loading

zroubalik left a comment •

edited

Loading