files

Read from multiple files, in order of creation

Example

action:

files:
  path: /var/log/dpkg.*

Field NameDescriptionTypeDefault
patha path with wildcards identifying files to be readpath-
data_dirthe directory where checkpoints are writtenpaththe data directory for this user (e.g ~/.local/share/hotrod/PIPENAME on Linux)
encodingtext encodingencoding-
includeany other paths to be includedarray of path-
excludepaths to be excludedarray of path-
ignore-older-thanignore files older than this (epoch time in seconds)int-
timeoutpause after scanning for new filesint300ms
stop-reading-afterdo not wait for new filesboolfalse
ignore-line-breaksconsume each file as one eventboolfalse
remove-afterremove file after readingboolfalse
file-path-fieldfill this field with the field we are currently reading fromfield-
file-basenamethe file-path-field path will be the basename (e.g. '/path/frodo.txt' becomes just 'frodo')boolfalse
start-at-beginningignore stored checkpoints and re-read all specified filesboolfalse
rawboolfalse
max-line-sizewill not attempt to read lines longer than thisint1024b
max-read-sizewill not attempt to read files larger than thisint100Mb

path

a path with wildcards identifying files to be read

Type: path

data_dir

the directory where checkpoints are written

Type: path

encoding

text encoding

Type: encoding

include

any other paths to be included

Type: array of path

exclude

paths to be excluded

Type: array of path

ignore-older-than

ignore files older than this (epoch time in seconds)

Type: int

timeout

pause after scanning for new files

Type: int

stop-reading-after

do not wait for new files

Type: bool

ignore-line-breaks

consume each file as one event

Type: bool

remove-after

remove file after reading

Type: bool

file-path-field

fill this field with the field we are currently reading from

Type: field

file-basename

the file-path-field path will be the basename (e.g. '/path/frodo.txt' becomes just 'frodo')

Type: bool

start-at-beginning

ignore stored checkpoints and re-read all specified files

Type: bool

raw

???

Type: bool

max-line-size

will not attempt to read lines longer than this

Type: int

max-read-size

will not attempt to read files larger than this

Type: int