chiark / gitweb /
systemd-python: MESSAGE_ID as UUID for Journal
[elogind.git] / src / python-systemd / journal.py
index d610b4767bb8b53f5b2553263a13cdef7a36c17b..fafddaa27e1d1ca40cedf8ab7b17e0fd3966f9d0 100644 (file)
 #  You should have received a copy of the GNU Lesser General Public License
 #  along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
+import datetime
+import functools
+import sys
+import uuid
 import traceback as _traceback
 import os as _os
 import logging as _logging
 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)
+
+class Journal(_Journal):
+    def __new__(cls, *args, **kwargs):
+        self = _Journal.__new__(cls, *args, **kwargs)
+        if sys.version_info[0] >= 3:
+            self.default_call = functools.partial(str, encoding='utf-8')
+        else:
+            self.default_call = functools.partial(unicode, encoding='utf-8')
+        self.call_dict = {
+            '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': lambda x: datetime.datetime.fromtimestamp(float(x)/1E6),
+            '__REALTIME_TIMESTAMP': lambda x: datetime.datetime.fromtimestamp(float(x)/1E6),
+            '_SOURCE_MONOTONIC_TIMESTAMP': lambda x: datetime.timedelta(microseconds=float(x)),
+            '__MONOTONIC_TIMESTAMP': lambda x: datetime.timedelta(microseconds=float(x)),
+            'COREDUMP_PID': int,
+            'COREDUMP_UID': int,
+            'COREDUMP_GID': int,
+            'COREDUMP_SESSION': int,
+            'COREDUMP_SIGNAL': int,
+            'COREDUMP_TIMESTAMP': lambda x: datetime.datetime.fromtimestamp(float(x)/1E6),
+        }
+        if sys.version_info[0] >= 3:
+            self.call_dict['COREDUMP'] = bytes
+        else:
+            self.call_dict['COREDUMP'] = str
+        return self
 
 def _make_line(field, value):
         if isinstance(value, bytes):
@@ -96,19 +146,20 @@ def stream(identifier, priority=LOG_DEBUG, level_prefix=False):
         <open file '<fdopen>', 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 +182,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 +198,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):