com.influxdata.telegraf.plugins.inputs.TailInput1.4.0
- Module URI:
- package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@1.4.0#/plugins/inputs/TailInput.pklcontent_copy
- Pkl version:
- 0.25.0 or higher
- Source code:
- TailInput.pkl
- Known subtypes:
- Known usages:
- All versions:
- 1.4.0, 1.3.0, 1.2.1, 1.2.0, 1.1.1, 1.1.0, 1.0.1, 1.0.0
By default, the tail plugin acts like the following unix tail command:
tail -F --lines=0 myfile.log
-Fmeans that it will follow the name of the given file, so that it will be compatible with log-rotated files, and that it will retry on inaccessible files.--lines=0means that it will start at the end of the file (unless thefrom_beginningoption is set).
see http://man7.org/linux/man-pages/man1/tail.1.html for more details.
The plugin expects messages in one of the Telegraf Input Data Formats.
Properties(show inherited)
-
expand_morelinkhidden
The output of this module.
Defaults to all module properties rendered as either Pcf or the format specified on the command line.
-
expand_morelink
An array of glob pattern strings.
Only metrics whose measurement name matches a pattern in this list are emitted.
-
-
-
-
expand_morelink
An array of glob pattern strings.
Only fields whose field key matches a pattern in this list are emitted.
-
-
expand_morelink
An array of glob pattern strings.
Only tags with a tag key matching one of the patterns are emitted. In contrast to
tagpass, which will pass an entire metric based on its tag,tagincluderemoves all non matching tags from the metric. Any tag can be filtered including global tags and the agenthosttag. -
expand_morelink
The inverse of
taginclude.Tags with a tag key matching one of the patterns will be discarded from the metric. Any tag can be filtered including global tags and the agent
hosttag -
expand_morelink
How often to gather this metric.
Normal plugins use a single global interval, but if one particular input should be run less or more often, you can configure that here.
-
-
-
-
-
expand_morelink
File names or a pattern to tail.
These accept standard unix glob matching rules, but with the addition of
**as a "super asterisk":"/var/log/**.log": recursively find all .log files in /var/log"/var/log/*/*.log": find all .log files with a parent dir in /var/log"/var/log/apache.log": just tail the apache log file
See https://github.com/gobwas/glob for more examples.
-
-
-
-
-
expand_morelink
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.
Examples:
character_encoding = "utf-8" character_encoding = "utf-16le" character_encoding = "utf-16be" character_encoding = "" -
expand_morelink
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
Methods(show inherited)
-
-
-
-
-
-
-
-
-
expand_morelinkfunction
Returns the relative, descendent directory path between this module and
other.Throws if no such path exists.
For example, if module
mod1has path/dir1/mod1.pkl, and modulemod2has path/dir1/dir2/dir3/mod2.pkl, thenmod1.relativePathTo(mod2)will returnList("dir2", "dir3").A common use case is to compute the directory path between a template located at the root of a hierarchy (say
rootModule.pkl) and the currently evaluated module (accessible via themodulekeyword):import "rootModule.pkl" // self-import path = rootModule.relativePathTo(module)
The tail plugin "tails" a logfile and parses each log message.