src/python-systemd/journal.py

   1 #  -*- Mode: python; coding:utf-8; indent-tabs-mode: nil -*- */
   2 #
   3 #  This file is part of systemd.
   4 #
   5 #  Copyright 2012 David Strauss <david@davidstrauss.net>
   6 #  Copyright 2012 Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
   7 #  Copyright 2012 Marti Raudsepp <marti@juffo.org>
   8 #
   9 #  systemd is free software; you can redistribute it and/or modify it
  10 #  under the terms of the GNU Lesser General Public License as published by
  11 #  the Free Software Foundation; either version 2.1 of the License, or
  12 #  (at your option) any later version.
  13 #
  14 #  systemd is distributed in the hope that it will be useful, but
  15 #  WITHOUT ANY WARRANTY; without even the implied warranty of
  16 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 #  Lesser General Public License for more details.
  18 #
  19 #  You should have received a copy of the GNU Lesser General Public License
  20 #  along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21
  22 import datetime
  23 import functools
  24 import sys
  25 import uuid
  26 import traceback as _traceback
  27 import os as _os
  28 import logging as _logging
  29 if sys.version_info >= (3,):
  30     from collections import ChainMap
  31 from syslog import (LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR,
  32                     LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG)
  33 from ._journal import sendv, stream_fd
  34 from ._reader import (_Journal, NOP, APPEND, INVALIDATE,
  35                       LOCAL_ONLY, RUNTIME_ONLY, SYSTEM_ONLY)
  36 from . import id128 as _id128
  37
  38 _MONOTONIC_CONVERTER = lambda x: datetime.timedelta(microseconds=float(x))
  39 _REALTIME_CONVERTER = lambda x: datetime.datetime.fromtimestamp(float(x)/1E6)
  40 DEFAULT_CONVERTERS = {
  41     'MESSAGE_ID': uuid.UUID,
  42     'PRIORITY': int,
  43     'LEADER': int,
  44     'SESSION_ID': int,
  45     'USERSPACE_USEC': int,
  46     'INITRD_USEC': int,
  47     'KERNEL_USEC': int,
  48     '_UID': int,
  49     '_GID': int,
  50     '_PID': int,
  51     'SYSLOG_FACILITY': int,
  52     'SYSLOG_PID': int,
  53     '_AUDIT_SESSION': int,
  54     '_AUDIT_LOGINUID': int,
  55     '_SYSTEMD_SESSION': int,
  56     '_SYSTEMD_OWNER_UID': int,
  57     'CODE_LINE': int,
  58     'ERRNO': int,
  59     'EXIT_STATUS': int,
  60     '_SOURCE_REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
  61     '__REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
  62     '_SOURCE_MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
  63     '__MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
  64     'COREDUMP': bytes,
  65     'COREDUMP_PID': int,
  66     'COREDUMP_UID': int,
  67     'COREDUMP_GID': int,
  68     'COREDUMP_SESSION': int,
  69     'COREDUMP_SIGNAL': int,
  70     'COREDUMP_TIMESTAMP': _REALTIME_CONVERTER,
  71 }
  72
  73 if sys.version_info >= (3,):
  74     _convert_unicode = functools.partial(str, encoding='utf-8')
  75 else:
  76     _convert_unicode = functools.partial(unicode, encoding='utf-8')
  77
  78 class Journal(_Journal):
  79     def __init__(self, converters=None, *args, **kwargs):
  80         super(Journal, self).__init__(*args, **kwargs)
  81         if sys.version_info >= (3,3):
  82             self.converters = ChainMap()
  83             if converters is not None:
  84                 self.converters.maps.append(converters)
  85             self.converters.maps.append(DEFAULT_CONVERTERS)
  86         else:
  87             # suitable fallback, e.g.
  88             self.converters = DEFAULT_CONVERTERS.copy()
  89             if converters is not None:
  90                 self.converters.update(converters)
  91
  92     def _convert_field(self, key, value):
  93         try:
  94             result = self.converters[key](value)
  95         except:
  96             # Default conversion in unicode
  97             try:
  98                 result = _convert_unicode(value)
  99             except:
 100                 # Leave in default bytes
 101                 result = value
 102         return result
 103
 104     def _convert_entry(self, entry):
 105         result = {}
 106         for key, value in entry.items():
 107             if isinstance(value, list):
 108                 result[key] = [self._convert_field(key, val) for val in value]
 109             else:
 110                 result[key] = self._convert_field(key, value)
 111         return result
 112
 113     def add_match(self, *args, **kwargs):
 114         args = list(args)
 115         args.extend(_make_line(key, val) for key, val in kwargs.items())
 116         for arg in args:
 117             super(Journal, self).add_match(arg)
 118
 119     def get_next(self, skip=1):
 120         return self._convert_entry(
 121             super(Journal, self).get_next(skip))
 122
 123     def query_unique(self, key):
 124         return set(self._convert_field(key, value)
 125             for value in super(Journal, self).query_unique(key))
 126
 127     def seek_realtime(self, timestamp):
 128         if isinstance(timestamp, datetime.datetime):
 129             timestamp = float(timestamp.strftime("%s.%f"))
 130         return super(Journal, self).seek_realtime(timestamp)
 131
 132     def seek_monotonic(self, timestamp, bootid=None):
 133         if isinstance(timestamp, datetime.timedelta):
 134             timestamp = timestamp.totalseconds()
 135         return super(Journal, self).seek_monotonic(timestamp, bootid)
 136
 137     def log_level(self, level):
 138         """Sets maximum log level by setting matches for PRIORITY."""
 139         if 0 <= level <= 7:
 140             for i in range(level+1):
 141                 self.add_match(PRIORITY="%s" % i)
 142         else:
 143             raise ValueError("Log level must be 0 <= level <= 7")
 144
 145     def this_boot(self):
 146         """Add match for _BOOT_ID equal to current boot ID."""
 147         self.add_match(_BOOT_ID=_id128.get_boot().hex)
 148
 149     def this_machine(self):
 150         """Add match for _MACHINE_ID equal to the ID of this machine."""
 151         self.add_match(_MACHINE_ID=_id128.get_machine().hex)
 152
 153 def _make_line(field, value):
 154         if isinstance(value, bytes):
 155                 return field.encode('utf-8') + b'=' + value
 156         else:
 157                 return field + '=' + value
 158
 159 def send(MESSAGE, MESSAGE_ID=None,
 160          CODE_FILE=None, CODE_LINE=None, CODE_FUNC=None,
 161          **kwargs):
 162         r"""Send a message to the journal.
 163
 164         >>> journal.send('Hello world')
 165         >>> journal.send('Hello, again, world', FIELD2='Greetings!')
 166         >>> journal.send('Binary message', BINARY=b'\xde\xad\xbe\xef')
 167
 168         Value of the MESSAGE argument will be used for the MESSAGE=
 169         field. MESSAGE must be a string and will be sent as UTF-8 to
 170         the journal.
 171
 172         MESSAGE_ID can be given to uniquely identify the type of
 173         message. It must be a string or a uuid.UUID object.
 174
 175         CODE_LINE, CODE_FILE, and CODE_FUNC can be specified to
 176         identify the caller. Unless at least on of the three is given,
 177         values are extracted from the stack frame of the caller of
 178         send(). CODE_FILE and CODE_FUNC must be strings, CODE_LINE
 179         must be an integer.
 180
 181         Additional fields for the journal entry can only be specified
 182         as keyword arguments. The payload can be either a string or
 183         bytes. A string will be sent as UTF-8, and bytes will be sent
 184         as-is to the journal.
 185
 186         Other useful fields include PRIORITY, SYSLOG_FACILITY,
 187         SYSLOG_IDENTIFIER, SYSLOG_PID.
 188         """
 189
 190         args = ['MESSAGE=' + MESSAGE]
 191
 192         if MESSAGE_ID is not None:
 193                 id = getattr(MESSAGE_ID, 'hex', MESSAGE_ID)
 194                 args.append('MESSAGE_ID=' + id)
 195
 196         if CODE_LINE == CODE_FILE == CODE_FUNC == None:
 197                 CODE_FILE, CODE_LINE, CODE_FUNC = \
 198                         _traceback.extract_stack(limit=2)[0][:3]
 199         if CODE_FILE is not None:
 200                 args.append('CODE_FILE=' + CODE_FILE)
 201         if CODE_LINE is not None:
 202                 args.append('CODE_LINE={:d}'.format(CODE_LINE))
 203         if CODE_FUNC is not None:
 204                 args.append('CODE_FUNC=' + CODE_FUNC)
 205
 206         args.extend(_make_line(key, val) for key, val in kwargs.items())
 207         return sendv(*args)
 208
 209 def stream(identifier, priority=LOG_DEBUG, level_prefix=False):
 210         r"""Return a file object wrapping a stream to journal.
 211
 212         Log messages written to this file as simple newline sepearted
 213         text strings are written to the journal.
 214
 215         The file will be line buffered, so messages are actually sent
 216         after a newline character is written.
 217
 218         >>> stream = journal.stream('myapp')
 219         >>> stream
 220         <open file '<fdopen>', mode 'w' at 0x...>
 221         >>> stream.write('message...\n')
 222
 223         will produce the following message in the journal::
 224
 225           PRIORITY=7
 226           SYSLOG_IDENTIFIER=myapp
 227           MESSAGE=message...
 228
 229         Using the interface with print might be more convinient:
 230
 231         >>> from __future__ import print_function
 232         >>> print('message...', file=stream)
 233
 234         priority is the syslog priority, one of `LOG_EMERG`,
 235         `LOG_ALERT`, `LOG_CRIT`, `LOG_ERR`, `LOG_WARNING`,
 236         `LOG_NOTICE`, `LOG_INFO`, `LOG_DEBUG`.
 237
 238         level_prefix is a boolean. If true, kernel-style log priority
 239         level prefixes (such as '<1>') are interpreted. See
 240         sd-daemon(3) for more information.
 241         """
 242
 243         fd = stream_fd(identifier, priority, level_prefix)
 244         return _os.fdopen(fd, 'w', 1)
 245
 246 class JournalHandler(_logging.Handler):
 247         """Journal handler class for the Python logging framework.
 248
 249         Please see the Python logging module documentation for an
 250         overview: http://docs.python.org/library/logging.html.
 251
 252         To create a custom logger whose messages go only to journal:
 253
 254         >>> log = logging.getLogger('custom_logger_name')
 255         >>> log.propagate = False
 256         >>> log.addHandler(journal.JournalHandler())
 257         >>> log.warn("Some message: %s", detail)
 258
 259         Note that by default, message levels `INFO` and `DEBUG` are
 260         ignored by the logging framework. To enable those log levels:
 261
 262         >>> log.setLevel(logging.DEBUG)
 263
 264         To attach journal MESSAGE_ID, an extra field is supported:
 265
 266         >>> import uuid
 267         >>> mid = uuid.UUID('0123456789ABCDEF0123456789ABCDEF')
 268         >>> log.warn("Message with ID", extra={'MESSAGE_ID': mid})
 269
 270         To redirect all logging messages to journal regardless of where
 271         they come from, attach it to the root logger:
 272
 273         >>> logging.root.addHandler(journal.JournalHandler())
 274
 275         For more complex configurations when using `dictConfig` or
 276         `fileConfig`, specify `systemd.journal.JournalHandler` as the
 277         handler class.  Only standard handler configuration options
 278         are supported: `level`, `formatter`, `filters`.
 279
 280         The following journal fields will be sent:
 281         `MESSAGE`, `PRIORITY`, `THREAD_NAME`, `CODE_FILE`, `CODE_LINE`,
 282         `CODE_FUNC`, `LOGGER` (name as supplied to getLogger call),
 283         `MESSAGE_ID` (optional, see above).
 284         """
 285
 286         def emit(self, record):
 287                 """Write record as journal event.
 288
 289                 MESSAGE is taken from the message provided by the
 290                 user, and PRIORITY, LOGGER, THREAD_NAME,
 291                 CODE_{FILE,LINE,FUNC} fields are appended
 292                 automatically. In addition, record.MESSAGE_ID will be
 293                 used if present.
 294                 """
 295                 try:
 296                         msg = self.format(record)
 297                         pri = self.mapPriority(record.levelno)
 298                         mid = getattr(record, 'MESSAGE_ID', None)
 299                         send(msg,
 300                              MESSAGE_ID=mid,
 301                              PRIORITY=format(pri),
 302                              LOGGER=record.name,
 303                              THREAD_NAME=record.threadName,
 304                              CODE_FILE=record.pathname,
 305                              CODE_LINE=record.lineno,
 306                              CODE_FUNC=record.funcName)
 307                 except Exception:
 308                         self.handleError(record)
 309
 310         @staticmethod
 311         def mapPriority(levelno):
 312                 """Map logging levels to journald priorities.
 313
 314                 Since Python log level numbers are "sparse", we have
 315                 to map numbers in between the standard levels too.
 316                 """
 317                 if levelno <= _logging.DEBUG:
 318                         return LOG_DEBUG
 319                 elif levelno <= _logging.INFO:
 320                         return LOG_INFO
 321                 elif levelno <= _logging.WARNING:
 322                         return LOG_WARNING
 323                 elif levelno <= _logging.ERROR:
 324                         return LOG_ERR
 325                 elif levelno <= _logging.CRITICAL:
 326                         return LOG_CRIT
 327                 else:
 328                         return LOG_ALERT