# 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 sys as _sys
+import datetime as _datetime
+import functools as _functools
+import uuid as _uuid
import traceback as _traceback
import os as _os
+from os import SEEK_SET, SEEK_CUR, SEEK_END
import logging as _logging
+if _sys.version_info >= (3,):
+ from collections import ChainMap
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)
+from . import id128 as _id128
-_MONOTONIC_CONVERTER = lambda x: datetime.timedelta(microseconds=float(x))
-_REALTIME_CONVERTER = lambda x: datetime.datetime.fromtimestamp(float(x)/1E6)
+_MONOTONIC_CONVERTER = lambda x: _datetime.timedelta(microseconds=float(x))
+_REALTIME_CONVERTER = lambda x: _datetime.datetime.fromtimestamp(float(x)/1E6)
DEFAULT_CONVERTERS = {
- 'MESSAGE_ID': uuid.UUID,
+ 'MESSAGE_ID': _uuid.UUID,
+ '_MACHINE_ID': _uuid.UUID,
+ '_BOOT_ID': _uuid.UUID,
'PRIORITY': int,
'LEADER': int,
'SESSION_ID': int,
'COREDUMP_TIMESTAMP': _REALTIME_CONVERTER,
}
-if sys.version_info >= (3,):
- _convert_unicode = functools.partial(str, encoding='utf-8')
+if _sys.version_info >= (3,):
+ _convert_unicode = _functools.partial(str, encoding='utf-8')
else:
- _convert_unicode = functools.partial(unicode, encoding='utf-8')
+ _convert_unicode = _functools.partial(unicode, encoding='utf-8')
class Journal(_Journal):
- def __init__(self, converters=None, *args, **kwargs):
- super(Journal, self).__init__(*args, **kwargs)
- if sys.version_info >= (3,3):
+ def __init__(self, converters=None, flags=LOCAL_ONLY, path=None):
+ """Creates instance of Journal, which allows filtering and
+ return of journal entries.
+ Argument `converters` is a dictionary which updates the
+ DEFAULT_CONVERTERS to convert journal field values.
+ Argument `flags` sets open flags of the journal, which can be one
+ of, or ORed combination of constants: LOCAL_ONLY (default) opens
+ journal on local machine only; RUNTIME_ONLY opens only
+ volatile journal files; and SYSTEM_ONLY opens only
+ journal files of system services and the kernel.
+ Argument `path` is the directory of journal files. Note that
+ currently flags are ignored when `path` is present as they are
+ currently not relevant.
+ """
+ super(Journal, self).__init__(flags, path)
+ if _sys.version_info >= (3,3):
self.converters = ChainMap()
if converters is not None:
self.converters.maps.append(converters)
self.converters.maps.append(DEFAULT_CONVERTERS)
else:
- # suitable fallback, e.g.
self.converters = DEFAULT_CONVERTERS.copy()
if converters is not None:
self.converters.update(converters)
def _convert_field(self, key, value):
+ """ Convert value based on callable from self.converters
+ based of field/key"""
try:
result = self.converters[key](value)
- except KeyError:
+ except:
# Default conversion in unicode
try:
result = _convert_unicode(value)
return result
def _convert_entry(self, entry):
+ """ Convert entire journal entry utilising _covert_field"""
result = {}
- for key, value in entry.iteritems():
+ for key, value in entry.items():
if isinstance(value, list):
result[key] = [self._convert_field(key, val) for val in value]
else:
result[key] = self._convert_field(key, value)
return result
- def get_next(self, *args, **kwargs):
+ def add_match(self, *args, **kwargs):
+ """Add one or more matches to the filter journal log entries.
+ All matches of different field are combined in a logical AND,
+ and matches of the smae field are automatically combined in a
+ logical OR.
+ Matches can be passed as strings of form "field=value", or
+ keyword arguments field="value"."""
+ args = list(args)
+ args.extend(_make_line(key, val) for key, val in kwargs.items())
+ for arg in args:
+ super(Journal, self).add_match(arg)
+
+ def get_next(self, skip=1):
+ """Return dictionary of the next log entry. Optional skip value
+ will return the `skip`th log entry.
+ Returned will be journal entry dictionary processed with
+ converters."""
return self._convert_entry(
- super(Journal, self).get_next(*args, **kwargs))
-
- def query_unique(self, key, *args, **kwargs):
- return set(self._convert_field(key, value)
- for value in super(Journal, self).query_unique(key, *args, **kwargs))
+ super(Journal, self).get_next(skip))
+
+ def query_unique(self, field):
+ """Returns a set of unique values in journal for given `field`,
+ processed with converters.
+ Note this does not respect any journal matches."""
+ return set(self._convert_field(field, value)
+ for value in super(Journal, self).query_unique(field))
+
+ def seek_realtime(self, realtime):
+ """Seek to nearest matching journal entry to `realtime`.
+ Argument `realtime` can must be either an integer unix timestamp
+ or datetime.datetime instance."""
+ if isinstance(realtime, _datetime.datetime):
+ realtime = float(realtime.strftime("%s.%f"))
+ return super(Journal, self).seek_realtime(realtime)
+
+ def seek_monotonic(self, monotonic, bootid=None):
+ """Seek to nearest matching journal entry to `monotonic`.
+ Argument `monotonic` is a timestamp from boot in either seconds
+ or a datetime.timedelta instance.
+ Argument `bootid` is a string or UUID representing which boot the
+ monotonic time is reference to. Defaults to current bootid."""
+ if isinstance(monotonic, _datetime.timedelta):
+ monotonic = monotonic.totalseconds()
+ if isinstance(bootid, _uuid.UUID):
+ bootid = bootid.get_hex()
+ return super(Journal, self).seek_monotonic(monotonic, bootid)
def log_level(self, level):
- """Sets maximum log level by setting matches for PRIORITY."""
+ """Sets maximum log `level` by setting matches for PRIORITY."""
if 0 <= level <= 7:
for i in range(level+1):
self.add_match(PRIORITY="%s" % i)
else:
raise ValueError("Log level must be 0 <= level <= 7")
+ def this_boot(self, bootid=None):
+ """Add match for _BOOT_ID equal to current boot ID or the specified boot ID.
+
+ If specified, bootid should be either a UUID or a 32 digit hex number.
+
+ Equivalent to add_match(_BOOT_ID='bootid').
+ """
+ if bootid is None:
+ bootid = _id128.get_boot().hex
+ else:
+ bootid = getattr(bootid, 'hex', bootid)
+ self.add_match(_BOOT_ID=bootid)
+
+ def this_machine(self, machineid=None):
+ """Add match for _MACHINE_ID equal to the ID of this machine.
+
+ If specified, machineid should be either a UUID or a 32 digit hex number.
+
+ Equivalent to add_match(_MACHINE_ID='machineid').
+ """
+ if machineid is None:
+ machineid = _id128.get_machine().hex
+ else:
+ machineid = getattr(machineid, 'hex', machineid)
+ self.add_match(_MACHINE_ID=machineid)
+
+
def _make_line(field, value):
if isinstance(value, bytes):
return field.encode('utf-8') + b'=' + value
~ianmdlvl / elogind.git / blobdiff