file

README

File Output Plugin

This plugin writes telegraf metrics to files

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Send telegraf metrics to file(s)
[[outputs.file]]
  ## Files to write to, "stdout" is a specially handled file.
  files = ["stdout", "/tmp/metrics.out"]

  ## Use batch serialization format instead of line based delimiting.  The
  ## batch format allows for the production of non line based output formats and
  ## may more efficiently encode and write metrics.
  # use_batch_format = false

  ## The file will be rotated after the time interval specified.  When set
  ## to 0 no time based rotation is performed.
  # rotation_interval = "0h"

  ## The logfile will be rotated when it becomes larger than the specified
  ## size.  When set to 0 no size based rotation is performed.
  # rotation_max_size = "0MB"

  ## Maximum number of rotated archives to keep, any older logs are deleted.
  ## If set to -1, no archives are removed.
  # rotation_max_archives = 5

  ## Data format to output.
  ## Each data format has its own unique set of configuration options, read
  ## more about them here:
  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
  data_format = "influx"

  ## Compress output data with the specified algorithm.
  ## If empty, compression will be disabled and files will be plain text.
  ## Supported algorithms are "zstd", "gzip" and "zlib".
  # compression_algorithm = ""

  ## Compression level for the algorithm above.
  ## Please note that different algorithms support different levels:
  ##   zstd  -- supports levels 1, 3, 7 and 11.
  ##   gzip -- supports levels 0, 1 and 9.
  ##   zlib -- supports levels 0, 1, and 9.
  ## By default the default compression level for each algorithm is used.
  # compression_level = -1

Documentation

Index

• type File
  • func (f *File) Close() error
  • func (f *File) Connect() error
  • func (f *File) Init() error
  • func (*File) SampleConfig() string
  • func (f *File) SetSerializer(serializer serializers.Serializer)
  • func (f *File) Write(metrics []telegraf.Metric) error

Types

type File

type File struct {
	Files                []string        `toml:"files"`
	RotationInterval     config.Duration `toml:"rotation_interval"`
	RotationMaxSize      config.Size     `toml:"rotation_max_size"`
	RotationMaxArchives  int             `toml:"rotation_max_archives"`
	UseBatchFormat       bool            `toml:"use_batch_format"`
	CompressionAlgorithm string          `toml:"compression_algorithm"`
	CompressionLevel     int             `toml:"compression_level"`
	Log                  telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func (*File) Close

func (f *File) Close() error

func (*File) Connect

func (f *File) Connect() error

func (*File) Init

func (f *File) Init() error

func (*File) SampleConfig

func (*File) SampleConfig() string

func (*File) SetSerializer

func (f *File) SetSerializer(serializer serializers.Serializer)

func (*File) Write

func (f *File) Write(metrics []telegraf.Metric) error