redistimeseries

package
v1.39.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2026 License: MIT Imports: 12 Imported by: 1

README

Redis Time Series Output Plugin

This plugin writes metrics to a Redis time-series server.

⭐ Telegraf v1.0.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.

Secret store support

This plugin supports secrets from secret stores for the username and password option. See the secret store documentation for more details on how to use them.

Configuration

# Publishes metrics to a redis timeseries server
[[outputs.redistimeseries]]
  ## The address of the RedisTimeSeries server.
  address = "127.0.0.1:6379"

  ## Redis ACL credentials
  # username = ""
  # password = ""
  # database = 0

  ## Timeout for operations such as ping or sending metrics
  # timeout = "10s"

  ## Set a time-to-live (TTL) on each Redis key
  ## If set, Redis will expire the key after the specified duration
  ## The TTL is refreshed on every write, so the key only expires
  ## if no new data arrives within the configured period
  ## Disabled by default (no expiry)
  # expire = ""

  ## Enable attempt to convert string fields to numeric values
  ## If "false" or in case the string value cannot be converted the string
  ## field will be dropped.
  # convert_string_fields = true

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  # insecure_skip_verify = false

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RedisTimeSeries

type RedisTimeSeries struct {
	Address             string           `toml:"address"`
	Username            config.Secret    `toml:"username"`
	Password            config.Secret    `toml:"password"`
	Database            int              `toml:"database"`
	ConvertStringFields bool             `toml:"convert_string_fields"`
	Timeout             config.Duration  `toml:"timeout"`
	Expire              *config.Duration `toml:"expire"`
	Log                 telegraf.Logger  `toml:"-"`
	tls.ClientConfig
	// contains filtered or unexported fields
}

func (*RedisTimeSeries) Close

func (r *RedisTimeSeries) Close() error

func (*RedisTimeSeries) Connect

func (r *RedisTimeSeries) Connect() error

func (*RedisTimeSeries) Description

func (*RedisTimeSeries) Description() string

func (*RedisTimeSeries) Init added in v1.38.0

func (r *RedisTimeSeries) Init() error

func (*RedisTimeSeries) SampleConfig

func (*RedisTimeSeries) SampleConfig() string

func (*RedisTimeSeries) Write

func (r *RedisTimeSeries) Write(metrics []telegraf.Metric) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL