Skip to main content

Logging

oryelle provides comprehensive logging capabilities to help you monitor and troubleshoot your deployment. The logging system generates two distinct log files:

  1. Security Log (security.log): Records security-related events and access attempts
  2. Combined Log (combined.log): Contains all log entries at or above the specified LOG_LEVEL

These log files will be written to the following directory in the container:

/var/log/backend/

To enable file-based logging, you must explicitly configure it in your docker-compose.yml file by setting the LOG_FILES environment variable to true. By default, logs are only written to stdout/stderr:

docker-compose.yml
services:
  . . .
  backend:
    container_name: backend
    image: ghcr.io/oryelle/oryelle-backend:latest
    environment:
      . . .
      - LOG_LEVEL=info # The log level to use for the combined log. Can be "error", "warn", "info" or "debug".
      - LOG_FILES=true # Tell oryelle to create log files
      . . .

After enabling file-based logging, you can access and analyze the log files in several ways:

  1. Direct File Access: Mount the /var/log/backend/ directory to your host system to directly access the log files
  2. Log Forwarding: Forward logs to your SIEM or log aggregation system using tools like Logstash
info

oryelle does not handle log rotation or archiving internally. To prevent log files from growing indefinitely and consuming disk space, you should configure log rotation on your host system.