Source code for openquake.engine.logs

# -*- coding: utf-8 -*-
# vim: tabstop=4 shiftwidth=4 softtabstop=4
# Copyright (C) 2010-2016 GEM Foundation
# OpenQuake is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# OpenQuake is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU Affero General Public License for more details.
# You should have received a copy of the GNU Affero General Public License
# along with OpenQuake. If not, see <>.

Set up some system-wide loggers

import os.path
import logging
from datetime import datetime
from contextlib import contextmanager

# Place the new level between info and warning
logging.PROGRESS = 25
logging.addLevelName(logging.PROGRESS, "PROGRESS")

LEVELS = {'debug': logging.DEBUG,
          'info': logging.INFO,
          'warn': logging.WARNING,
          'progress': logging.PROGRESS,
          'error': logging.ERROR,
          'critical': logging.CRITICAL}

LOG_FORMAT = ('[%(asctime)s %(job_type)s job #%(job_id)s %(hostname)s '
              '%(levelname)s %(processName)s/%(process)s] %(message)s')

LOG = logging.getLogger()

[docs]def touch_log_file(log_file): """ If a log file destination is specified, attempt to open the file in 'append' mode ('a'). If the specified file is not writable, an :exc:`IOError` will be raised. """ open(os.path.abspath(log_file), 'a').close()
def _log_progress(msg, *args, **kwargs): """ Log the message using the progress reporting logging level. ``args`` and ``kwargs`` are the same as :meth:`logging.Logger.debug`, except that this method has an additional possible keyword: ``indent``. Normally, progress messages are logged with a '** ' prefix. If ``indent`` is `True`, messages will be logged with a '** >' prefix. If ``indent`` is not specified, it will default to `False`. """ indent = kwargs.get('indent') if indent is None: indent = False else: # 'indent' is an invalid kwarg for the logger's _log method # we need to remove it before we call _log: del kwargs['indent'] if indent: prefix = '** >' else: prefix = '** ' msg = '%s %s' % (prefix, msg) LOG._log(logging.PROGRESS, msg, args, **kwargs) LOG.progress = _log_progress
[docs]def set_level(level): """ Initialize logs to write records with level `level` or above. """ logging.root.setLevel(LEVELS.get(level, logging.WARNING))
def _update_log_record(self, record): """ Massage a log record before emitting it. Intended to be used by the custom log handlers defined in this module. """ if not hasattr(record, 'hostname'): record.hostname = '-' if not hasattr(record, 'job_type'): record.job_type = self.job_type if not hasattr(record, 'job_id'): record.job_id =
[docs]class LogStreamHandler(logging.StreamHandler): """ Log stream handler """ def __init__(self, job): super(LogStreamHandler, self).__init__() self.setFormatter(logging.Formatter(LOG_FORMAT)) self.job_type = job.job_type self.job = job
[docs] def emit(self, record): # pylint: disable=E0202 _update_log_record(self, record) super(LogStreamHandler, self).emit(record)
[docs]class LogFileHandler(logging.FileHandler): """ Log file handler """ def __init__(self, job, log_file): super(LogFileHandler, self).__init__(log_file) self.setFormatter(logging.Formatter(LOG_FORMAT)) self.job_type = job.job_type self.job = job self.log_file = log_file
[docs] def emit(self, record): # pylint: disable=E0202 _update_log_record(self, record) super(LogFileHandler, self).emit(record)
[docs]class LogDatabaseHandler(logging.Handler): """ Log stream handler """ def __init__(self, job): from openquake.server.db.models import getcursor # avoid circular imports self.getcursor = getcursor super(LogDatabaseHandler, self).__init__() self.job_type = job.job_type self.job = job
[docs] def emit(self, record): # pylint: disable=E0202 if record.levelno >= logging.INFO: self.getcursor('job_init').execute( """INSERT INTO uiapi.log (job_id, timestamp, level, process, message) VALUES (%s, %s, %s, %s, %s)""", (, datetime.utcnow(), record.levelname, '%s/%s' % (record.processName, record.process), record.getMessage()))
[docs]def handle(job, log_level='info', log_file=None): """ Context manager adding and removing log handlers. :param job: a :class:`openquake.server.db.models.OqJob` instance :param log_level: one of debug, info, warn, progress, error, critical :param log_file: log file path (if None, logs on stdout only) """ handlers = [LogDatabaseHandler(job)] # log on db always if log_file is None: handlers.append(LogStreamHandler(job)) elif log_file == 'stderr': edir = job.get_param('export_dir') log_file = os.path.join(edir, 'calc_%d.log' % touch_log_file(log_file) # check if writeable handlers.append(LogStreamHandler(job)) handlers.append(LogFileHandler(job, log_file)) else: handlers.append(LogFileHandler(job, log_file)) for handler in handlers: logging.root.addHandler(handler) set_level(log_level) try: yield finally: # sanity check to make sure that the logging on file is working if log_file and os.path.getsize(log_file) == 0: logging.root.warn('The log file %s is empty!?' % log_file) for handler in handlers: logging.root.removeHandler(handler)