summaryrefslogtreecommitdiffstats
path: root/src/log.py
blob: bf00c71fe6f065824e2f9331745d41b5d1f433e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
import logging
import logging.config
import os

from src.utils.net import getifaddr

DEFAULT_LOGGING_LINUX = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'formatter.syslog': {
            '()': 'logging.Formatter',
            'format': 'ogClient: [{levelname}] - {message}',
            'style': '{',
        },
        'formatter.console': {
            '()': 'logging.Formatter',
            'format': '[{levelname}] - {message}',
            'style': '{',
        },
        'formatter.syslogtime': {
            '()': 'logging.Formatter',
            'datefmt': '%Y-%m-%d %H:%M:%S',
            'format': '({asctime}) ogClient: [{levelname}] - {message}',
            'style': '{',
        },
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'formatter.console',
            'stream': 'ext://sys.stdout',
        },
        'syslog': {
            'class': 'logging.handlers.SysLogHandler',
            'formatter': 'formatter.syslog',
            'address': '/dev/log',
        },
        'samba': {
            'class': 'logging.FileHandler',
            'formatter': 'formatter.syslogtime',
            'filename': f'/opt/opengnsys/log/{getifaddr(os.getenv("DEVICE"))}.log',
        },
    },
    'loggers': {
        '': {
            'handlers': ['syslog', 'console'],
            'level': 'INFO',
        },
    }
}

DEFAULT_LOGGING_WIN = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'formatter.console': {
            '()': 'logging.Formatter',
            'format': 'ogClient: [{levelname}] - {message}',
            'style': '{',
        }
    },
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'formatter.console',
            'stream': 'ext://sys.stdout',
        },
    },
    'loggers': {
        '': {
            'handlers': ['console'],
            'level': 'DEBUG',
        },
    }
}

def configure_logging(mode, level):
    """
    Receives a ogClient operating mode.

    Configures the default logger according to the operating mode.

    For example, in the case of running live mode it will activate
    logging to the expected samba shared log file ({ip}.txt.log).
    """
    if mode == 'windows':
        logconfig = DEFAULT_LOGGING_WIN
    else:
        logconfig = DEFAULT_LOGGING_LINUX

    if mode == 'live':
        logconfig['loggers']['']['handlers'].append('samba')

    logconfig['loggers']['']['level'] = level

    logging.config.dictConfig(logconfig)