Skip to content

Commit c7b771e

Browse files
committed
Integrate/Telegraf: Add synopsis to index page
1 parent f31ac33 commit c7b771e

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/integrate/telegraf/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,32 @@ a very minimal memory footprint.
4343
::::
4444

4545

46+
:::{rubric} Synopsis
47+
:::
48+
49+
Telegraf output plugin configuration snippet for CrateDB.
50+
```toml
51+
# Configuration for CrateDB to send metrics to.
52+
[[outputs.cratedb]]
53+
54+
# A github.com/jackc/pgx/v4 connection string.
55+
# See https://pkg.go.dev/github.com/jackc/pgx/v4#ParseConfig
56+
url = "postgres://crate@localhost/doc?sslmode=disable"
57+
58+
# Timeout for all CrateDB queries.
59+
timeout = "5s"
60+
61+
# Name of the table to store metrics in.
62+
table = "metrics"
63+
64+
# If true, and the metrics table does not exist, create it automatically.
65+
table_create = true
66+
67+
# The character(s) to replace any '.' in an object key with
68+
key_separator = "_"
69+
```
70+
71+
4672
:::{rubric} Learn
4773
:::
4874

0 commit comments

Comments
 (0)