Configure the File output
editConfigure the File output
editThis documentation refers to configuring the standalone (legacy) APM Server. This method of running APM Server will be deprecated and removed in a future release. Please consider upgrading to Fleet and the APM integration.
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 APM Server 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/apm-server" filename: apm-server #rotate_every_kb: 10000 #number_of_files: 7 #permissions: 0600
Configuration options
editYou can specify the following output.file options in the apm-server.yml config file:
enabled
editThe 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
editThe path to the directory where the generated files will be saved. This option is mandatory.
filename
editThe name of the generated files. The default is set to the Beat name. For example, the files generated by default for APM Server would be "apm-server", "apm-server.1", "apm-server.2", and so on.
rotate_every_kb
editThe 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
editThe 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
editPermissions to use for file creation. The default is 0600.
codec
editOutput codec configuration. If the codec section is missing, events will be json encoded.
See Change the output codec for more information.