Configure Logging

  • Updated on Dec 19, 2025
  • Published on Dec 19, 2025
Prev Next

Configure logging settings for Itential Platform, Integrations, and Adapters through Admin Essentials.

Before you begin

  • Verify your Platform version: Admin Essentials > About
  • Review your organization's log retention policies

Version support

Feature Platform 6.2+ Platform 6.0, 6.1 Platform 2023.2 Platform 2023.1 and earlier
Configuration via Logging page ✓ ✓ ✗ ✗
Configuration via Profiles page ✗ ✗ ✓ ✓
Structured JSON logging ✓ ✗ ✓ ✗

Set global logging

Changes require a Platform restart.

Platform 6

  1. Navigate to Admin Essentials from the homepage.
  2. Select Configuration > Logging.
  3. Configure settings (see Configuration parameters).
  4. Click Save (disk icon).
  5. Restart Itential Platform.

Platform 2023.2 and earlier

  1. Navigate to Admin Essentials from the homepage.
  2. Expand Profiles and select the active profile (for example, profile1).
  3. Click the Configure tab.
  4. Select loggerProps from the property list.
  5. Configure settings (see Configuration parameters).
  6. Click Save (disk icon).
  7. Restart Itential Platform.

Configuration parameters

Log level and output

Control the minimum severity level for logs written to files and console output.

Parameter Description Default
log_level Minimum severity level for file logging. Each level includes higher-severity levels. Higher verbosity increases log volume and may impact performance. See Log Levels Reference. debug
console_level Minimum severity level for console output (stdout/stderr). Appears in container logs and terminal output. warn

Set log and console level

Choose log and console levels based on your deployment scenario and logging infrastructure.

Scenario log_level console_level Rationale
Production with log aggregation info warn Detailed file logs, only important console output
Production without log aggregation warn warn Minimize storage, match console
Development/debugging debug debug Maximum visibility
Container orchestration (logs go to stdout) info info Console is the log destination

Log format

Configure output format for logs. Structured JSON format enables automated parsing by log aggregation tools.

Parameter Description Default Available
log_format_json Enables structured JSON logging with separate, queryable fields. false Platform 2023.2, 6.2+
console_format_json Formats console output as structured JSON. Enable when container orchestration systems forward console logs to centralized logging. false Platform 2023.2, 6.2+
syslog_format_json Formats syslog output as structured JSON. false Platform 2023.2, 6.2+

Log file management

Configure log file location, naming, and rotation behavior.

Parameter Description Default
log_directory Absolute path where Platform writes log files. Directory must exist with write permissions and sufficient disk space. /var/log/pronghorn
log_filename Primary log file name. Rotated files append numeric suffixes. pronghorn.log
log_max_file_size Maximum log file size in bytes before rotation. 10485760 (10 MB)
log_max_files Number of rotated files to retain. Total disk usage ≈ log_max_file_size × log_max_files 100

Production recommendation: Set log_max_file_size to 52428800 (50 MB) and log_max_files to 50.

Timestamps

Configure the timezone for log timestamps.

Parameter Description Default
log_timezone_offset UTC offset in hours for log timestamps. For example, -5 for EST or -8 for PST. 0 (UTC)

Enable structured JSON logging

Requirements: Platform 2023.2 or Platform 6.2+

  1. Navigate to Admin Essentials > Configuration > Logging.
  2. Set log_format_json to true.
  3. Set log_level to info.
  4. Click Save.
  5. Restart Itential Platform.

Existing multi-argument log calls automatically convert to the structured JSON format at runtime. You don't need to update existing logging code immediately.

Configure component-specific logging

Override global settings for individual Adapters or Applications without restarting Platform.

  1. Navigate to Admin Essentials.
  2. Select Applications or Adapters.
  3. Select the component.
  4. Click the Logging tab.
  5. Set log levels:
    • File Log level - Minimum severity for file logging
    • Console Log level - Minimum severity for console output
  6. Click Save.

Changes apply immediately. Component reverts to global settings after Platform restart.

Example logging configurations

New deployments (Platform 2023.2, 6.2+)

Recommended for production environments with log aggregation tools.

{
  "log_level": "info",
  "console_level": "warn",
  "log_format_json": true,
  "log_max_file_size": 52428800,
  "log_max_files": 50
}

Development environments (Platform 2023.2, 6.2+)

Provides detailed diagnostic output. Not recommended for production.

{
  "log_level": "debug",
  "console_level": "debug",
  "log_format_json": true,
  "log_max_file_size": 10485760,
  "log_max_files": 10
}

Platform 2023.1 and earlier

For environments without structured log parsing.

{
  "log_level": "info",
  "console_level": "warn",
  "log_max_file_size": 52428800,
  "log_max_files": 50
}

Next steps