file

README

File Input Plugin

This plugin reads the complete contents of the configured files in every interval. The file content is split line-wise and parsed according to one of the supported data formats.

[!TIP] If you wish to only process newly appended lines use the tail input plugin instead.

⭐ Telegraf v1.8.0 🏷️ system 💻 all

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

# Parse a complete file each interval
[[inputs.file]]
  ## Files to parse each interval.  Accept standard unix glob matching rules,
  ## as well as ** to match recursive files and directories.
  files = ["/tmp/metrics.out"]

  ## Character encoding to use when interpreting the file contents.  Invalid
  ## characters are replaced using the unicode replacement character.  When set
  ## to the empty string the data is not decoded to text.
  ##   ex: character_encoding = "utf-8"
  ##       character_encoding = "utf-16le"
  ##       character_encoding = "utf-16be"
  ##       character_encoding = ""
  # character_encoding = ""

  ## Data format to consume.
  ## 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_INPUT.md
  data_format = "influx"

  ## Please use caution when using the following options: when file name
  ## variation is high, this can increase the cardinality significantly. Read
  ## more about cardinality here:
  ## https://docs.influxdata.com/influxdb/cloud/reference/glossary/#series-cardinality

  ## Name of tag to store the name of the file. Disabled if not set.
  # file_tag = ""

  ## Name of tag to store the absolute path and name of the file. Disabled if
  ## not set.
  # file_path_tag = ""

Metrics

The format of metrics produced by this plugin depends on the content and data format of the file.

Example Output

Documentation

Index

• type File
  • func (f *File) Gather(acc telegraf.Accumulator) error
  • func (f *File) Init() error
  • func (*File) SampleConfig() string
  • func (f *File) SetParserFunc(fn telegraf.ParserFunc)

Types

type File

type File struct {
	Files             []string        `toml:"files"`
	FileTag           string          `toml:"file_tag"`
	FilePathTag       string          `toml:"file_path_tag"`
	CharacterEncoding string          `toml:"character_encoding"`
	Log               telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func (*File) Gather

func (f *File) Gather(acc telegraf.Accumulator) error

func (*File) Init

func (f *File) Init() error

func (*File) SampleConfig

func (*File) SampleConfig() string

func (*File) SetParserFunc

func (f *File) SetParserFunc(fn telegraf.ParserFunc)