---
title: Telegraf Documentation
description: Telegraf plugin for sending metrics to CrateDB
url: https://docs.influxdata.com/telegraf/v1/output-plugins/cratedb/
estimated_tokens: 1859
product: Telegraf
version: v1
---

-   Telegraf v1.5.0+

# CrateDB Output Plugin

This plugin writes metrics to [CrateDB](https://crate.io/) via its [PostgreSQL protocol](https://crate.io/docs/crate/reference/protocols/postgres.html).

**Introduced in:** Telegraf v1.5.0 **Tags:** cloud, datastore **OS support:** all

## Table Schema

The plugin requires a table with the following schema.

```sql
CREATE TABLE IF NOT EXISTS my_metrics (
  "hash_id" LONG INDEX OFF,
  "timestamp" TIMESTAMP,
  "name" STRING,
  "tags" OBJECT(DYNAMIC),
  "fields" OBJECT(DYNAMIC),
  "day" TIMESTAMP GENERATED ALWAYS AS date_trunc('day', "timestamp"),
  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.

## Global configuration options

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.

## Startup error behavior options

In addition to the plugin-specific and global configuration settings the plugin supports options for specifying the behavior when experiencing startup errors using the `startup_error_behavior` setting. Available values are:

-   `error`: Telegraf with stop and exit in case of startup errors. This is the default behavior.
-   `ignore`: Telegraf will ignore startup errors for this plugin and disables it but continues processing for all other plugins.
-   `retry`: Telegraf will try to startup the plugin in every gather or write cycle in case of startup errors. The plugin is disabled until the startup succeeds.
-   `probe`: Telegraf will probe the plugin’s function (if possible) and disables the plugin in case probing fails. If the plugin does not support probing, Telegraf will behave as if `ignore` was set instead.

## Configuration

```toml
# Configuration for CrateDB to send metrics to.
[[outputs.cratedb]]
  ## Connection parameters for accessing the database see
  ##   https://pkg.go.dev/github.com/jackc/pgx/v5#ParseConfig
  ## for available options
  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 = false

  ## The character(s) to replace any '.' in an object key with
  # key_separator = "_"
```

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [CrateDB Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/outputs/cratedb/README.md)