Log Configuration

Gigantics allows you to configure the location where log files are stored. By default, logs are stored in a local ./logs/out.txt file, but you can customize this path to meet your system requirements.

Configuration File

Log directory configuration is done through the config/default.yaml file. Add or modify the logs property to change where log files are stored.

Windows Configuration

For Windows systems, specify the full path to your desired log directory:

# config/default.yaml
logs: 'C:\ProgramData\Gigantics\logs\out.txt'

You can also use relative paths or other Windows-specific locations:

# Examples for Windows
logs: '.\logs\out.txt'              # Relative path (default)
logs: 'C:\Logs\Gigantics\out.txt'  # Custom directory
logs: 'D:\AppData\logs\out.txt'    # Different drive

Linux Configuration

For Linux systems, specify the full path to your desired log directory:

# config/default.yaml
logs: '/var/log/gigantics/out.txt'

You can use any valid Linux path:

# Examples for Linux
logs: './logs/out.txt'              # Relative path (default)
logs: '/var/log/gigantics/out.txt'  # System log directory
logs: '/opt/gigantics/logs/out.txt' # Custom directory
logs: '/home/user/gigantics/logs/out.txt' # User directory

Job Log Retention

The logs of the jobs are kept in the database, and are deleted with their job. The jobLogRetentionDays property sets how many days they are kept at most, 90 by default. Set it to 0 to keep them until the job is deleted.

# config/default.yaml
jobLogRetentionDays: 30

The job logs don't include the values of the records: the errors returned by the drivers and the databases, and the reasons a job failed, are written with their values hidden, primary keys included, at every log level. A custom function can write them with log (see log): a shorter retention limits how long they stay.

Directory Permissions

Ensure that the user running the Gigantics application has write permissions to the specified log directory:

Windows: The user running gig.exe should have write access to the specified directory
Linux: The user running the application should have write access to the specified directory

Best Practices

Use dedicated log directories: Store logs in a dedicated directory like /var/log/gigantics on Linux or C:\ProgramData\Gigantics\logs on Windows
Ensure sufficient disk space: Log files can grow large over time, so choose a location with adequate storage
Set appropriate permissions: Make sure the log directory is secure and only accessible by authorized users
Use absolute paths: For production environments, use absolute paths to avoid ambiguity

Testing the Configuration

After modifying the configuration file, restart the Gigantics application to apply the changes. The application will automatically create the log file at the specified location if it doesn't exist.

On this page