Log Files

Log Files (file)

Append events to one or more files.

Contents

• Fields

Fields

Field	Type	Required	Description
batch	Batch		Batching input events together.
retry	Retry		Retry options.
path	string	✅	Path to the file to be written. Can have ${} expansions.
input-field	event-field (string)		Use the specified field as the content for the file line.
compress-after	boolean (bool)		Compress the written file after the filename changes.
create-directories	boolean (bool)		Create parent directories for the given path if they do not exist.
file-per-event	boolean (bool)		Each event is written out to a new file, overwriting if needed.
truncate	boolean (bool)		Existing files are truncated before writing.
flush-at-end	boolean (bool)		Don’t flush after each event.

Batch Fields

Field	Type	Required	Description
fixed-size	integer		maximum number of events in an output batch.
mode	symbol	✅	If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.
timeout	string	✅	interval after which the batch is sent, to keep throughput going (default 100ms).
header	string		put a header line before the batch.
footer	string		put a header line after the last line of the batch.
use-document-marker	bool		Enrich the job metadata with a document marker (for document handling in batch mode).
wrap-as-json	bool		Format the output batch as a JSON array.

Retry Fields

Field	Type	Required	Description
count	integer		The number of retry attempts. If unspecified, retries will continue indefinitely.
pause	string		How long to pause before re-trying.