logzio

README

Logz.io Output Plugin

This plugin writes metrics to the Logz.io service via HTTP.

⭐ Telegraf v1.17.0 🏷️ cloud, 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 token option. See the secret-store documentation for more details on how to use them.

Configuration

# A plugin that can send metrics over HTTPs to Logz.io
[[outputs.logzio]]
  ## Connection timeout, defaults to "5s" if not set.
  # timeout = "5s"

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

  ## Logz.io account token
  token = "your logz.io token" # required

  ## Use your listener URL for your Logz.io account region.
  # url = "https://listener.logz.io:8071"

Required parameters

Your Logz.io token, which can be found under "settings" in your account, is required.

Optional parameters

• check_disk_space: Set to true if Logz.io sender checks the disk space before adding metrics to the disk queue.
• disk_threshold: If the queue_dir space crosses this threshold (in % of disk usage), the plugin will start dropping logs.
• drain_duration: Time to sleep between sending attempts.
• queue_dir: Metrics disk path. All the unsent metrics are saved to the disk in this location.
• url: Logz.io listener URL.

Documentation

Index

• type Logzio
  • func (l *Logzio) Close() error
  • func (l *Logzio) Connect() error
  • func (*Logzio) SampleConfig() string
  • func (l *Logzio) Write(metrics []telegraf.Metric) error
• type Metric
• type TimeSeries

Types

type Logzio

type Logzio struct {
	URL     string          `toml:"url"`
	Token   config.Secret   `toml:"token"`
	Timeout config.Duration `toml:"timeout"`
	Log     telegraf.Logger `toml:"-"`

	tls.ClientConfig
	// contains filtered or unexported fields
}

func (*Logzio) Close

func (l *Logzio) Close() error

Close any connections to the Output

func (*Logzio) Connect

func (l *Logzio) Connect() error

Connect to the Output

func (*Logzio) SampleConfig

func (*Logzio) SampleConfig() string

func (*Logzio) Write

func (l *Logzio) Write(metrics []telegraf.Metric) error

Write takes in group of points to be written to the Output

type Metric

type Metric struct {
	Metric     map[string]interface{} `json:"metrics"`
	Dimensions map[string]string      `json:"dimensions"`
	Time       time.Time              `json:"@timestamp"`
	Type       string                 `json:"type"`
}

type TimeSeries

type TimeSeries struct {
	Series []*Metric
}