CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(outputs.opensearch): Correct sample config format (#14538)

This commit is contained in:
Sander van de Geijn 2024-01-09 23:00:16 +01:00 committed by GitHub
parent db8552a140
commit 744e74d463
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
plugins/outputs/opensearch/README.md
View File

@ -19,7 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Configuration for OpenSearch to send metrics to. # Configuration for OpenSearch to send metrics to.
[[outputs.OpenSearch]] [[outputs.opensearch]]
## URLs ## URLs
## The full HTTP endpoint URL for your OpenSearch instance. Multiple URLs can ## The full HTTP endpoint URL for your OpenSearch instance. Multiple URLs can
## be specified as part of the same cluster, but only one URLs is used to ## be specified as part of the same cluster, but only one URLs is used to
@ -33,7 +33,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
## metric name (`{{.Name}}`), tag value (`{{.Tag "tag_name"}}`), field value (`{{.Field "field_name"}}`) ## metric name (`{{.Name}}`), tag value (`{{.Tag "tag_name"}}`), field value (`{{.Field "field_name"}}`)
## If the tag does not exist, the default tag value will be empty string "". ## If the tag does not exist, the default tag value will be empty string "".
## the timestamp (`{{.Time.Format "xxxxxxxxx"}}`). ## the timestamp (`{{.Time.Format "xxxxxxxxx"}}`).
## For example: "telegraf-{{.Time.Format "2006-01-02"}}-{{.Tag "host"}}" would set it to telegraf-2023-07-27-HostName ## For example: "telegraf-{{.Time.Format \"2006-01-02\"}}-{{.Tag \"host\"}}" would set it to telegraf-2023-07-27-HostName
index_name = "" index_name = ""
## Timeout ## Timeout
@ -127,9 +127,10 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
OpenSearch instance. OpenSearch instance.
* `index_name`: The target index for metrics. You can use the date format * `index_name`: The target index for metrics. You can use the date format
For example: "telegraf-{{.Time.Format "2006-01-02"}}" would set it to For example: "telegraf-{{.Time.Format \"2006-01-02\"}}" would set it to
"telegraf-2023-07-27". You can also specify metric name (`{{ .Name }}`), tag "telegraf-2023-07-27". You can also specify metric name (`{{ .Name }}`), tag
value (`{{ .Tag "tag_name" }}`), and field value (`{{ .Field "field_name" }}`). value (`{{ .Tag \"tag_name\" }}`), and field value
(`{{ .Field \"field_name\" }}`).
If the tag does not exist, the default tag value will be empty string "" If the tag does not exist, the default tag value will be empty string ""

4
plugins/outputs/opensearch/sample.conf
View File

@ -1,5 +1,5 @@
# Configuration for OpenSearch to send metrics to. # Configuration for OpenSearch to send metrics to.
[[outputs.OpenSearch]] [[outputs.opensearch]]
## URLs ## URLs
## The full HTTP endpoint URL for your OpenSearch instance. Multiple URLs can ## The full HTTP endpoint URL for your OpenSearch instance. Multiple URLs can
## be specified as part of the same cluster, but only one URLs is used to ## be specified as part of the same cluster, but only one URLs is used to
@ -13,7 +13,7 @@
## metric name (`{{.Name}}`), tag value (`{{.Tag "tag_name"}}`), field value (`{{.Field "field_name"}}`) ## metric name (`{{.Name}}`), tag value (`{{.Tag "tag_name"}}`), field value (`{{.Field "field_name"}}`)
## If the tag does not exist, the default tag value will be empty string "". ## If the tag does not exist, the default tag value will be empty string "".
## the timestamp (`{{.Time.Format "xxxxxxxxx"}}`). ## the timestamp (`{{.Time.Format "xxxxxxxxx"}}`).
## For example: "telegraf-{{.Time.Format "2006-01-02"}}-{{.Tag "host"}}" would set it to telegraf-2023-07-27-HostName ## For example: "telegraf-{{.Time.Format \"2006-01-02\"}}-{{.Tag \"host\"}}" would set it to telegraf-2023-07-27-HostName
index_name = "" index_name = ""
## Timeout ## Timeout