xref: /OpenGrok/tools/src/main/python/opengrok_tools/utils/log.py (revision b33822c50ce6634de1822d15498d494b6e728c2f)

#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# See LICENSE.txt included in this distribution for the specific
# language governing permissions and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at LICENSE.txt.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright (c) 2018, 2022, Oracle and/or its affiliates. All rights reserved.
#

import logging
import sys
import os
import argparse
from logging.handlers import RotatingFileHandler
from .exitvals import (
    FAILURE_EXITVAL,
)


def fatal(msg, exit=True):
    """
    Print message to standard error output and exit
    unless the exit parameter is False
    :param msg: message
    :param exit
    """
    print(msg, file=sys.stderr)
    if exit:
        sys.exit(FAILURE_EXITVAL)
    else:
        return FAILURE_EXITVAL


def add_log_level_argument(parser):
    parser.add_argument('-l', '--loglevel', action=LogLevelAction,
                        help='Set log level (e.g. \"ERROR\")',
                        default="INFO")


class LogLevelAction(argparse.Action):
    """
    This class is supposed to be used as action for argparse.
    The action is handled by trying to find the option argument as attribute
    in the logging module. On success, its numeric value is stored in the
    namespace, otherwise ValueError exception is thrown.
    """
    def __init__(self, option_strings, dest, nargs=None, **kwargs):
        if nargs is not None:
            raise ValueError("nargs not allowed")
        super(LogLevelAction, self).__init__(option_strings, dest, **kwargs)

    def __call__(self, parser, namespace, values, option_string=None):
        # print('%r %r %r' % (namespace, values, option_string))
        val = get_log_level(values)
        if val:
            setattr(namespace, self.dest, val)
        else:
            raise ValueError("invalid log level '{}'".format(values))


def get_log_level(level):
    """
    :param level: expressed in string (upper or lower case) or integer
    :return: integer representation of the log level or None
    """
    if type(level) is int:
        return level

    # This could be a string storing a number.
    try:
        return int(level)
    except ValueError:
        pass

    # Look up the name in the logging module.
    try:
        value = getattr(logging, level.upper())
        if type(value) is int:
            return value
        else:
            return None
    except AttributeError:
        return None


def get_class_basename():
    return __name__.split('.')[0]


def get_console_logger(name=__name__, level=logging.INFO,
                       format='%(message)s'):
    """
    Get logger that logs logging.ERROR and higher to stderr, the rest
    to stdout. For logging.DEBUG level more verbose format is used.

    :param name: name of the logger
    :param level: base logging level
    :param format: format string to use
    :return: logger
    """
    if level is None:
        level = logging.INFO

    if level == logging.DEBUG:
        format = '%(asctime)s %(levelname)8s %(name)s | %(message)s'

    formatter = logging.Formatter(format)

    stderr_handler = logging.StreamHandler(stream=sys.stderr)
    stderr_handler.setFormatter(formatter)

    stdout_handler = logging.StreamHandler(stream=sys.stdout)
    stdout_handler.setFormatter(formatter)

    stderr_handler.addFilter(lambda rec: rec.levelno >= logging.ERROR)
    stdout_handler.addFilter(lambda rec: rec.levelno < logging.ERROR)

    logger = logging.getLogger(name)
    logger.setLevel(level)
    logger.propagate = False
    logger.handlers = []
    logger.addHandler(stdout_handler)
    logger.addHandler(stderr_handler)

    return logger


def get_batch_logger(logdir, project_name, loglevel, backupcount,
                     name=__name__):
    """
    Get rotating file logger for storing logs of mirroring of given project.
    :param logdir: log directory
    :param project_name: name of the project
    :param loglevel: logging level
    :param backupcount count of log files to keep around
    :param name name of the logger
    :return logger
    """

    logger = logging.getLogger(name)

    logfile = os.path.join(logdir, project_name + ".log")

    handler = RotatingFileHandler(logfile, maxBytes=0, mode='a',
                                  backupCount=backupcount)
    formatter = logging.Formatter("%(asctime)s - %(levelname)s: "
                                  "%(message)s", '%m/%d/%Y %I:%M:%S %p')
    handler.setFormatter(formatter)
    handler.doRollover()

    logger.setLevel(loglevel)
    logger.propagate = False
    logger.handlers = []
    logger.addHandler(handler)

    return logger