1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
python-systemd
===============
Python module for native access to the systemd facilities. Functionality
is separated into a number of modules:
- systemd.journal supports sending of structured messages to the journal
and reading journal files,
- systemd.daemon wraps parts of libsystemd useful for writing daemons
and socket activation,
- systemd.id128 provides functions for querying machine and boot identifiers
and a lists of message identifiers provided by systemd,
- systemd.login wraps parts of libsystemd used to query logged in users
and available seats and machines.
Installation
============
This module should be packaged for almost all Linux distributions. Use
On Fedora/RHEL/CentOS
dnf install python-systemd python3-systemd
On Debian/Ubuntu/Mint
apt-get install python-systemd python3-systemd
On openSUSE and SLE
zypper in python-systemd
To build from source
--------------------
On CentOS, RHEL, and Fedora with Python 2:
dnf install git python-pip gcc python-devel systemd-devel
pip install git+https://github.com/systemd/python-systemd.git#egg=systemd
On Fedora with Python 3:
dnf install git python3-pip gcc python3-devel systemd-devel
pip3 install git+https://github.com/systemd/python-systemd.git#egg=systemd
On Debian or Ubuntu with Python 2:
apt-get install libsystemd-{journal,daemon,login,id128}-dev gcc python-dev pkg-config
On Debian or Ubuntu with Python 3:
apt-get install libsystemd-{journal,daemon,login,id128}-dev gcc python3-dev pkg-config
The project is also available on pypi as `systemd-python`.
Usage
=====
Quick example:
from systemd import journal
journal.send('Hello world')
journal.send('Hello, again, world', FIELD2='Greetings!', FIELD3='Guten tag')
journal.send('Binary message', BINARY=b'\xde\xad\xbe\xef')
There is one required argument -- the message, and additional fields
can be specified as keyword arguments. Following the journald API, all
names are uppercase.
The journald sendv call can also be accessed directly:
from systemd import journal
journal.sendv('MESSAGE=Hello world')
journal.sendv('MESSAGE=Hello, again, world', 'FIELD2=Greetings!',
'FIELD3=Guten tag')
journal.sendv('MESSAGE=Binary message', b'BINARY=\xde\xad\xbe\xef')
The two examples should give the same results in the log.
Notes
-----
* Unlike the native C version of journald's sd_journal_send(),
printf-style substitution is not supported. Perform any
substitution using Python's % operator or .format() capabilities
first.
* A ValueError is raised if sd_journald_sendv() results in an error.
This might happen if there are no arguments or one of them is
invalid.
A handler class for the Python logging framework is also provided:
import logging
from systemd import journal
logger = logging.getLogger('custom_logger_name')
logger.addHandler(journal.JournalHandler())
logger.warning("Some message: %s", 'detail')
libsytemd version compatibility
-------------------------------
This module may be compiled against any version of libsystemd. At
compilation time, any functionality that is not available in that
version of systemd is disabled, and the resulting binary module will
depend on symbols that were available at compilation time. This means
that the resulting binary module is compatible with that or any later
version of libsystemd. To obtain maximum possible functionality, this
module must be compile against suitably recent libsystemd.
Documentation
=============
Online documentation can be found at [freedesktop.org](https://www.freedesktop.org/software/systemd/python-systemd/)
To build it locally run:
make sphinx-html
Or use any other builder, see `man sphinx-build` for a list. The compiled docs will be e.g. in `docs/html`.
Viewing Output
==============
Quick way to view output with all fields as it comes in:
sudo journalctl -f --output=json
Test Builds (for Development)
=============================
python setup.py build_ext -i
python
>>> from systemd import journal
>>> journal.send("Test")
[](https://semaphoreci.com/zbyszek/python-systemd)
|
