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 from syslog import (LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR,
30 LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG)
31 from ._journal import sendv, stream_fd
32 from ._reader import (_Journal, NOP, APPEND, INVALIDATE,
33 LOCAL_ONLY, RUNTIME_ONLY, SYSTEM_ONLY)
35 _MONOTONIC_CONVERTER = lambda x: datetime.timedelta(microseconds=float(x))
36 _REALTIME_CONVERTER = lambda x: datetime.datetime.fromtimestamp(float(x)/1E6)
37 DEFAULT_CONVERTERS = {
38 'MESSAGE_ID': uuid.UUID,
42 'USERSPACE_USEC': int,
48 'SYSLOG_FACILITY': int,
50 '_AUDIT_SESSION': int,
51 '_AUDIT_LOGINUID': int,
52 '_SYSTEMD_SESSION': int,
53 '_SYSTEMD_OWNER_UID': int,
57 '_SOURCE_REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
58 '__REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
59 '_SOURCE_MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
60 '__MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
65 'COREDUMP_SESSION': int,
66 'COREDUMP_SIGNAL': int,
67 'COREDUMP_TIMESTAMP': _REALTIME_CONVERTER,
70 if sys.version_info >= (3,):
71 _convert_unicode = functools.partial(str, encoding='utf-8')
73 _convert_unicode = functools.partial(unicode, encoding='utf-8')
75 class Journal(_Journal):
76 def __init__(self, converters=None, *args, **kwargs):
77 super(Journal, self).__init__(*args, **kwargs)
78 if sys.version_info >= (3,3):
79 self.converters = ChainMap()
80 if converters is not None:
81 self.converters.maps.append(converters)
82 self.converters.maps.append(DEFAULT_CONVERTERS)
84 # suitable fallback, e.g.
85 self.converters = DEFAULT_CONVERTERS.copy()
86 if converters is not None:
87 self.converters.update(converters)
89 def _convert_field(self, key, value):
91 result = self.converters[key](value)
93 # Default conversion in unicode
95 result = _convert_unicode(value)
97 # Leave in default bytes
101 def _convert_entry(self, entry):
103 for key, value in entry.iteritems():
104 if isinstance(value, list):
105 result[key] = [self._convert_field(key, val) for val in value]
107 result[key] = self._convert_field(key, value)
110 def get_next(self, *args, **kwargs):
111 return self._convert_entry(
112 super(Journal, self).get_next(*args, **kwargs))
114 def query_unique(self, key, *args, **kwargs):
115 return set(self._convert_field(key, value)
116 for value in super(Journal, self).query_unique(key, *args, **kwargs))
118 def log_level(self, level):
119 """Sets maximum log level by setting matches for PRIORITY."""
121 for i in range(level+1):
122 self.add_match(PRIORITY="%s" % i)
124 raise ValueError("Log level must be 0 <= level <= 7")
126 def _make_line(field, value):
127 if isinstance(value, bytes):
128 return field.encode('utf-8') + b'=' + value
130 return field + '=' + value
132 def send(MESSAGE, MESSAGE_ID=None,
133 CODE_FILE=None, CODE_LINE=None, CODE_FUNC=None,
135 r"""Send a message to the journal.
137 >>> journal.send('Hello world')
138 >>> journal.send('Hello, again, world', FIELD2='Greetings!')
139 >>> journal.send('Binary message', BINARY=b'\xde\xad\xbe\xef')
141 Value of the MESSAGE argument will be used for the MESSAGE=
142 field. MESSAGE must be a string and will be sent as UTF-8 to
145 MESSAGE_ID can be given to uniquely identify the type of
146 message. It must be a string or a uuid.UUID object.
148 CODE_LINE, CODE_FILE, and CODE_FUNC can be specified to
149 identify the caller. Unless at least on of the three is given,
150 values are extracted from the stack frame of the caller of
151 send(). CODE_FILE and CODE_FUNC must be strings, CODE_LINE
154 Additional fields for the journal entry can only be specified
155 as keyword arguments. The payload can be either a string or
156 bytes. A string will be sent as UTF-8, and bytes will be sent
157 as-is to the journal.
159 Other useful fields include PRIORITY, SYSLOG_FACILITY,
160 SYSLOG_IDENTIFIER, SYSLOG_PID.
163 args = ['MESSAGE=' + MESSAGE]
165 if MESSAGE_ID is not None:
166 id = getattr(MESSAGE_ID, 'hex', MESSAGE_ID)
167 args.append('MESSAGE_ID=' + id)
169 if CODE_LINE == CODE_FILE == CODE_FUNC == None:
170 CODE_FILE, CODE_LINE, CODE_FUNC = \
171 _traceback.extract_stack(limit=2)[0][:3]
172 if CODE_FILE is not None:
173 args.append('CODE_FILE=' + CODE_FILE)
174 if CODE_LINE is not None:
175 args.append('CODE_LINE={:d}'.format(CODE_LINE))
176 if CODE_FUNC is not None:
177 args.append('CODE_FUNC=' + CODE_FUNC)
179 args.extend(_make_line(key, val) for key, val in kwargs.items())
182 def stream(identifier, priority=LOG_DEBUG, level_prefix=False):
183 r"""Return a file object wrapping a stream to journal.
185 Log messages written to this file as simple newline sepearted
186 text strings are written to the journal.
188 The file will be line buffered, so messages are actually sent
189 after a newline character is written.
191 >>> stream = journal.stream('myapp')
193 <open file '<fdopen>', mode 'w' at 0x...>
194 >>> stream.write('message...\n')
196 will produce the following message in the journal::
199 SYSLOG_IDENTIFIER=myapp
202 Using the interface with print might be more convinient:
204 >>> from __future__ import print_function
205 >>> print('message...', file=stream)
207 priority is the syslog priority, one of `LOG_EMERG`,
208 `LOG_ALERT`, `LOG_CRIT`, `LOG_ERR`, `LOG_WARNING`,
209 `LOG_NOTICE`, `LOG_INFO`, `LOG_DEBUG`.
211 level_prefix is a boolean. If true, kernel-style log priority
212 level prefixes (such as '<1>') are interpreted. See
213 sd-daemon(3) for more information.
216 fd = stream_fd(identifier, priority, level_prefix)
217 return _os.fdopen(fd, 'w', 1)
219 class JournalHandler(_logging.Handler):
220 """Journal handler class for the Python logging framework.
222 Please see the Python logging module documentation for an
223 overview: http://docs.python.org/library/logging.html.
225 To create a custom logger whose messages go only to journal:
227 >>> log = logging.getLogger('custom_logger_name')
228 >>> log.propagate = False
229 >>> log.addHandler(journal.JournalHandler())
230 >>> log.warn("Some message: %s", detail)
232 Note that by default, message levels `INFO` and `DEBUG` are
233 ignored by the logging framework. To enable those log levels:
235 >>> log.setLevel(logging.DEBUG)
237 To attach journal MESSAGE_ID, an extra field is supported:
240 >>> mid = uuid.UUID('0123456789ABCDEF0123456789ABCDEF')
241 >>> log.warn("Message with ID", extra={'MESSAGE_ID': mid})
243 To redirect all logging messages to journal regardless of where
244 they come from, attach it to the root logger:
246 >>> logging.root.addHandler(journal.JournalHandler())
248 For more complex configurations when using `dictConfig` or
249 `fileConfig`, specify `systemd.journal.JournalHandler` as the
250 handler class. Only standard handler configuration options
251 are supported: `level`, `formatter`, `filters`.
253 The following journal fields will be sent:
254 `MESSAGE`, `PRIORITY`, `THREAD_NAME`, `CODE_FILE`, `CODE_LINE`,
255 `CODE_FUNC`, `LOGGER` (name as supplied to getLogger call),
256 `MESSAGE_ID` (optional, see above).
259 def emit(self, record):
260 """Write record as journal event.
262 MESSAGE is taken from the message provided by the
263 user, and PRIORITY, LOGGER, THREAD_NAME,
264 CODE_{FILE,LINE,FUNC} fields are appended
265 automatically. In addition, record.MESSAGE_ID will be
269 msg = self.format(record)
270 pri = self.mapPriority(record.levelno)
271 mid = getattr(record, 'MESSAGE_ID', None)
274 PRIORITY=format(pri),
276 THREAD_NAME=record.threadName,
277 CODE_FILE=record.pathname,
278 CODE_LINE=record.lineno,
279 CODE_FUNC=record.funcName)
281 self.handleError(record)
284 def mapPriority(levelno):
285 """Map logging levels to journald priorities.
287 Since Python log level numbers are "sparse", we have
288 to map numbers in between the standard levels too.
290 if levelno <= _logging.DEBUG:
292 elif levelno <= _logging.INFO:
294 elif levelno <= _logging.WARNING:
296 elif levelno <= _logging.ERROR:
298 elif levelno <= _logging.CRITICAL: