Skip to content

Logging

Access logs

The Document Reader Access logs are a gunicorn server Access log file.

To enable the Document Reader Access logs, set the ENV variable DOCREADER_LOGS_ACCESS_FILE to true.

You can customize the access log file location via the DOCREADER_LOGS_ACCESS_FILE_PATH ENV variable.

To get access to the Access log file from the host machine:

  1. Create a folder for logs and ensure the group is root and group members have the write & execute permissions over the created folder.
  2. Mount the host folder to the application log folder inside the container:
mkdir ~/docreader-logs
chmod g+wx ~/docreader-logs
sudo chgrp root ~/docreader-logs

docker run -p host_port:8080 -v host_path_to_license_folder/regula.license:/app/extBin/unix_x64/regula.license -v ~/docreader-logs:/app/logs -e DOCREADER_LOGS_ACCESS_FILE="true" regulaforensics/docreader

The Document Reader Access logs are a gunicorn server Access log file.

To enable the Document Reader Access logs, set the environment variable DOCREADER_LOGS_ACCESS_FILE to true at the /opt/regula/document-reader-webapi/.env file.

You сan customize the access log file location via the DOCREADER_LOGS_ACCESS_FILE_PATH environment variable.

Note that the application should have the write permission on the folder where logs will be stored.

Application logs

The Document Reader Application logs are a gunicorn server Application log file.

To enable the Document Reader Application logs, set the ENV variable DOCREADER_LOGS_APP_FILE to true. You may customize the application log file location via the DOCREADER_LOGS_APP_FILE_PATH ENV variable.

To get access to the Application log file from the host machine:

  1. Create a folder for logs and ensure the group is root and group members have the write & execute permissions over the created folder.
  2. Mount the host folder to the application log folder inside the container: 
    mkdir ~/docreader-logs
chmod g+wx ~/docreader-logs
sudo chgrp root ~/docreader-logs

docker run -p host_port:8080 -v host_path_to_license_folder/regula.license:/app/extBin/unix_x64/regula.license -v ~/docreader-logs:/app/logs -e DOCREADER_LOGS_APP_FILE="true" regulaforensics/docreader

The Document Reader Application logs are a gunicorn server Application log file.

To enable the Document Reader Application logs, set the environment variable DOCREADER_LOGS_APP_FILE to true at the /opt/regula/document-reader-webapi/.env file.

You can customize the application log file location via the DOCREADER_LOGS_APP_FILE_PATH environment variable.

Note that the application should have the write permission on the folder where logs will be stored.

Processed results logs

The Document Reader Processed results logs are the artifacts of the processed request.

To enable the processed results logs, set the ENV variable DOCREADER_PROCESS_RESULTS_LOG_FILE to true.

You can customize the processed results log folder path via the DOCREADER_PROCESS_RESULTS_LOG_PATH ENV variable.

To get access to the processed results logs from the host machine:

  1. Create a folder for logs and ensure the group is root and group members have the write & execute permissions over the created folder.
  2. Mount the host folder to the application log folder inside the container: 
    mkdir ~/docreader-logs
chmod g+wx ~/docreader-logs
sudo chgrp root ~/docreader-logs

docker run -p host_port:8080 -v host_path_to_license_folder/regula.license:/app/extBin/unix_x64/regula.license -v ~/docreader-logs:/app/logs -e DOCREADER_PROCESS_RESULTS_LOG_FILE="true" regulaforensics/docreader

The Document Reader Processed results logs are the artifacts of the processed request.

To enable the processed results logs, set the environment variable DOCREADER_PROCESS_RESULTS_LOG_FILE to true at the /opt/regula/document-reader-webapi/.env file.

You may customize the processed results log folder path via the DOCREADER_PROCESS_RESULTS_LOG_PATH environment variable.

Note that the application should have write permision on the folder where logs will be stored.