source: ogAgent-Git/src/opengnsys/log.py @ ca12de8

# -*- coding: utf-8 -*-
#
# Copyright (c) 2014 Virtual Cable S.L.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
#    * Redistributions of source code must retain the above copyright notice,
#      this list of conditions and the following disclaimer.
#    * Redistributions in binary form must reproduce the above copyright notice,
#      this list of conditions and the following disclaimer in the documentation
#      and/or other materials provided with the distribution.
#    * Neither the name of Virtual Cable S.L. nor the names of its contributors
#      may be used to endorse or promote products derived from this software
#      without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""
@author: Adolfo Gómez, dkmaster at dkmon dot com
"""


import sys
import traceback

if sys.platform == 'win32':
    from opengnsys.windows.log import LocalLogger
else:
    from opengnsys.linux.log import LocalLogger

# Valid logging levels, from UDS Broker (uds.core.utils.log)
OTHER, DEBUG, INFO, WARN, ERROR, FATAL = (10000 * (x + 1) for x in range(6))

_levelName = {
    'OTHER': OTHER,
    'DEBUG': DEBUG,
    'INFO': INFO,
    'WARN': WARN,
    'ERROR': ERROR,
    'FATAL': FATAL
}


class Logger(object):
    def __init__(self):
        self.logLevel = INFO
        self.logger = LocalLogger()

    def setLevel(self, level):
        """
        Sets log level filter (minimum level required for a log message to be processed)
        :param level: Any message with a level below this will be filtered out
        """
        if isinstance(level, str):
            level = _levelName.get(level, INFO)
            
        self.logLevel = level  # Ensures level is an integer or fails

    def log(self, level, message):
        if level < self.logLevel:  # Skip not wanted messages
            return

        self.logger.log(level, message)

    def debug(self, message):
        self.log(DEBUG, message)

    def warn(self, message):
        self.log(WARN, message)

    def warning(self, message):
        self.log(WARN, message)

    def info(self, message):
        self.log(INFO, message)

    def error(self, message):
        self.log(ERROR, message)

    def fatal(self, message):
        self.log(FATAL, message)

    def exception(self):
        try:
            tb = traceback.format_exc()
        except Exception:
            tb = '(could not get traceback!)'

        self.log(DEBUG, 'traceback follows: "{}"'.format(tb))

    def flush(self):
        pass


logger = Logger()