Log Files

Log Files (file)

Append events to one or more files.

File binary json raw

Minimal example

output:
  file:
    path: ~

JSON

{
  "output": {
    "file": {
      "path": null
    }
  }
}

Contents

• Minimal example

• Behavior

• Location

• Processing

• Reliability

• Schema

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Behavior

Behavior

Field	Type	Required	Description
compress-after ✓	boolean (bool)		Compress the written file after the filename changes. Default: false
create-directories ✓	boolean (bool)		Create parent directories for the given path if they do not exist. Default: false
file-per-event ✓	boolean (bool)		Each event is written out to a new file, overwriting if needed. Default: false
truncate ✓	boolean (bool)		Existing files are truncated before writing. Default: false

Location

Location

Field	Type	Required	Description
path	string	✅	Path to the file to be written. Can have ${} expansions.

Processing

Processing

Field	Type	Required	Description
batch	Batch		Batching input events together.
input-field	field (string)		Use the specified field as the content for the file line. Examples: data_field
flush-at-end ✓	boolean (bool)		Don’t flush after each event. Default: false

Reliability

Reliability

Field	Type	Required	Description
retry	Retry		Retry options.

Schema

• Batch Fields
• Retry - Backoff Fields
• Retry Fields
• Batch - Mode Options
• Retry - Backoff - Strategy Options

Batch Fields

Field	Type	Required	Description
fixed-size ✓	number (integer)		maximum number of events in an output batch. Examples: 42, 1.2e-10
max-bytes ✓	number (integer)		Close the batch before adding an event that would make the serialized request payload exceed this many bytes. Examples: 42, 1.2e-10
mode	Mode	✅	If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size. Allowed values: fixed, document
timeout	time-interval (string)	✅	interval after which the batch is sent, to keep throughput going (default 100ms). Default: 100ms Examples: 500ms, 2h
header	multiline-text (string)		put a header line before the batch.
footer	multiline-text (string)		put a header line after the last line of the batch.
use-document-marker ✓	boolean (bool)		Enrich the job metadata with a document marker (for document handling in batch mode). Default: false
wrap-as-json ✓	boolean (bool)		Format the output batch as a JSON array. Default: false

Retry - Backoff Fields

Field	Type	Required	Description
strategy	Strategy		Backoff strategy to use (default exponential). Allowed values: exponential, linear, fixed
base	string		Base delay before retrying (e.g. “200ms”).
max	string		Maximum delay between retries.
jitter ✓	boolean (bool)		Whether to add jitter to retry delays. Default: false

Retry Fields

Field	Type	Required	Description
max-attempts	number (integer)		Maximum attempts before giving up. Examples: 42, 1.2e-10
forever ✓	boolean (bool)		Retry indefinitely until cancelled. Default: false
backoff	Backoff		Backoff strategy configuration.

Batch - Mode Options

Value	Aliases	Name	Description
fixed		fixed
document		document

Retry - Backoff - Strategy Options

Value	Aliases	Name	Description
exponential		exponential
linear		linear
fixed		fixed