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">
6 This file is part of systemd.
8 Copyright 2012 Zbigniew Jędrzejewski-Szmek
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.
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.
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/>.
24 <refentry id=
"systemd-journal-gatewayd.service" conditional='HAVE_MICROHTTPD'
>
27 <title>systemd-journal-gatewayd.service
</title>
28 <productname>systemd
</productname>
32 <contrib>Developer
</contrib>
33 <firstname>Zbigniew
</firstname>
34 <surname>Jędrzejewski-Szmek
</surname>
35 <email>zbyszek@in.waw.pl
</email>
41 <refentrytitle>systemd-journal-gatewayd.service
</refentrytitle>
42 <manvolnum>8</manvolnum>
46 <refname>systemd-journal-gatewayd.service
</refname>
47 <refname>systemd-journal-gatewayd.socket
</refname>
48 <refname>systemd-journal-gatewayd
</refname>
49 <refpurpose>HTTP server for journal events
</refpurpose>
53 <para><filename>systemd-journal-gatewayd.service
</filename></para>
54 <para><filename>systemd-journal-gatewayd.socket
</filename></para>
56 <command>/usr/lib/systemd/systemd-journal-gatewayd
</command>
57 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
62 <title>Description
</title>
64 <para><command>systemd-journal-gatewayd
</command> serves journal
65 events over the network. Clients must connect using
66 HTTP. The server listens on port
19531 by default.
67 If
<option>--cert=
</option> is specified, the server expects
68 HTTPS connections.
</para>
70 <para>The program is started by
71 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
72 and expects to receive a single socket. Use
73 <command>systemctl start systemd-journal-gatewayd.socket
</command> to start
74 the service, and
<command>systemctl enable systemd-journal-gatewayd.socket
</command>
75 to have it started on boot.
</para>
79 <title>Options
</title>
81 <para>The following options are understood:
</para>
85 <term><option>--help
</option></term>
86 <term><option>-h
</option></term>
88 <listitem><para>Prints a short help
89 text and exits.
</para></listitem>
93 <term><option>--version
</option></term>
95 <listitem><para>Prints a short version
96 string and exits.
</para></listitem>
100 <term><option>--cert=
</option></term>
102 <listitem><para>Specify the path to a file containing a server
103 certificate in PEM format. This option switches
104 <command>systemd-journal-gatewayd
</command> into HTTPS mode
105 and must be used together with
106 <option>--key=
</option>.
</para></listitem>
110 <term><option>--key=
</option></term>
112 <listitem><para>Specify the path to a file containing a server
113 key in PEM format corresponding to the certificate specified
114 with
<option>--cert=
</option>.
</para></listitem>
121 <title>Supported URLs
</title>
123 <para>The following URLs are recognized:
</para>
127 <term><uri>/browse
</uri></term>
129 <listitem><para>Interactive browsing.
</para></listitem>
133 <term><uri>/entries[?option1
&option2=value...]
</uri></term>
135 <listitem><para>Retrieval of events in various formats.
</para>
137 <para>The
<option>Accept:
</option> part of the HTTP header
138 determines the format. Supported values are described below.
141 <para>The
<option>Range:
</option> part of the HTTP header
142 determines the range of events returned. Supported values are
146 <para>GET parameters can be used to modify what events are
147 returned. Supported parameters are described below.
</para>
152 <term><uri>/machine
</uri></term>
154 <listitem><para>Return a JSON structure describing the machine.
</para>
158 {
"machine_id" :
"8cf7ed9d451ea194b77a9f118f3dc446",
159 "boot_id" :
"3d3c9efaf556496a9b04259ee35df7f7",
160 "hostname" :
"fedora",
161 "os_pretty_name" :
"Fedora 19 (Rawhide)",
162 "virtualization" :
"kvm",
170 <term><uri>/fields/
<replaceable>FIELD_NAME
</replaceable></uri></term>
172 <listitem><para>Return a list of values of this field present in the logs.
</para>
179 <title>Accept header
</title>
182 <option>Accept:
<replaceable>format
</replaceable></option>
185 <para>Recognized formats:
</para>
189 <term><constant>text/plain
</constant></term>
191 <listitem><para>The default. Plaintext syslog-like output,
192 one line per journal entry
193 (like
<command>journalctl --output short
</command>).
</para>
198 <term><constant>application/json
</constant></term>
200 <listitem><para>Entries are formatted as JSON data structures,
202 (like
<command>journalctl --output json
</command>).
204 url=
"http://www.freedesktop.org/wiki/Software/systemd/json">Journal
205 JSON Format
</ulink> for more information.
</para>
210 <term><constant>application/event-stream
</constant></term>
212 <listitem><para>Entries are formatted as JSON data structures,
213 wrapped in a format suitable for
<ulink
214 url=
"https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events">
215 Server-Sent Events
</ulink>
216 (like
<command>journalctl --output json-sse
</command>).
222 <term><constant>application/vnd.fdo.journal
</constant></term>
224 <listitem><para>Entries are serialized into a binary (but
225 mostly text-based) stream suitable for backups and network
227 (like
<command>journalctl --output export
</command>).
229 url=
"http://www.freedesktop.org/wiki/Software/systemd/export">Journal
230 Export Format
</ulink> for more information.
</para>
237 <title>Range header
</title>
240 <option>Range: entries=
<replaceable>cursor
</replaceable>[[:
<replaceable>num_skip
</replaceable>]:
<replaceable>num_entries
</replaceable>]
</option>
244 <option>cursor
</option> is a cursor string,
245 <option>num_skip
</option> is an integer,
246 <option>num_entries
</option> is an unsigned integer.
249 <para>Range defaults to all available events.
</para>
253 <title>URL GET parameters
</title>
255 <para>Following parameters can be used as part of the URL:
</para>
259 <term><uri>follow
</uri></term>
261 <listitem><para>wait for new events
262 (like
<command>journalctl --follow
</command>, except that
263 the number of events returned is not limited).
</para>
268 <term><uri>discrete
</uri></term>
270 <listitem><para>Test that the specified cursor refers to an
271 entry in the journal. Returns just this entry.
</para>
276 <term><uri>boot
</uri></term>
278 <listitem><para>Limit events to the current boot of the system
279 (like
<command>journalctl --this--boot
</command>).
</para></listitem>
283 <term><uri><replaceable>KEY
</replaceable>=
<replaceable>match
</replaceable></uri></term>
285 <listitem><para>Match journal fields. See
286 <citerefentry><refentrytitle>systemd.journal-fields
</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
</para>
293 <title>Examples
</title>
294 <para>Retrieve events from this boot from local journal
296 url=
"http://www.freedesktop.org/wiki/Software/systemd/export">Journal
297 Export Format
</ulink>:
299 curl --silent -H'Accept: application/vnd.fdo.journal' \
300 'http://localhost:
19531/entries?boot'
304 <para>Listen for core dumps:
306 curl 'http://localhost:
19531/entries?follow
&MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1'
307 </programlisting></para>
311 <title>See Also
</title>
313 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
314 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
315 <citerefentry><refentrytitle>systemd-journald.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
316 <citerefentry><refentrytitle>systemd.journal-fields
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,