dump_folder
The `dump_folder` directive specifies the directory where debugging information or output files are stored for the Kaltura Media Framework.
Description
The dump_folder directive in the Kaltura Media Framework Common NGINX Module allows the user to define a directory path where all debug dumps and logs generated during the execution of the media processing tasks are written to. This directory serves as a central location for temporary files that can aid in debugging and troubleshooting issues related to media processing.
When the directive is configured, the framework will automatically create files within the specified folder, capturing state or output at various points in the processing pipeline. This can include raw media data, JSON formatted logs, or transient debugging information that developers can utilize for in-depth analysis of the media processing stack. The path to the dump folder must be specified in the configuration and should have appropriate write permissions set for the NGINX user to avoid permission errors during runtime.
Using this directive effectively requires attention to the storage requirements, as the data preserved in this folder could grow unexpectedly large depending on the volume and complexity of the media being processed. Hence, it’s generally advised to monitor this directory and implement a cleanup strategy or limit retention to manageable sizes to avoid consuming excessive disk space.
Config Example
dump_folder /var/log/nginx/kaltura_dumps;
Ensure that the directory specified has the proper permissions set for the NGINX process to write files.
Monitor disk space in the dump folder to avoid running out of storage due to excessive logging.
The path argument must be a valid path; otherwise, NGINX may fail to start or reload.