Skip to content

Implement AUTO logging output #925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ekohl wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

Implement AUTO logging output #925

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a9b21e
Use casecmp?
ekohl Nov 12, 2025
017b3e4
Factor out appender creation
ekohl Nov 12, 2025
48fdd4f
Implement AUTO logging output
ekohl Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 48 additions & 19 deletions lib/proxy/log.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,39 +21,46 @@ class LoggerFactory
end

def self.logger
logger_name = 'foreman-proxy'
layout = Logging::Layouts.pattern(pattern: ::Proxy::SETTINGS.file_logging_pattern + "\n")
notime_layout = Logging::Layouts.pattern(pattern: ::Proxy::SETTINGS.system_logging_pattern + "\n")
logger = Logging.logger.root
if log_file.casecmp('STDOUT').zero?
logger.add_appenders(Logging.appenders.stdout(logger_name, layout: layout))
elsif log_file.casecmp('SYSLOG').zero?
if log_file.casecmp?('AUTO')
if ENV.key?('JOURNAL_STREAM')
# https://systemd.io/JOURNAL_NATIVE_PROTOCOL/#automatic-protocol-upgrading
# TODO: catch if unavailable
logger.add_appenders(appender(:journald))
elsif ENV.key?('LOGS_DIRECTORY')
# If LogsDirectory in systemd unit is provided
# TODO: does log_file respect LOGS_DIRECTORY?
# TODO: rolling file or expect logrotate?
logger.add_appenders(appender(:file))
elsif syslog_available?
logger.add_appenders(appender(:syslog))
else
logger.add_appenders(appender(:stdout))
end
elsif log_file.casecmp?('STDOUT')
logger.add_appenders(appender(:stdout))
elsif log_file.casecmp?('SYSLOG')
unless syslog_available?
puts "Syslog is not supported on this platform, use STDOUT or a file"
exit(1)
end
logger.add_appenders(Logging.appenders.syslog(
logger_name, layout: notime_layout, facility: ::Syslog::Constants::LOG_LOCAL5))
elsif log_file.casecmp('JOURNAL').zero? || log_file.casecmp('JOURNALD').zero?
logger.add_appenders(appender(:syslog))
elsif log_file.casecmp?('JOURNAL') || log_file.casecmp?('JOURNALD')
begin
logger.add_appenders(Logging.appenders.journald(
logger_name, logger_name: :proxy_logger, layout: notime_layout, facility: ::Syslog::Constants::LOG_LOCAL5))
logger.add_appenders(appender(:journald))
rescue NoMethodError
logger.add_appenders(Logging.appenders.stdout(logger_name, layout: layout))
logger.add_appenders(appender(:stdout))
logger.warn "Journald is not available on this platform. Falling back to STDOUT."
end
else
begin
keep = ::Proxy::SETTINGS.file_rolling_keep
size = BASE_LOG_SIZE * ::Proxy::SETTINGS.file_rolling_size
age = ::Proxy::SETTINGS.file_rolling_age
if size > 0
logger.add_appenders(Logging.appenders.rolling_file(logger_name, layout: layout, filename: log_file, keep: keep, size: size, age: age, roll_by: 'date'))
if ::Proxy::SETTINGS.file_rolling_size.to_i > 0
logger.add_appenders(appender(:rolling_file))
else
logger.add_appenders(Logging.appenders.file(logger_name, layout: layout, filename: log_file))
logger.add_appenders(appender(:file))
end
rescue ArgumentError => ae
logger.add_appenders(Logging.appenders.stdout(logger_name, layout: layout))
logger.add_appenders(appender(:stdout))
logger.warn "Log file #{log_file} cannot be opened. Falling back to STDOUT: #{ae}"
end
end
Expand All @@ -68,6 +75,28 @@ def self.syslog_available?
def self.log_file
@log_file ||= ::Proxy::SETTINGS.log_file
end

def self.appender(variant)
logger_name = 'foreman-proxy'
layout = Logging::Layouts.pattern(pattern: ::Proxy::SETTINGS.file_logging_pattern + "\n")
notime_layout = Logging::Layouts.pattern(pattern: ::Proxy::SETTINGS.system_logging_pattern + "\n")

case variant
when :stdout
Logging.appenders.stdout(logger_name, layout: layout)
when :syslog
Logging.appenders.syslog(logger_name, layout: notime_layout, facility: ::Syslog::Constants::LOG_LOCAL5)
when :journald
Logging.appenders.journald(logger_name, logger_name: :proxy_logger, layout: notime_layout, facility: ::Syslog::Constants::LOG_LOCAL5)
when :rolling_file
keep = ::Proxy::SETTINGS.file_rolling_keep
size = BASE_LOG_SIZE * ::Proxy::SETTINGS.file_rolling_size
age = ::Proxy::SETTINGS.file_rolling_age
Logging.appenders.rolling_file(logger_name, layout: layout, filename: log_file, keep: keep, size: size, age: age, roll_by: 'date')
when :file
Logging.appenders.file(logger_name, layout: layout, filename: log_file)
end
end
end

class LoggerMiddleware
Expand Down