2.5. Debugging and Logging¶

You can set EDUMFA_LOGLEVEL to a value 10 (Debug), 20 (Info), 30 (Warning), 40 (Error) or 50 (Critical). If you experience problems, set EDUMFA_LOGLEVEL = 10 restart the web service and resume the operation. The log file eduMFA.log should contain some clues.

You can define the location of the logfile using the key EDUMFA_LOGFILE. Usually it is set to:

EDUMFA_LOGFILE = "/var/log/edumfa/edumfa.log"

2.5.1. Advanced Logging¶

You can also define a more detailed logging by specifying a log configuration file. By default the file is /etc/edumfa/logging.cfg.

You can change the location of the logging configuration file in The Config File like this:

EDUMFA_LOGCONFIG = "/path/to/logging.yml"

The logging configuration can be written in YAML [1]. Such a YAML based configuration could look like this:

version: 1
formatters:
  detail:
    class: edumfa.lib.log.SecureFormatter
    format: '[%(asctime)s][%(process)d][%(thread)d][%(levelname)s][%(name)s:%(lineno)d] %(message)s'

handlers:
  mail:
    class: logging.handlers.SMTPHandler
    mailhost: mail.example.com
    fromaddr: eduMFA@example.com
    toaddrs:
    - admin1@example.com
    - admin2@example.com
    subject: eduMFA Error
    formatter: detail
    level: ERROR
  file:
    # Rollover the logfile at midnight
    class: logging.handlers.RotatingFileHandler
    backupCount: 5
    maxBytes: 1000000
    formatter: detail
    level: INFO
    filename: /var/log/edumfa/edumfa.log
  syslog:
    class: logging.handlers.SysLogHandler
    address: ['192.168.1.110', 514]
    formatter: detail
    level: INFO

loggers:
  # The logger name is the qualname
  eduMFA:
    handlers:
    - file
    - mail
    level: INFO

  root:
    handlers:
    - syslog
    level: WARNING

Different handlers can be used to send log messages to log-aggregators like splunk [2] or logstash [3].

The old python logging config file format is also still supported:

[formatters]
keys=detail

[handlers]
keys=file,mail

[formatter_detail]
class=edumfa.lib.log.SecureFormatter
format=[%(asctime)s][%(process)d][%(thread)d][%(levelname)s][%(name)s:%(lineno)d] %(message)s

[handler_mail]
class=logging.handlers.SMTPHandler
level=ERROR
formatter=detail
args=('mail.example.com', 'eduMFA@example.com', ['admin1@example.com',\
   'admin2@example.com'], 'eduMFA Error')

[handler_file]
# Rollover the logfile at midnight
class=logging.handlers.RotatingFileHandler
backupCount=14
maxBytes=10000000
formatter=detail
level=DEBUG
args=('/var/log/edumfa/edumfa.log',)

[loggers]
keys=root,eduMFA

[logger_eduMFA]
handlers=file,mail
qualname=eduMFA
level=DEBUG

[logger_root]
level=ERROR
handlers=file

Note

These examples define a mail handler, that will send emails to certain email addresses, if an ERROR occurs. All other DEBUG messages will be logged to a file.

Note

The filename extension is irrelevant in this case

Footnotes