Configure the File output

The File output dumps the transactions into a file where each transaction is in a JSON format. Currently, this output is used for testing, but it can be used as input for Logstash.

To use this output, edit the Filebeat configuration file to disable the Elasticsearch output by commenting it out, and enable the file output by adding output.file.

Example configuration:

output.file:
  path: "/tmp/filebeat"
  filename: filebeat
  #rotate_every_kb: 10000
  #number_of_files: 7
  #permissions: 0600
  #rotate_on_startup: true

Configuration options

edit

You can specify the following output.file options in the filebeat.yml config file:

`enabled`

edit

The enabled config is a boolean setting to enable or disable the output. If set to false, the output is disabled.

The default value is true.

`path`

edit

The path to the directory where the generated files will be saved. This option is mandatory.

The path may include the timestamp when the file output is initialized using the +FORMAT syntax where FORMAT is a valid time format, and enclosed with expansion braces: %{+FORMAT}. For example:

path: 'fileoutput-%{+yyyy.MM.dd}'

`filename`

edit

The name of the generated files. The default is set to the Beat name. For example, the files generated by default for Filebeat would be "filebeat-{{datetime}}.ndjson", "filebeat-{{datetime}}-1.ndjson", "filebeat-{{datetime}}-2.ndjson", and so on.

`rotate_every_kb`

edit

The maximum size in kilobytes of each file. When this size is reached, the files are rotated. The default value is 10240 KB.

`number_of_files`

edit

The maximum number of files to save under path. When this number of files is reached, the oldest file is deleted, and the rest of the files are shifted from last to first. The number of files must be between 2 and 1024. The default is 7.

`permissions`

edit

Permissions to use for file creation. The default is 0600.

`rotate_on_startup`

edit

If the output file already exists on startup, immediately rotate it and start writing to a new file instead of appending to the existing one. Defaults to true.

`codec`

edit

Output codec configuration. If the codec section is missing, events will be json encoded.

See Change the output codec for more information.

« Configure the Redis output Configure the Console output »