logzio

README

Logz.io Output Plugin

This plugin sends metrics to Logz.io over HTTPs.

Configuration:

# A plugin that can send metrics over HTTPs to Logz.io
[[outputs.logzio]]
  ## Set to true if Logz.io sender checks the disk space before adding metrics to the disk queue.
  # check_disk_space = true

  ## The percent of used file system space at which the sender will stop queueing.
  ## When we will reach that percentage, the file system in which the queue is stored will drop
  ## all new logs until the percentage of used space drops below that threshold.
  # disk_threshold = 98

  ## How often Logz.io sender should drain the queue.
  ## Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
  # drain_duration = "3s"

  ## Where Logz.io sender should store the queue
  ## queue_dir = Sprintf("%s%s%s%s%d", os.TempDir(), string(os.PathSeparator),
  ##                     "logzio-buffer", string(os.PathSeparator), time.Now().UnixNano())

  ## 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:

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

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 (l *Logzio) Description() string
  • func (l *Logzio) SampleConfig() string
  • func (l *Logzio) Write(metrics []telegraf.Metric) error
• type Metric
• type TimeSeries

Types

type Logzio

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

	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) Description

func (l *Logzio) Description() string

Description returns a one-sentence description on the Output

func (*Logzio) SampleConfig

func (l *Logzio) SampleConfig() string

SampleConfig returns the default configuration of the Output

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
}