X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=src%2Fpython-systemd%2Fjournal.py;h=db35ba20056b3f0986b3b2e82806562d91118f10;hp=d610b4767bb8b53f5b2553263a13cdef7a36c17b;hb=71766afa2d80ffe1b03c410f6d5ffdc140883314;hpb=afcd68c1498ba4d449b782f4703490a74770c5f4
diff --git a/src/python-systemd/journal.py b/src/python-systemd/journal.py
index d610b4767..db35ba200 100644
--- a/src/python-systemd/journal.py
+++ b/src/python-systemd/journal.py
@@ -19,12 +19,125 @@
# You should have received a copy of the GNU Lesser General Public License
# along with systemd; If not, see .
+import datetime
+import functools
+import sys
+import uuid
import traceback as _traceback
import os as _os
import logging as _logging
+if sys.version_info >= (3,):
+ from collections import ChainMap
from syslog import (LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR,
LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG)
from ._journal import sendv, stream_fd
+from ._reader import (_Journal, NOP, APPEND, INVALIDATE,
+ LOCAL_ONLY, RUNTIME_ONLY, SYSTEM_ONLY)
+from . import id128 as _id128
+
+_MONOTONIC_CONVERTER = lambda x: datetime.timedelta(microseconds=float(x))
+_REALTIME_CONVERTER = lambda x: datetime.datetime.fromtimestamp(float(x)/1E6)
+DEFAULT_CONVERTERS = {
+ 'MESSAGE_ID': uuid.UUID,
+ 'PRIORITY': int,
+ 'LEADER': int,
+ 'SESSION_ID': int,
+ 'USERSPACE_USEC': int,
+ 'INITRD_USEC': int,
+ 'KERNEL_USEC': int,
+ '_UID': int,
+ '_GID': int,
+ '_PID': int,
+ 'SYSLOG_FACILITY': int,
+ 'SYSLOG_PID': int,
+ '_AUDIT_SESSION': int,
+ '_AUDIT_LOGINUID': int,
+ '_SYSTEMD_SESSION': int,
+ '_SYSTEMD_OWNER_UID': int,
+ 'CODE_LINE': int,
+ 'ERRNO': int,
+ 'EXIT_STATUS': int,
+ '_SOURCE_REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
+ '__REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
+ '_SOURCE_MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
+ '__MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
+ 'COREDUMP': bytes,
+ 'COREDUMP_PID': int,
+ 'COREDUMP_UID': int,
+ 'COREDUMP_GID': int,
+ 'COREDUMP_SESSION': int,
+ 'COREDUMP_SIGNAL': int,
+ 'COREDUMP_TIMESTAMP': _REALTIME_CONVERTER,
+}
+
+if sys.version_info >= (3,):
+ _convert_unicode = functools.partial(str, encoding='utf-8')
+else:
+ _convert_unicode = functools.partial(unicode, encoding='utf-8')
+
+class Journal(_Journal):
+ def __init__(self, converters=None, *args, **kwargs):
+ super(Journal, self).__init__(*args, **kwargs)
+ if sys.version_info >= (3,3):
+ self.converters = ChainMap()
+ if converters is not None:
+ self.converters.maps.append(converters)
+ self.converters.maps.append(DEFAULT_CONVERTERS)
+ else:
+ # suitable fallback, e.g.
+ self.converters = DEFAULT_CONVERTERS.copy()
+ if converters is not None:
+ self.converters.update(converters)
+
+ def _convert_field(self, key, value):
+ try:
+ result = self.converters[key](value)
+ except:
+ # Default conversion in unicode
+ try:
+ result = _convert_unicode(value)
+ except:
+ # Leave in default bytes
+ result = value
+ return result
+
+ def _convert_entry(self, entry):
+ result = {}
+ for key, value in entry.items():
+ if isinstance(value, list):
+ result[key] = [self._convert_field(key, val) for val in value]
+ else:
+ result[key] = self._convert_field(key, value)
+ return result
+
+ def add_match(self, *args, **kwargs):
+ args = list(args)
+ args.extend(_make_line(key, val) for key, val in kwargs.items())
+ super(Journal, self).add_match(*args)
+
+ def get_next(self, skip=1):
+ return self._convert_entry(
+ super(Journal, self).get_next(skip))
+
+ def query_unique(self, key):
+ return set(self._convert_field(key, value)
+ for value in super(Journal, self).query_unique(key))
+
+ def log_level(self, level):
+ """Sets maximum log level by setting matches for PRIORITY."""
+ if 0 <= level <= 7:
+ for i in range(level+1):
+ self.add_match(PRIORITY="%s" % i)
+ else:
+ raise ValueError("Log level must be 0 <= level <= 7")
+
+ def this_boot(self):
+ """Add match for _BOOT_ID equal to current boot ID."""
+ self.add_match(_BOOT_ID=_id128.get_boot().hex)
+
+ def this_machine(self):
+ """Add match for _MACHINE_ID equal to the ID of this machine."""
+ self.add_match(_MACHINE_ID=_id128.get_machine().hex)
def _make_line(field, value):
if isinstance(value, bytes):
@@ -96,19 +209,20 @@ def stream(identifier, priority=LOG_DEBUG, level_prefix=False):
', mode 'w' at 0x...>
>>> stream.write('message...\n')
- will produce the following message in the journal:
+ will produce the following message in the journal::
- PRIORITY=7
- SYSLOG_IDENTIFIER=myapp
- MESSAGE=message...
+ PRIORITY=7
+ SYSLOG_IDENTIFIER=myapp
+ MESSAGE=message...
Using the interface with print might be more convinient:
>>> from __future__ import print_function
>>> print('message...', file=stream)
- priority is the syslog priority, one of LOG_EMERG, LOG_ALERT,
- LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG.
+ priority is the syslog priority, one of `LOG_EMERG`,
+ `LOG_ALERT`, `LOG_CRIT`, `LOG_ERR`, `LOG_WARNING`,
+ `LOG_NOTICE`, `LOG_INFO`, `LOG_DEBUG`.
level_prefix is a boolean. If true, kernel-style log priority
level prefixes (such as '<1>') are interpreted. See
@@ -131,8 +245,8 @@ class JournalHandler(_logging.Handler):
>>> log.addHandler(journal.JournalHandler())
>>> log.warn("Some message: %s", detail)
- Note that by default, message levels INFO and DEBUG are ignored
- by the logging framework. To enable those log levels:
+ Note that by default, message levels `INFO` and `DEBUG` are
+ ignored by the logging framework. To enable those log levels:
>>> log.setLevel(logging.DEBUG)
@@ -147,16 +261,15 @@ class JournalHandler(_logging.Handler):
>>> logging.root.addHandler(journal.JournalHandler())
- For more complex configurations when using dictConfig or
- fileConfig, specify 'systemd.journal.JournalHandler' as the
+ For more complex configurations when using `dictConfig` or
+ `fileConfig`, specify `systemd.journal.JournalHandler` as the
handler class. Only standard handler configuration options
- are supported: level, formatter, filters.
+ are supported: `level`, `formatter`, `filters`.
The following journal fields will be sent:
-
- MESSAGE, PRIORITY, THREAD_NAME, CODE_FILE, CODE_LINE,
- CODE_FUNC, LOGGER (name as supplied to getLogger call),
- MESSAGE_ID (optional, see above).
+ `MESSAGE`, `PRIORITY`, `THREAD_NAME`, `CODE_FILE`, `CODE_LINE`,
+ `CODE_FUNC`, `LOGGER` (name as supplied to getLogger call),
+ `MESSAGE_ID` (optional, see above).
"""
def emit(self, record):