From 2b817f1b8118f665675eda0abf9984c398a9c47e Mon Sep 17 00:00:00 2001 From: Jim Hagan Date: Thu, 10 Mar 2022 14:48:34 -0500 Subject: [PATCH] docs: Improve language related to the New Relic license key. (#10796) --- etc/telegraf.conf | 4 ++-- etc/telegraf_windows.conf | 4 ++-- plugins/outputs/newrelic/README.md | 8 ++++++-- plugins/outputs/newrelic/newrelic.go | 8 ++++++-- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/etc/telegraf.conf b/etc/telegraf.conf index f0c23805c..5fb0f2ac6 100644 --- a/etc/telegraf.conf +++ b/etc/telegraf.conf @@ -1481,8 +1481,8 @@ # # Send metrics to New Relic metrics endpoint # [[outputs.newrelic]] -# ## New Relic Insights API key -# insights_key = "insights api key" +# ## New Relic License Key +# insights_key = "New Relic License Key Here" # # ## Prefix to add to add to metric name for easy identification. # # metric_prefix = "" diff --git a/etc/telegraf_windows.conf b/etc/telegraf_windows.conf index 596afc174..7f6bfe01f 100644 --- a/etc/telegraf_windows.conf +++ b/etc/telegraf_windows.conf @@ -1481,8 +1481,8 @@ # # Send metrics to New Relic metrics endpoint # [[outputs.newrelic]] -# ## New Relic Insights API key -# insights_key = "insights api key" +# ## New Relic License Key +# insights_key = "New Relic License Key Here" # # ## Prefix to add to add to metric name for easy identification. # # metric_prefix = "" diff --git a/plugins/outputs/newrelic/README.md b/plugins/outputs/newrelic/README.md index 54e34e825..800b12e7a 100644 --- a/plugins/outputs/newrelic/README.md +++ b/plugins/outputs/newrelic/README.md @@ -10,10 +10,14 @@ Telegraf minimum version: Telegraf 1.15.0 ```toml [[outputs.newrelic]] - ## New Relic Insights API key - insights_key = "insights api key" + ## The 'insights_key' parameter requires a NR license key. + ## New Relic recommends you create one + ## with a convenient name such as TELEGRAF_INSERT_KEY. + ## reference: https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#ingest-license-key + insights_key = "New Relic License Key Here" ## Prefix to add to add to metric name for easy identification. + ## This is very useful if your metric names are ambiguous. # metric_prefix = "" ## Timeout for writes to the New Relic API. diff --git a/plugins/outputs/newrelic/newrelic.go b/plugins/outputs/newrelic/newrelic.go index 5290d4e6a..5845b4b8d 100644 --- a/plugins/outputs/newrelic/newrelic.go +++ b/plugins/outputs/newrelic/newrelic.go @@ -39,10 +39,14 @@ func (nr *NewRelic) Description() string { // SampleConfig : return default configuration of the Output func (nr *NewRelic) SampleConfig() string { return ` - ## New Relic Insights API key - insights_key = "insights api key" + ## The 'insights_key' parameter requires a NR license key. + ## New Relic recommends you create one + ## with a convenient name such as TELEGRAF_INSERT_KEY. + ## reference: https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#ingest-license-key + # insights_key = "New Relic License Key Here" ## Prefix to add to add to metric name for easy identification. + ## This is very useful if your metric names are ambiguous. # metric_prefix = "" ## Timeout for writes to the New Relic API.