mirror of
https://github.com/weewx/weewx.git
synced 2026-04-18 16:46:56 -04:00
117 lines
3.1 KiB
Python
117 lines
3.1 KiB
Python
#
|
|
# Copyright (c) 2019-2023 Tom Keffer <tkeffer@gmail.com>
|
|
#
|
|
# See the file LICENSE.txt for your full rights.
|
|
#
|
|
"""WeeWX logging facility
|
|
|
|
OBSOLETE: Use weeutil.logging instead
|
|
"""
|
|
|
|
import os
|
|
import syslog
|
|
import traceback
|
|
|
|
from io import StringIO
|
|
|
|
log_levels = {
|
|
'debug': syslog.LOG_DEBUG,
|
|
'info': syslog.LOG_INFO,
|
|
'warning': syslog.LOG_WARNING,
|
|
'critical': syslog.LOG_CRIT,
|
|
'error': syslog.LOG_ERR
|
|
}
|
|
|
|
|
|
def log_open(log_label='weewx'):
|
|
syslog.openlog(log_label, syslog.LOG_PID | syslog.LOG_CONS)
|
|
|
|
|
|
def log_upto(log_level=None):
|
|
"""Set what level of logging we want."""
|
|
if log_level is None:
|
|
log_level = syslog.LOG_INFO
|
|
elif isinstance(log_level, str):
|
|
log_level = log_levels.get(log_level, syslog.LOG_INFO)
|
|
syslog.setlogmask(syslog.LOG_UPTO(log_level))
|
|
|
|
|
|
def logdbg(msg, prefix=None):
|
|
if prefix is None:
|
|
prefix = _get_file_root()
|
|
syslog.syslog(syslog.LOG_DEBUG, "%s: %s" % (prefix, msg))
|
|
|
|
|
|
def loginf(msg, prefix=None):
|
|
if prefix is None:
|
|
prefix = _get_file_root()
|
|
syslog.syslog(syslog.LOG_INFO, "%s: %s" % (prefix, msg))
|
|
|
|
|
|
def lognote(msg, prefix=None):
|
|
if prefix is None:
|
|
prefix = _get_file_root()
|
|
syslog.syslog(syslog.LOG_NOTICE, "%s: %s" % (prefix, msg))
|
|
|
|
|
|
# In case anyone is really wedded to the idea of 6 letter log functions:
|
|
lognot = lognote
|
|
|
|
|
|
def logwar(msg, prefix=None):
|
|
if prefix is None:
|
|
prefix = _get_file_root()
|
|
syslog.syslog(syslog.LOG_WARNING, "%s: %s" % (prefix, msg))
|
|
|
|
|
|
def logerr(msg, prefix=None):
|
|
if prefix is None:
|
|
prefix = _get_file_root()
|
|
syslog.syslog(syslog.LOG_ERR, "%s: %s" % (prefix, msg))
|
|
|
|
|
|
def logalt(msg, prefix=None):
|
|
if prefix is None:
|
|
prefix = _get_file_root()
|
|
syslog.syslog(syslog.LOG_ALERT, "%s: %s" % (prefix, msg))
|
|
|
|
|
|
def logcrt(msg, prefix=None):
|
|
if prefix is None:
|
|
prefix = _get_file_root()
|
|
syslog.syslog(syslog.LOG_CRIT, "%s: %s" % (prefix, msg))
|
|
|
|
|
|
def log_traceback(prefix='', log_level=None):
|
|
"""Log the stack traceback into syslog.
|
|
|
|
prefix: A string, which will be put in front of each log entry. Default is no string.
|
|
|
|
log_level: Either a syslog level (e.g., syslog.LOG_INFO), or a string. Valid strings
|
|
are given by the keys of log_levels.
|
|
"""
|
|
if log_level is None:
|
|
log_level = syslog.LOG_INFO
|
|
elif isinstance(log_level, str):
|
|
log_level = log_levels.get(log_level, syslog.LOG_INFO)
|
|
sfd = StringIO()
|
|
traceback.print_exc(file=sfd)
|
|
sfd.seek(0)
|
|
for line in sfd:
|
|
syslog.syslog(log_level, "%s: %s" % (prefix, line))
|
|
|
|
|
|
def _get_file_root():
|
|
"""Figure out who is the caller of the logging function"""
|
|
|
|
# Get the stack:
|
|
tb = traceback.extract_stack()
|
|
# Go back 3 frames. First frame is get_file_root(), 2nd frame is the logging function, 3rd frame
|
|
# is what we want: what called the logging function
|
|
calling_frame = tb[-3]
|
|
# Get the file name of what called the logging function
|
|
calling_file = os.path.basename(calling_frame[0])
|
|
# Get rid of any suffix (e.g., ".py"):
|
|
file_root = calling_file.split('.')[0]
|
|
return file_root
|