Dynatrace Plugin - Updated Documentation (#7994)

This commit is contained in:
Thomas Schuetz 2020-08-18 00:37:13 +02:00 committed by GitHub
parent ea1d4d4ab0
commit 6e8255c644
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 11 deletions

View File

@ -410,6 +410,7 @@ For documentation on the latest development code see the [documentation index][d
* [cratedb](./plugins/outputs/cratedb)
* [datadog](./plugins/outputs/datadog)
* [discard](./plugins/outputs/discard)
* [dynatrace](./plugins/outputs/dynatrace)
* [elasticsearch](./plugins/outputs/elasticsearch)
* [exec](./plugins/outputs/exec)
* [execd](./plugins/outputs/execd)

View File

@ -1,24 +1,43 @@
# Dynatrace Output Plugin
This plugin writes telegraf metrics to a Dynatrace environment.
This plugin is sending telegraf metrics to [Dynatrace](www.dynatrace.com). It has two operational modes.
An API token is necessary, which can be obtained in your Dynatrace environment. Navigate to **Dynatrace > Settings > Integration > Dynatrace API** and create a new token with
'Data ingest' access scope enabled.
## Running alongside Dynatrace OneAgent
Telegraf measurements which can't be converted to a float64 are skipped.
if you run the Telegraf agent on a host or VM that is monitored by the Dynatrace OneAgent then you only need to enable the plugin but need no further configuration. The Dynatrace telegraf output plugin will send all metrics to the OneAgent which will use its secure and load balanced connection to send the metrics to your Dynatrace SaaS or Managed environment.
Metrics fields are added to the measurement name by using '.' in the metric name.
## Running standalone
### Configuration
If you run the Telegraf agent on a host or VM without a OneAgent you will need to configure the environment API endpoint to send the metrics to and an API token for security.
The endpoint for the Dynatrace Metrics API is
* Managed https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest
* SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/ingest
You can learn more about how to use the Dynatrace API [here](https://www.dynatrace.com/support/help/dynatrace-api/)
You will also need to configure an API token for secure access. Find out how to create a token [here](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/tokens/) or simply navigate to **Settings > Integration > Dynatrace API** in your Dynatrace environment and create a token with Dynatrace API and create a new token with
'Ingest metrics data points' access scope enabled.
## Configuration
```toml
[[outputs.dynatrace]]
## Dynatrace environment URL (e.g.: https://YOUR_DOMAIN/api/v2/metrics/ingest) or use the local ingest endpoint of your OneAgent monitored host (e.g.: http://127.0.0.1:14499/metrics/ingest).
environmentURL = ""
environmentApiToken = ""
## Leave empty or use the local ingest endpoint of your OneAgent monitored host (e.g.: http://127.0.0.1:14499/metrics/ingest).
## Set Dynatrace environment URL (e.g.: https://YOUR_DOMAIN/api/v2/metrics/ingest) if you do not use a OneAgent
url = ""
api_token = ""
## Optional prefix for metric names (e.g.: "telegraf.")
prefix = "telegraf."
## Flag for skipping the tls certificate check, just for testing purposes, should be false by default
skipCertificateCheck = false
insecure_skip_verify = false
```
```
## Requirements
This plugin requires Dynatrace version 1.202 or higher. You will either need a Dynatrace OneAgent (version 1.201 or higher) installed on the same host as Telegraf; or a Dynatrace environment with version 1.202 or higher
## Limitations
Telegraf measurements which can't be converted to a float64 are skipped.