Telegraf: Documentation feedback on /docs/integrate/telegraf/ #243
Description
Documentation feedback
- Page title: Telegraf
- Page URL: https://cratedb.com/docs/guide/integrate/telegraf/index.html
- Page URL: https://cratedb.com/blog/use-cratedb-with-telegraf-an-agent-for-collecting-reporting-metrics
- Source: https://github.com/crate/cratedb-guide/blob/main/docs/integrate/telegraf/index.md
Problem
Other than the resources listed above, we don't show much about how to integrate with Telegraf well, and also on the tutorial, the main gist is obfuscated in favor of a full tutorial that also includes Grafana.
Solution
Full-stack / end-to-end examples are nice, but let's have a dedicated page as a another main stage for this purpose, where the focus is on the integration of CrateDB with Telegraf itself, in order to highlight the CrateDB output plugin.
- Docs: https://docs.influxdata.com/telegraf/v1/plugins/#output-cratedb
- README: https://github.com/influxdata/telegraf/blob/release-1.35/plugins/outputs/cratedb/README.md
- Patch: CrateDB output plugin influxdata/telegraf#3210
The core gist seems to be this configuration snippet:
# Configuration for CrateDB to send metrics to.
[[outputs.cratedb]]
# A github.com/jackc/pgx/v4 connection string.
# See https://pkg.go.dev/github.com/jackc/pgx/v4#ParseConfig
url = "postgres://crate@localhost/doc?sslmode=disable"
# Timeout for all CrateDB queries.
timeout = "5s"
# Name of the table to store metrics in.
table = "metrics"
# If true, and the metrics table does not exist, create it automatically.
table_create = true
# The character(s) to replace any '.' in an object key with
key_separator = "_"