telegraf/plugins/outputs/newrelic/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

# New Relic output plugin
2020-05-28 02:24:49 +08:00
2020-05-28 02:52:21 +08:00
This plugins writes to New Relic Insights using the [Metrics API][].
To use this plugin you must first obtain an [Insights API Key][].
Telegraf minimum version: Telegraf 1.15.0
## Configuration
2020-05-28 02:52:21 +08:00
```toml
2020-05-28 02:24:49 +08:00
[[outputs.newrelic]]
## 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"
2020-05-28 02:24:49 +08:00
2020-05-28 02:52:21 +08:00
## Prefix to add to add to metric name for easy identification.
## This is very useful if your metric names are ambiguous.
2020-05-28 02:52:21 +08:00
# metric_prefix = ""
2020-05-28 02:24:49 +08:00
2020-05-28 02:52:21 +08:00
## Timeout for writes to the New Relic API.
# timeout = "15s"
## HTTP Proxy override. If unset use values from the standard
## proxy environment variables to determine proxy, if any.
# http_proxy = "http://corporate.proxy:3128"
## Metric URL override to enable geographic location endpoints.
# If not set use values from the standard
# metric_url = "https://metric-api.newrelic.com/metric/v1"
2020-05-28 02:24:49 +08:00
```
2020-05-28 02:52:21 +08:00
[Metrics API]: https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/metric-api/introduction-metric-api
[Insights API Key]: https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#user-api-key