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/>.
26 import traceback as _traceback
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
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,
45 'USERSPACE_USEC': int,
51 'SYSLOG_FACILITY': int,
53 '_AUDIT_SESSION': int,
54 '_AUDIT_LOGINUID': int,
55 '_SYSTEMD_SESSION': int,
56 '_SYSTEMD_OWNER_UID': int,
60 '_SOURCE_REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
61 '__REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
62 '_SOURCE_MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
63 '__MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
68 'COREDUMP_SESSION': int,
69 'COREDUMP_SIGNAL': int,
70 'COREDUMP_TIMESTAMP': _REALTIME_CONVERTER,
73 if sys.version_info >= (3,):
74 _convert_unicode = functools.partial(str, encoding='utf-8')
76 _convert_unicode = functools.partial(unicode, encoding='utf-8')
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)
87 # suitable fallback, e.g.
88 self.converters = DEFAULT_CONVERTERS.copy()
89 if converters is not None:
90 self.converters.update(converters)
92 def _convert_field(self, key, value):
94 result = self.converters[key](value)
96 # Default conversion in unicode
98 result = _convert_unicode(value)
100 # Leave in default bytes
104 def _convert_entry(self, entry):
106 for key, value in entry.items():
107 if isinstance(value, list):
108 result[key] = [self._convert_field(key, val) for val in value]
110 result[key] = self._convert_field(key, value)
113 def add_match(self, *args, **kwargs):
115 args.extend(_make_line(key, val) for key, val in kwargs.items())
117 super(Journal, self).add_match(arg)
119 def get_next(self, skip=1):
120 return self._convert_entry(
121 super(Journal, self).get_next(skip))
123 def query_unique(self, key):
124 return set(self._convert_field(key, value)
125 for value in super(Journal, self).query_unique(key))
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)
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)
137 def log_level(self, level):
138 """Sets maximum log level by setting matches for PRIORITY."""
140 for i in range(level+1):
141 self.add_match(PRIORITY="%s" % i)
143 raise ValueError("Log level must be 0 <= level <= 7")
146 """Add match for _BOOT_ID equal to current boot ID."""
147 self.add_match(_BOOT_ID=_id128.get_boot().hex)
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)
153 def _make_line(field, value):
154 if isinstance(value, bytes):
155 return field.encode('utf-8') + b'=' + value
157 return field + '=' + value
159 def send(MESSAGE, MESSAGE_ID=None,
160 CODE_FILE=None, CODE_LINE=None, CODE_FUNC=None,
162 r"""Send a message to the journal.
164 >>> journal.send('Hello world')
165 >>> journal.send('Hello, again, world', FIELD2='Greetings!')
166 >>> journal.send('Binary message', BINARY=b'\xde\xad\xbe\xef')
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
172 MESSAGE_ID can be given to uniquely identify the type of
173 message. It must be a string or a uuid.UUID object.
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
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.
186 Other useful fields include PRIORITY, SYSLOG_FACILITY,
187 SYSLOG_IDENTIFIER, SYSLOG_PID.
190 args = ['MESSAGE=' + MESSAGE]
192 if MESSAGE_ID is not None:
193 id = getattr(MESSAGE_ID, 'hex', MESSAGE_ID)
194 args.append('MESSAGE_ID=' + id)
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)
206 args.extend(_make_line(key, val) for key, val in kwargs.items())
209 def stream(identifier, priority=LOG_DEBUG, level_prefix=False):
210 r"""Return a file object wrapping a stream to journal.
212 Log messages written to this file as simple newline sepearted
213 text strings are written to the journal.
215 The file will be line buffered, so messages are actually sent
216 after a newline character is written.
218 >>> stream = journal.stream('myapp')
220 <open file '<fdopen>', mode 'w' at 0x...>
221 >>> stream.write('message...\n')
223 will produce the following message in the journal::
226 SYSLOG_IDENTIFIER=myapp
229 Using the interface with print might be more convinient:
231 >>> from __future__ import print_function
232 >>> print('message...', file=stream)
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`.
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.
243 fd = stream_fd(identifier, priority, level_prefix)
244 return _os.fdopen(fd, 'w', 1)
246 class JournalHandler(_logging.Handler):
247 """Journal handler class for the Python logging framework.
249 Please see the Python logging module documentation for an
250 overview: http://docs.python.org/library/logging.html.
252 To create a custom logger whose messages go only to journal:
254 >>> log = logging.getLogger('custom_logger_name')
255 >>> log.propagate = False
256 >>> log.addHandler(journal.JournalHandler())
257 >>> log.warn("Some message: %s", detail)
259 Note that by default, message levels `INFO` and `DEBUG` are
260 ignored by the logging framework. To enable those log levels:
262 >>> log.setLevel(logging.DEBUG)
264 To attach journal MESSAGE_ID, an extra field is supported:
267 >>> mid = uuid.UUID('0123456789ABCDEF0123456789ABCDEF')
268 >>> log.warn("Message with ID", extra={'MESSAGE_ID': mid})
270 To redirect all logging messages to journal regardless of where
271 they come from, attach it to the root logger:
273 >>> logging.root.addHandler(journal.JournalHandler())
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`.
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).
286 def emit(self, record):
287 """Write record as journal event.
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
296 msg = self.format(record)
297 pri = self.mapPriority(record.levelno)
298 mid = getattr(record, 'MESSAGE_ID', None)
301 PRIORITY=format(pri),
303 THREAD_NAME=record.threadName,
304 CODE_FILE=record.pathname,
305 CODE_LINE=record.lineno,
306 CODE_FUNC=record.funcName)
308 self.handleError(record)
311 def mapPriority(levelno):
312 """Map logging levels to journald priorities.
314 Since Python log level numbers are "sparse", we have
315 to map numbers in between the standard levels too.
317 if levelno <= _logging.DEBUG:
319 elif levelno <= _logging.INFO:
321 elif levelno <= _logging.WARNING:
323 elif levelno <= _logging.ERROR:
325 elif levelno <= _logging.CRITICAL: