]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd-journald.service.xml
man: document systemd-journal
[thirdparty/systemd.git] / man / systemd-journald.service.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6 This file is part of systemd.
7
8 Copyright 2010 Lennart Poettering
9
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
14
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="systemd-journald.service">
25
26 <refentryinfo>
27 <title>systemd-journald</title>
28 <productname>systemd</productname>
29
30 <authorgroup>
31 <author>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
36 </author>
37 </authorgroup>
38 </refentryinfo>
39
40 <refmeta>
41 <refentrytitle>systemd-journald</refentrytitle>
42 <manvolnum>8</manvolnum>
43 </refmeta>
44
45 <refnamediv>
46 <refname>systemd-journald.service</refname>
47 <refname>systemd-journald</refname>
48 <refpurpose>systemd Journal Service</refpurpose>
49 </refnamediv>
50
51 <refsynopsisdiv>
52 <para><filename>systemd-journald.service</filename></para>
53 <para><filename>/usr/lib/systemd/systemd-journald</filename></para>
54 </refsynopsisdiv>
55
56 <refsect1>
57 <title>Description</title>
58
59 <para><filename>systemd-journald</filename> is a
60 system service that collects and stores logging
61 data. It creates and maintains structured, indexed
62 journals based on logging information that is received
63 from the kernel, from user processes via the libc
64 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
65 call, from STDOUT/STDERR of system services or via its
66 native API. It will implicitly collect numerous meta
67 data fields for each log messages in a secure and
68 unfakeable way. See
69 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
70 for more information about the collected meta data.
71 </para>
72
73 <para>Log data collected by the journal is primarily
74 text based but can also include binary data where
75 necessary. All objects stored in the journal can be up
76 to 2^64-1 bytes in size.</para>
77
78 <para>By default the journal stores log data in
79 <filename>/run/log/journal/</filename>. Since
80 <filename>/run/</filename> is volatile log data is
81 lost at reboot. To make the data persistant it
82 is sufficient to create
83 <filename>/var/log/journal/</filename> where
84 <filename>systemd-journald</filename> will then store
85 the data.</para>
86
87 <para><filename>systemd-journald</filename> will
88 forward all received log messages to the AF_UNIX
89 SOCK_DGRAM socket
90 <filename>/run/systemd/journal/syslog</filename> (if it exists) which
91 may be used by UNIX syslog daemons to process the data
92 further.</para>
93
94 <para>See
95 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
96 for information about the configuration of this
97 service.</para>
98 </refsect1>
99
100 <refsect1>
101 <title>See Also</title>
102 <para>
103 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
104 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
105 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
106 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
107 </para>
108 </refsect1>
109
110 </refentry>