cratedb

README

CrateDB Output Plugin for Telegraf

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 = "_"

Documentation

Index

• Constants
• type CrateDB
  • func (c *CrateDB) Close() error
  • func (c *CrateDB) Connect() error
  • func (c *CrateDB) Description() string
  • func (c *CrateDB) SampleConfig() string
  • func (c *CrateDB) Write(metrics []telegraf.Metric) error

Constants

const MaxInt64 = int64(^uint64(0) >> 1)

Types

type CrateDB

type CrateDB struct {
	URL          string
	Timeout      config.Duration
	Table        string
	TableCreate  bool   `toml:"table_create"`
	KeySeparator string `toml:"key_separator"`
	DB           *sql.DB
}

func (*CrateDB) Close

func (c *CrateDB) Close() error

func (*CrateDB) Connect

func (c *CrateDB) Connect() error

func (*CrateDB) Description

func (c *CrateDB) Description() string

func (*CrateDB) SampleConfig

func (c *CrateDB) SampleConfig() string

func (*CrateDB) Write

func (c *CrateDB) Write(metrics []telegraf.Metric) error