docs(outputs.elasticsearch): detail overriding timezone (#12551)

This commit is contained in:
Ben Tasker 2023-01-25 20:16:55 +00:00 committed by GitHub
parent c030e31aed
commit bd77a425ba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions

View File

@ -156,6 +156,34 @@ This plugin will format the events in the following way:
}
```
### Timestamp Timezone
Elasticsearch documents use RFC3339 timestamps, which include timezone
information (for example `2017-01-01T00:00:00-08:00`). By default, the Telegraf
system's configured timezone will be used.
However, this may not always be desirable: Elasticsearch preserves timezone
information and includes it when returning associated documents. This can cause
issues for some pipelines. In particular, those that do not parse retrieved
timestamps and instead assume that the timezone returned will always be
consistent.
Telegraf honours the timezone configured in the environment variable `TZ`, so
the timezone sent to Elasticsearch can be amended without needing to change the
timezone configured in the host system:
```sh
export TZ="America/Los_Angeles"
export TZ="UTC"
```
If Telegraf is being run as a system service, this can be configured in the
following way on Linux:
```sh
echo TZ="UTC" | sudo tee -a /etc/default/telegraf
```
## OpenSearch Support
OpenSearch is a fork of Elasticsearch hosted by AWS. The OpenSearch server will