History

Sebastian Spaink d67f75e557 docs: Remove warning not to remove go:embed (#11797 ) Co-authored-by: Joshua Powers <powersj@fastmail.com>		2022-09-13 12:47:58 -05:00
..
README.md	chore: embed sample configurations into README for outputs (#11182 )	2022-05-25 08:48:59 -06:00
cratedb.go	docs: Remove warning not to remove go:embed (#11797 )	2022-09-13 12:47:58 -05:00
cratedb_test.go	test: enable logging with testcontainers (#11211 )	2022-06-01 07:42:46 -06:00
sample.conf	chore(outputs): migrate sample configs into separate files (#11131 )	2022-05-18 11:30:06 -05:00

README.md

CrateDB Output Plugin

This plugin writes to CrateDB via its PostgreSQL protocol.

Table Schema

The plugin requires a table with the following schema.

CREATE TABLE my_metrics (
  "hash_id" LONG INDEX OFF,
  "timestamp" TIMESTAMP,
  "name" STRING,
  "tags" OBJECT(DYNAMIC),
  "fields" OBJECT(DYNAMIC),
  PRIMARY KEY ("timestamp", "hash_id","day")
) PARTITIONED BY("day");

The plugin can create this table for you automatically via the table_create config option, see below.

Configuration

# 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://user:password@localhost/schema?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 = "_"