arc

README

Arc Output Plugin

This plugin writes metrics to Arc, a high-performance time-series database, via MessagePack binary protocol messages providing a 3-5x better performance than the line-protocol format.

⭐ Telegraf v1.37.0 🏷️ datastore 💻 all

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 for more details.

Configuration

# Arc Time-Series Database Output Plugin
[[outputs.arc]]
  ## Arc MessagePack API URL
  url = "http://localhost:8000/api/v1/write/msgpack"

  ## API Key for authentication (required, auth is enabled by default)
  api_key = ""

  ## Database name for multi-database architecture
  ## Defaults to the server configured DB if not specified or empty
  # database = ""

  ## Content encoding for request body
  ## Options: "gzip" (default), "identity"
  # content_encoding = "gzip"

  ## Timeout for HTTP writes
  # timeout = "5s"

  ## Additional HTTP headers
  # [outputs.arc.headers]
  #   X-Custom-Header = "custom-value"

Troubleshooting

For authentication issues, ensure you have generated a valid API key with write permissions. See the Arc documentation for details on authentication and configuration.

For connection or performance issues, check that Arc is running and accessible, and review the Telegraf debug logs.

Documentation

Index

• type Arc
  • func (a *Arc) Close() error
  • func (a *Arc) Connect() error
  • func (a *Arc) Init() error
  • func (*Arc) SampleConfig() string
  • func (a *Arc) Write(metrics []telegraf.Metric) error

Types

type Arc

type Arc struct {
	URL             string            `toml:"url"`
	APIKey          config.Secret     `toml:"api_key"`
	Database        string            `toml:"database"`
	Headers         map[string]string `toml:"headers"`
	ContentEncoding string            `toml:"content_encoding"`
	Log             telegraf.Logger   `toml:"-"`
	common_http.HTTPClientConfig
	// contains filtered or unexported fields
}

func (*Arc) Close

func (a *Arc) Close() error

func (*Arc) Connect

func (a *Arc) Connect() error

func (*Arc) Init

func (a *Arc) Init() error

func (*Arc) SampleConfig

func (*Arc) SampleConfig() string

func (*Arc) Write

func (a *Arc) Write(metrics []telegraf.Metric) error