def initialize_logger(args, script_name, syslog_server=None):
"""
Initialize the logging instance with the values provided
by the user and return the logging object.
"""
LOGGER = logging.getLogger(script_name)
FORMATTER = logging.Formatter(
""+script_name+" : "+str(getpass.getuser())+" : %(asctime)s : %(levelname)s : %(message)s",
datefmt='%m/%d/%Y %I:%M:%S %p')
# create console handler and set level to info
logging.StreamHandler()
# setup `RainbowLoggingHandler`
handler = RainbowLoggingHandler(sys.stderr, color_funcName=('black', 'white', True))
handler.setFormatter(FORMATTER)
LOGGER.addHandler(handler)
# setup log level from arguments
if args.log:
if contains('DEBUG', args.log.upper()):
handler.setLevel(logging.DEBUG)
LOGGER.setLevel(logging.DEBUG)
elif contains('WARNING', args.log.upper()):
handler.setLevel(logging.WARNING)
LOGGER.setLevel(logging.WARNING)
elif contains('ERROR', args.log.upper()):
handler.setLevel(logging.ERROR)
LOGGER.setLevel(logging.ERROR)
else:
handler.setLevel(logging.INFO)
LOGGER.setLevel(logging.INFO)
LOGGER.info('Logging level has been set to {}'.format(args.log.upper()))
# setup logging directory to store log files
if args.log_dir:
if not os.path.isdir(args.log_dir):
os.makedirs(args.log_dir)
output_dir = args.log_dir
else:
output_dir = create_log_dir()
LOGGER.info('Logging directory has been set to {}'.format(output_dir))
# create optional syslog handler, if the argument has been supplied to support it
if args.syslog:
DESIG_SYSLOG_SERVER = syslog_server
handler = logging.handlers.SysLogHandler(address=(DESIG_SYSLOG_SERVER,
logging.handlers.SYSLOG_UDP_PORT))
syslog_format = logging.Formatter(
'[appname]: %(name)s: [alias]: '+str(getpass.getuser())+' %(message)s')
handler.setFormatter(syslog_format)
if args.syslog_level:
# Set syslog level to the user specified level
if args.syslog_level == 'info':
handler.setLevel(logging.INFO)
elif args.syslog_level == 'warning':
handler.setLevel(logging.WARNING)
elif args.syslog_level == 'error':
handler.setLevel(logging.ERROR)
LOGGER.info(
'Syslog has been enabled for [{}] logging level, sent to syslog server [{}]'.format(
args.syslog_level,
DESIG_SYSLOG_SERVER))
# Add syslog handler to logging object
LOGGER.addHandler(handler)
# create error file handler and set level to error
handler = logging.FileHandler(os.path.join(
output_dir, "error.log"),"a", encoding=None, delay="true")
handler.setLevel(logging.ERROR)
handler.setFormatter(FORMATTER)
LOGGER.addHandler(handler)
# create debug file handler and set level to debug
handler = logging.FileHandler(os.path.join(output_dir, "all.log"),"a")
handler.setLevel(logging.DEBUG)
handler.setFormatter(FORMATTER)
LOGGER.addHandler(handler)
if args.logfile_rotate:
'''
User has specified they would like to create a daily rotating logfile.
Create an instance and DO NOT create a single serving logfile.
'''
LOGGER.info('Logfiles are now set to auto-rotate at midnight UTC.')
filepath_and_name_format = ('{}/{}'.format(output_dir, script_name.replace('.py','')))
LOGGER.info('Logfiles are now being written at {}'.format(filepath_and_name_format))
log_filename=filepath_and_name_format
# maxBytes takes the max file size in MB and bit-shift converts to bytes
handler=SizedTimedRotatingFileHandler(
log_filename, maxBytes=args.logsize<<20)
handler.setLevel(logging.DEBUG)
handler.setFormatter(FORMATTER)
handler.suffix = "%Y-%m-%d.log"
LOGGER.addHandler(handler)
else:
# create individual execution file handler and set level to debug
now = datetime.datetime.now()
datetime_stamp = now.strftime("%Y-%m-%d_%H-%M-%S")
datetime_stamp = ('{}_{}.log'.format(datetime_stamp, script_name.replace('.py','')))
filename = os.path.join(output_dir, datetime_stamp)
handler = logging.FileHandler(filename, "a")
if contains('DEBUG', args.log.upper()):
handler.setLevel(logging.DEBUG)
elif contains('WARNING', args.log.upper()):
handler.setLevel(logging.WARNING)
elif contains('ERROR', args.log.upper()):
handler.setLevel(logging.ERROR)
else:
handler.setLevel(logging.INFO)
handler.setFormatter(FORMATTER)
LOGGER.addHandler(handler)
# display the exact file name / path to the user
LOGGER.info('Logs for this session now being written to {}'.format(filename))
# Attach filepath / filename string to logger
LOGGER.filename = filename
return LOGGER
