1SYSTEMD-JOURNAL-GATEWAYDs.ySsEtReVmIdC-Ej(o8u)rnal-gatewSaYySdT.EsMeDr-vJiOcUeRNAL-GATEWAYD.SERVICE(8)
2
3
4

NAME

6       systemd-journal-gatewayd.service, systemd-journal-gatewayd.socket,
7       systemd-journal-gatewayd - HTTP server for journal events
8

SYNOPSIS

10       systemd-journal-gatewayd.service
11
12       systemd-journal-gatewayd.socket
13
14       /usr/lib/systemd/systemd-journal-gatewayd [OPTIONS...]
15

DESCRIPTION

17       systemd-journal-gatewayd serves journal events over the network.
18       Clients must connect using HTTP. The server listens on port 19531 by
19       default. If --cert= is specified, the server expects HTTPS connections.
20
21       The program is started by systemd(1) and expects to receive a single
22       socket. Use systemctl start systemd-journal-gatewayd.socket to start
23       the service, and systemctl enable systemd-journal-gatewayd.socket to
24       have it started on boot.
25

OPTIONS

27       The following options are understood:
28
29       --cert=
30           Specify the path to a file or AF_UNIX stream socket to read the
31           server certificate from. The certificate must be in PEM format.
32           This option switches systemd-journal-gatewayd into HTTPS mode and
33           must be used together with --key=.
34
35       --key=
36           Specify the path to a file or AF_UNIX stream socket to read the
37           secret server key corresponding to the certificate specified with
38           --cert= from. The key must be in PEM format.
39
40       --trust=
41           Specify the path to a file or AF_UNIX stream socket to read a CA
42           certificate from. The certificate must be in PEM format.
43
44       --system, --user
45           Limit served entries to entries from system services and the
46           kernel, or to entries from services of current user. This has the
47           same meaning as --system and --user options for journalctl(1). If
48           neither is specified, all accessible entries are served.
49
50       -m, --merge
51           Serve entries interleaved from all available journals, including
52           other machines. This has the same meaning as --merge option for
53           journalctl(1).
54
55       -D DIR, --directory=DIR
56           Takes a directory path as argument. If specified,
57           systemd-journal-gatewayd will serve the specified journal directory
58           DIR instead of the default runtime and system journal paths.
59
60       --file=GLOB
61           Takes a file glob as an argument. Serve entries from the specified
62           journal files matching GLOB instead of the default runtime and
63           system journal paths. May be specified multiple times, in which
64           case files will be suitably interleaved. This has the same meaning
65           as --file= option for journalctl(1).
66
67       -h, --help
68           Print a short help text and exit.
69
70       --version
71           Print a short version string and exit.
72

SUPPORTED URLS

74       The following URLs are recognized:
75
76       /browse
77           Interactive browsing.
78
79       /entries[?option1&option2=value...]
80           Retrieval of events in various formats.
81
82           The Accept: part of the HTTP header determines the format.
83           Supported values are described below.
84
85           The Range: part of the HTTP header determines the range of events
86           returned. Supported values are described below.
87
88           GET parameters can be used to modify what events are returned.
89           Supported parameters are described below.
90
91       /machine
92           Return a JSON structure describing the machine.
93
94           Example:
95
96               { "machine_id" : "8cf7ed9d451ea194b77a9f118f3dc446",
97                 "boot_id" : "3d3c9efaf556496a9b04259ee35df7f7",
98                 "hostname" : "fedora",
99                 "os_pretty_name" : "Fedora 19 (Rawhide)",
100                 "virtualization" : "kvm",
101                 ...}
102
103
104       /fields/FIELD_NAME
105           Return a list of values of this field present in the logs.
106

ACCEPT HEADER

108       Accept: format
109
110       Recognized formats:
111
112       text/plain
113           The default. Plaintext syslog-like output, one line per journal
114           entry (like journalctl --output short).
115
116       application/json
117           Entries are formatted as JSON data structures, one per line (like
118           journalctl --output json). See Journal JSON Format[1] for more
119           information.
120
121       text/event-stream
122           Entries are formatted as JSON data structures, wrapped in a format
123           suitable for Server-Sent Events[2] (like journalctl --output
124           json-sse).
125
126       application/vnd.fdo.journal
127           Entries are serialized into a binary (but mostly text-based) stream
128           suitable for backups and network transfer (like journalctl --output
129           export). See Journal Export Format[3] for more information.
130

RANGE HEADER

132       Range: entries=cursor[[:num_skip]:num_entries]
133
134       where cursor is a cursor string, num_skip is an integer, num_entries is
135       an unsigned integer.
136
137       Range defaults to all available events.
138

URL GET PARAMETERS

140       Following parameters can be used as part of the URL:
141
142       follow
143           wait for new events (like journalctl --follow, except that the
144           number of events returned is not limited).
145
146       discrete
147           Test that the specified cursor refers to an entry in the journal.
148           Returns just this entry.
149
150       boot
151           Limit events to the current boot of the system (like journalctl
152           -b).
153
154       KEY=match
155           Match journal fields. See systemd.journal-fields(7).
156

EXAMPLES

158       Retrieve events from this boot from local journal in Journal Export
159       Format[3]:
160
161           curl --silent -H'Accept: application/vnd.fdo.journal' \
162                  'http://localhost:19531/entries?boot'
163
164       Listen for core dumps:
165
166           curl 'http://localhost:19531/entries?follow&MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1'
167

SEE ALSO

169       systemd(1), journalctl(1), systemd.journal-fields(7), systemd-
170       journald.service(8), systemd-journal-remote.service(8), systemd-
171       journal-upload.service(8)
172

NOTES

174        1. Journal JSON Format
175           https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-json-format
176
177        2. Server-Sent Events
178           https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events
179
180        3. Journal Export Format
181           https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format
182
183
184
185systemd 254                                SYSTEMD-JOURNAL-GATEWAYD.SERVICE(8)
Impressum