Syslog doesn't have to be available on the machine (e.g. in a mock
environment). The handler creation then fails. Let's create it only when
specifically requested.
unit tests pass, rpmlint task works
| Lint Skipped |
| Unit Tests Skipped |
| Path | Packages | |||
|---|---|---|---|---|
| M | libtaskotron/logger.py (9 lines) |
| Commit | Tree | Parents | Author | Summary | Date |
|---|---|---|---|---|---|
| 91a9550ad3c0 | 13f02cafa999 | 50dce70bf7e2 | Kamil Páral | logger: create syslog handler only if required (Show More…) | Jul 24 2014, 12:58 PM |
| Show All 28 Lines | |||||
| 29 | 29 | | |||
| 30 | #: our current syslog handler sending logged messages to syslog | 30 | #: our current syslog handler sending logged messages to syslog | ||
| 31 | syslog_handler = None | 31 | syslog_handler = None | ||
| 32 | 32 | | |||
| 33 | #: our current file handler sending logged messages to file log | 33 | #: our current file handler sending logged messages to file log | ||
| 34 | file_handler = None | 34 | file_handler = None | ||
| 35 | 35 | | |||
| 36 | 36 | | |||
| 37 | def _create_handlers(filelog_path=None): | 37 | def _create_handlers(syslog=False, filelog_path=None): | ||
| 38 | '''Create all handlers. This should be called before any method tries to | 38 | '''Create all handlers. This should be called before any method tries to | ||
| 39 | operate on handlers. Handlers are created only if they don't exist yet | 39 | operate on handlers. Handlers are created only if they don't exist yet | ||
| 40 | (they are `None`), otherwise they are skipped. So this method can easily be | 40 | (they are `None`), otherwise they are skipped. So this method can easily be | ||
| 41 | called multiple times. | 41 | called multiple times. | ||
| 42 | 42 | | |||
| 43 | Note: Handlers can't be created during module import, because that breaks | 43 | Note: Handlers can't be created during module import, because that breaks | ||
| 44 | stream capturing functionality when running through ``pytest``. | 44 | stream capturing functionality when running through ``pytest``. | ||
| 45 | 45 | | |||
| 46 | :param bool syslog: create syslog handler. Syslog must be available. | ||||
| 46 | :param str filelog_path: path to the log file where :data:`file_handler` | 47 | :param str filelog_path: path to the log file where :data:`file_handler` | ||
| 47 | should emit messages. If this is ``None``, then | 48 | should emit messages. If this is ``None``, then | ||
| 48 | :data:`file_handler` is not created. | 49 | :data:`file_handler` is not created. | ||
| 50 | :raise socket.error: if syslog handler creation failed | ||||
| 49 | ''' | 51 | ''' | ||
| 50 | global stream_handler, syslog_handler, file_handler | 52 | global stream_handler, syslog_handler, file_handler | ||
| 51 | 53 | | |||
| 52 | if not stream_handler: | 54 | if not stream_handler: | ||
| 53 | stream_handler = logging.StreamHandler() | 55 | stream_handler = logging.StreamHandler() | ||
| 54 | stream_handler.setFormatter(_formatter) | 56 | stream_handler.setFormatter(_formatter) | ||
| 55 | 57 | | |||
| 56 | if not syslog_handler: | 58 | if syslog and not syslog_handler: | ||
| 57 | syslog_handler = logging.handlers.SysLogHandler(address='/dev/log', | 59 | syslog_handler = logging.handlers.SysLogHandler(address='/dev/log', | ||
| 58 | facility=logging.handlers.SysLogHandler.LOG_LOCAL4) | 60 | facility=logging.handlers.SysLogHandler.LOG_LOCAL4) | ||
| 59 | 61 | | |||
| 60 | if not file_handler and filelog_path: | 62 | if not file_handler and filelog_path: | ||
| 61 | file_handler = logging.handlers.RotatingFileHandler(filelog_path, | 63 | file_handler = logging.handlers.RotatingFileHandler(filelog_path, | ||
| 62 | maxBytes=500000, backupCount=5) | 64 | maxBytes=500000, backupCount=5) | ||
| 63 | file_handler.setFormatter(_formatter) | 65 | file_handler.setFormatter(_formatter) | ||
| 64 | 66 | | |||
| ▲ Show 20 Lines • Show All 64 Lines • ▼ Show 20 Line(s) | 120 | def init(level_stream=None, level_file=None, | |||
| 129 | :param int level_file: level of file logging as defined in | 131 | :param int level_file: level of file logging as defined in | ||
| 130 | :mod:`logging`. If ``None``, a default level from config file is used. | 132 | :mod:`logging`. If ``None``, a default level from config file is used. | ||
| 131 | :param bool stream: enable logging to process stream (stderr) | 133 | :param bool stream: enable logging to process stream (stderr) | ||
| 132 | :param bool syslog: enable logging to syslog | 134 | :param bool syslog: enable logging to syslog | ||
| 133 | :param bool filelog: enable logging to a file log. If ``None``, the value is | 135 | :param bool filelog: enable logging to a file log. If ``None``, the value is | ||
| 134 | loaded from config file. | 136 | loaded from config file. | ||
| 135 | :param str filelog_path: path to the log file. If ``None``, the value is | 137 | :param str filelog_path: path to the log file. If ``None``, the value is | ||
| 136 | loaded from config file. | 138 | loaded from config file. | ||
| 137 | """ | 139 | """ | ||
| 138 | 140 | | |||
| 139 | # We import libtaskotron.config here because import from beginning | 141 | # We import libtaskotron.config here because import from beginning | ||
| 140 | # of this module causes problems with cyclic dependencies | 142 | # of this module causes problems with cyclic dependencies | ||
| 141 | from libtaskotron import config | 143 | from libtaskotron import config | ||
| 142 | conf = config.get_config() | 144 | conf = config.get_config() | ||
| 143 | 145 | | |||
| 144 | if level_stream is None: | 146 | if level_stream is None: | ||
| 145 | level_stream = conf.log_level_stream | 147 | level_stream = conf.log_level_stream | ||
| Show All 12 Lines | 159 | if stream: | |||
| 158 | _set_level(stream_handler, level_stream, "log_level_stream") | 160 | _set_level(stream_handler, level_stream, "log_level_stream") | ||
| 159 | rootlogger.addHandler(stream_handler) | 161 | rootlogger.addHandler(stream_handler) | ||
| 160 | log.debug("Stream logging enabled with level: %s", | 162 | log.debug("Stream logging enabled with level: %s", | ||
| 161 | logging.getLevelName(stream_handler.level)) | 163 | logging.getLevelName(stream_handler.level)) | ||
| 162 | else: | 164 | else: | ||
| 163 | rootlogger.removeHandler(stream_handler) | 165 | rootlogger.removeHandler(stream_handler) | ||
| 164 | 166 | | |||
| 165 | if syslog: | 167 | if syslog: | ||
| 168 | _create_handlers(syslog=True) | ||||
| 166 | rootlogger.addHandler(syslog_handler) | 169 | rootlogger.addHandler(syslog_handler) | ||
| 167 | log.debug("Syslog logging enabled with level: %s", | 170 | log.debug("Syslog logging enabled with level: %s", | ||
| 168 | logging.getLevelName(syslog_handler.level)) | 171 | logging.getLevelName(syslog_handler.level)) | ||
| 169 | else: | 172 | else: | ||
| 170 | rootlogger.removeHandler(syslog_handler) | 173 | rootlogger.removeHandler(syslog_handler) | ||
| 171 | 174 | | |||
| 172 | if filelog: | 175 | if filelog: | ||
| 173 | # try access | 176 | # try access | ||
| Show All 28 Lines | |||||