1 # -*- Mode: python; coding:utf-8; indent-tabs-mode: nil -*- */
3 # This file is part of systemd.
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>
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.
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.
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/>.
22 from __future__ import division
25 import datetime as _datetime
26 import functools as _functools
28 import traceback as _traceback
30 from os import SEEK_SET, SEEK_CUR, SEEK_END
31 import logging as _logging
32 if _sys.version_info >= (3,):
33 from collections import ChainMap as _ChainMap
34 from syslog import (LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR,
35 LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG)
36 from ._journal import sendv, stream_fd
37 from ._reader import (_Journal, NOP, APPEND, INVALIDATE,
38 LOCAL_ONLY, RUNTIME_ONLY, SYSTEM_ONLY)
39 from . import id128 as _id128
41 if _sys.version_info >= (3,):
42 from ._reader import Monotonic
46 _MONOTONIC_CONVERTER = lambda p: Monotonic((_datetime.timedelta(microseconds=p[0]),
47 _uuid.UUID(bytes=p[1])))
48 _REALTIME_CONVERTER = lambda x: _datetime.datetime.fromtimestamp(x / 1E6)
49 DEFAULT_CONVERTERS = {
50 'MESSAGE_ID': _uuid.UUID,
51 '_MACHINE_ID': _uuid.UUID,
52 '_BOOT_ID': _uuid.UUID,
56 'USERSPACE_USEC': int,
62 'SYSLOG_FACILITY': int,
64 '_AUDIT_SESSION': int,
65 '_AUDIT_LOGINUID': int,
66 '_SYSTEMD_SESSION': int,
67 '_SYSTEMD_OWNER_UID': int,
71 '_SOURCE_REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
72 '__REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
73 '_SOURCE_MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
74 '__MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
79 'COREDUMP_SESSION': int,
80 'COREDUMP_SIGNAL': int,
81 'COREDUMP_TIMESTAMP': _REALTIME_CONVERTER,
84 if _sys.version_info >= (3,):
85 _convert_unicode = _functools.partial(str, encoding='utf-8')
87 _convert_unicode = _functools.partial(unicode, encoding='utf-8')
89 class Journal(_Journal):
90 """Journal allows the access and filtering of systemd journal
91 entries. Note that in order to access the system journal, a
92 non-root user must be in the `adm` group.
94 Example usage to print out all error or higher level messages
95 for systemd-udevd for the boot:
97 >>> myjournal = journal.Journal()
98 >>> myjournal.add_boot_match(journal.CURRENT_BOOT)
99 >>> myjournal.add_loglevel_matches(journal.LOG_ERR)
100 >>> myjournal.add_match(_SYSTEMD_UNIT="systemd-udevd.service")
101 >>> for entry in myjournal:
102 ... print(entry['MESSAGE'])
104 See systemd.journal-fields(7) for more info on typical fields
105 found in the journal.
107 def __init__(self, converters=None, flags=LOCAL_ONLY, path=None):
108 """Creates instance of Journal, which allows filtering and
109 return of journal entries.
110 Argument `converters` is a dictionary which updates the
111 DEFAULT_CONVERTERS to convert journal field values.
112 Argument `flags` sets open flags of the journal, which can be one
113 of, or ORed combination of constants: LOCAL_ONLY (default) opens
114 journal on local machine only; RUNTIME_ONLY opens only
115 volatile journal files; and SYSTEM_ONLY opens only
116 journal files of system services and the kernel.
117 Argument `path` is the directory of journal files. Note that
118 currently flags are ignored when `path` is present as they are
119 currently not relevant.
121 super(Journal, self).__init__(flags, path)
122 if _sys.version_info >= (3,3):
123 self.converters = _ChainMap()
124 if converters is not None:
125 self.converters.maps.append(converters)
126 self.converters.maps.append(DEFAULT_CONVERTERS)
128 self.converters = DEFAULT_CONVERTERS.copy()
129 if converters is not None:
130 self.converters.update(converters)
132 def _convert_field(self, key, value):
133 """Convert value based on callable from self.converters
134 based of field/key"""
136 result = self.converters[key](value)
138 # Default conversion in unicode
140 result = _convert_unicode(value)
141 except UnicodeDecodeError:
142 # Leave in default bytes
146 def _convert_entry(self, entry):
147 """Convert entire journal entry utilising _covert_field"""
149 for key, value in entry.items():
150 if isinstance(value, list):
151 result[key] = [self._convert_field(key, val) for val in value]
153 result[key] = self._convert_field(key, value)
156 def add_match(self, *args, **kwargs):
157 """Add one or more matches to the filter journal log entries.
158 All matches of different field are combined in a logical AND,
159 and matches of the same field are automatically combined in a
161 Matches can be passed as strings of form "FIELD=value", or
162 keyword arguments FIELD="value".
165 args.extend(_make_line(key, val) for key, val in kwargs.items())
167 super(Journal, self).add_match(arg)
169 def get_next(self, skip=1):
170 """Return the next log entry as a dictionary of fields.
172 Optional skip value will return the `skip`\-th log entry.
174 Entries will be processed with converters specified during
177 return self._convert_entry(
178 super(Journal, self).get_next(skip))
180 def query_unique(self, field):
181 """Return unique values appearing in the Journal for given `field`.
183 Note this does not respect any journal matches.
185 Entries will be processed with converters specified during
188 return set(self._convert_field(field, value)
189 for value in super(Journal, self).query_unique(field))
191 def seek_realtime(self, realtime):
192 """Seek to a matching journal entry nearest to `realtime` time.
194 Argument `realtime` must be either an integer unix timestamp
195 or datetime.datetime instance.
197 if isinstance(realtime, _datetime.datetime):
198 realtime = float(realtime.strftime("%s.%f"))
199 return super(Journal, self).seek_realtime(realtime)
201 def seek_monotonic(self, monotonic, bootid=None):
202 """Seek to a matching journal entry nearest to `monotonic` time.
204 Argument `monotonic` is a timestamp from boot in either
205 seconds or a datetime.timedelta instance. Argument `bootid`
206 is a string or UUID representing which boot the monotonic time
207 is reference to. Defaults to current bootid.
209 if isinstance(monotonic, _datetime.timedelta):
210 monotonic = monotonic.totalseconds()
211 if isinstance(bootid, _uuid.UUID):
212 bootid = bootid.get_hex()
213 return super(Journal, self).seek_monotonic(monotonic, bootid)
215 def log_level(self, level):
216 """Set maximum log `level` by setting matches for PRIORITY.
219 for i in range(level+1):
220 self.add_match(PRIORITY="%s" % i)
222 raise ValueError("Log level must be 0 <= level <= 7")
224 def messageid_match(self, messageid):
225 """Add match for log entries with specified `messageid`.
227 `messageid` can be string of hexadicimal digits or a UUID
228 instance. Standard message IDs can be found in systemd.id128.
230 Equivalent to add_match(MESSAGE_ID=`messageid`).
232 if isinstance(messageid, _uuid.UUID):
233 messageid = messageid.get_hex()
234 self.add_match(MESSAGE_ID=messageid)
236 def this_boot(self, bootid=None):
237 """Add match for _BOOT_ID equal to current boot ID or the specified boot ID.
239 If specified, bootid should be either a UUID or a 32 digit hex number.
241 Equivalent to add_match(_BOOT_ID='bootid').
244 bootid = _id128.get_boot().hex
246 bootid = getattr(bootid, 'hex', bootid)
247 self.add_match(_BOOT_ID=bootid)
249 def this_machine(self, machineid=None):
250 """Add match for _MACHINE_ID equal to the ID of this machine.
252 If specified, machineid should be either a UUID or a 32 digit hex number.
254 Equivalent to add_match(_MACHINE_ID='machineid').
256 if machineid is None:
257 machineid = _id128.get_machine().hex
259 machineid = getattr(machineid, 'hex', machineid)
260 self.add_match(_MACHINE_ID=machineid)
263 def _make_line(field, value):
264 if isinstance(value, bytes):
265 return field.encode('utf-8') + b'=' + value
267 return field + '=' + value
269 def send(MESSAGE, MESSAGE_ID=None,
270 CODE_FILE=None, CODE_LINE=None, CODE_FUNC=None,
272 r"""Send a message to the journal.
274 >>> journal.send('Hello world')
275 >>> journal.send('Hello, again, world', FIELD2='Greetings!')
276 >>> journal.send('Binary message', BINARY=b'\xde\xad\xbe\xef')
278 Value of the MESSAGE argument will be used for the MESSAGE=
279 field. MESSAGE must be a string and will be sent as UTF-8 to
282 MESSAGE_ID can be given to uniquely identify the type of
283 message. It must be a string or a uuid.UUID object.
285 CODE_LINE, CODE_FILE, and CODE_FUNC can be specified to
286 identify the caller. Unless at least on of the three is given,
287 values are extracted from the stack frame of the caller of
288 send(). CODE_FILE and CODE_FUNC must be strings, CODE_LINE
291 Additional fields for the journal entry can only be specified
292 as keyword arguments. The payload can be either a string or
293 bytes. A string will be sent as UTF-8, and bytes will be sent
294 as-is to the journal.
296 Other useful fields include PRIORITY, SYSLOG_FACILITY,
297 SYSLOG_IDENTIFIER, SYSLOG_PID.
300 args = ['MESSAGE=' + MESSAGE]
302 if MESSAGE_ID is not None:
303 id = getattr(MESSAGE_ID, 'hex', MESSAGE_ID)
304 args.append('MESSAGE_ID=' + id)
306 if CODE_LINE == CODE_FILE == CODE_FUNC == None:
307 CODE_FILE, CODE_LINE, CODE_FUNC = \
308 _traceback.extract_stack(limit=2)[0][:3]
309 if CODE_FILE is not None:
310 args.append('CODE_FILE=' + CODE_FILE)
311 if CODE_LINE is not None:
312 args.append('CODE_LINE={:d}'.format(CODE_LINE))
313 if CODE_FUNC is not None:
314 args.append('CODE_FUNC=' + CODE_FUNC)
316 args.extend(_make_line(key, val) for key, val in kwargs.items())
319 def stream(identifier, priority=LOG_DEBUG, level_prefix=False):
320 r"""Return a file object wrapping a stream to journal.
322 Log messages written to this file as simple newline sepearted
323 text strings are written to the journal.
325 The file will be line buffered, so messages are actually sent
326 after a newline character is written.
328 >>> stream = journal.stream('myapp')
330 <open file '<fdopen>', mode 'w' at 0x...>
331 >>> stream.write('message...\n')
333 will produce the following message in the journal::
336 SYSLOG_IDENTIFIER=myapp
339 Using the interface with print might be more convinient:
341 >>> from __future__ import print_function
342 >>> print('message...', file=stream)
344 priority is the syslog priority, one of `LOG_EMERG`,
345 `LOG_ALERT`, `LOG_CRIT`, `LOG_ERR`, `LOG_WARNING`,
346 `LOG_NOTICE`, `LOG_INFO`, `LOG_DEBUG`.
348 level_prefix is a boolean. If true, kernel-style log priority
349 level prefixes (such as '<1>') are interpreted. See
350 sd-daemon(3) for more information.
353 fd = stream_fd(identifier, priority, level_prefix)
354 return _os.fdopen(fd, 'w', 1)
356 class JournalHandler(_logging.Handler):
357 """Journal handler class for the Python logging framework.
359 Please see the Python logging module documentation for an
360 overview: http://docs.python.org/library/logging.html.
362 To create a custom logger whose messages go only to journal:
364 >>> log = logging.getLogger('custom_logger_name')
365 >>> log.propagate = False
366 >>> log.addHandler(journal.JournalHandler())
367 >>> log.warn("Some message: %s", detail)
369 Note that by default, message levels `INFO` and `DEBUG` are
370 ignored by the logging framework. To enable those log levels:
372 >>> log.setLevel(logging.DEBUG)
374 To attach journal MESSAGE_ID, an extra field is supported:
377 >>> mid = uuid.UUID('0123456789ABCDEF0123456789ABCDEF')
378 >>> log.warn("Message with ID", extra={'MESSAGE_ID': mid})
380 To redirect all logging messages to journal regardless of where
381 they come from, attach it to the root logger:
383 >>> logging.root.addHandler(journal.JournalHandler())
385 For more complex configurations when using `dictConfig` or
386 `fileConfig`, specify `systemd.journal.JournalHandler` as the
387 handler class. Only standard handler configuration options
388 are supported: `level`, `formatter`, `filters`.
390 The following journal fields will be sent:
391 `MESSAGE`, `PRIORITY`, `THREAD_NAME`, `CODE_FILE`, `CODE_LINE`,
392 `CODE_FUNC`, `LOGGER` (name as supplied to getLogger call),
393 `MESSAGE_ID` (optional, see above).
396 def emit(self, record):
397 """Write record as journal event.
399 MESSAGE is taken from the message provided by the
400 user, and PRIORITY, LOGGER, THREAD_NAME,
401 CODE_{FILE,LINE,FUNC} fields are appended
402 automatically. In addition, record.MESSAGE_ID will be
406 msg = self.format(record)
407 pri = self.mapPriority(record.levelno)
408 mid = getattr(record, 'MESSAGE_ID', None)
411 PRIORITY=format(pri),
413 THREAD_NAME=record.threadName,
414 CODE_FILE=record.pathname,
415 CODE_LINE=record.lineno,
416 CODE_FUNC=record.funcName)
418 self.handleError(record)
421 def mapPriority(levelno):
422 """Map logging levels to journald priorities.
424 Since Python log level numbers are "sparse", we have
425 to map numbers in between the standard levels too.
427 if levelno <= _logging.DEBUG:
429 elif levelno <= _logging.INFO:
431 elif levelno <= _logging.WARNING:
433 elif levelno <= _logging.ERROR:
435 elif levelno <= _logging.CRITICAL: