1SYSTEMD-JOURNAL-GATEWAYDs.ySsEtReVmIdC-Ej(o8u)rnal-gatewSaYySdT.EsMeDr-vJiOcUeRNAL-GATEWAYD.SERVICE(8)
2
3
4
6 systemd-journal-gatewayd.service, systemd-journal-gatewayd.socket,
7 systemd-journal-gatewayd - HTTP server for journal events
8
10 systemd-journal-gatewayd.service
11
12 systemd-journal-gatewayd.socket
13
14 /usr/lib/systemd/systemd-journal-gatewayd [OPTIONS...]
15
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
27 The following options are understood:
28
29 --cert=
30 Specify the path to a file containing a server certificate in PEM
31 format. This option switches systemd-journal-gatewayd into HTTPS
32 mode and must be used together with --key=.
33
34 --key=
35 Specify the path to a file containing a server key in PEM format
36 corresponding to the certificate specified with --cert=.
37
38 --trust=
39 Specify the path to a file containing a CA certificate in PEM
40 format.
41
42 -D DIR, --directory=DIR
43 Takes a directory path as argument. If specified,
44 systemd-journal-gatewayd will serve the specified journal directory
45 DIR instead of the default runtime and system journal paths.
46
47 -h, --help
48 Print a short help text and exit.
49
50 --version
51 Print a short version string and exit.
52
54 The following URLs are recognized:
55
56 /browse
57 Interactive browsing.
58
59 /entries[?option1&option2=value...]
60 Retrieval of events in various formats.
61
62 The Accept: part of the HTTP header determines the format.
63 Supported values are described below.
64
65 The Range: part of the HTTP header determines the range of events
66 returned. Supported values are described below.
67
68 GET parameters can be used to modify what events are returned.
69 Supported parameters are described below.
70
71 /machine
72 Return a JSON structure describing the machine.
73
74 Example:
75
76 { "machine_id" : "8cf7ed9d451ea194b77a9f118f3dc446",
77 "boot_id" : "3d3c9efaf556496a9b04259ee35df7f7",
78 "hostname" : "fedora",
79 "os_pretty_name" : "Fedora 19 (Rawhide)",
80 "virtualization" : "kvm",
81 ...}
82
83
84 /fields/FIELD_NAME
85 Return a list of values of this field present in the logs.
86
88 Accept: format
89
90 Recognized formats:
91
92 text/plain
93 The default. Plaintext syslog-like output, one line per journal
94 entry (like journalctl --output short).
95
96 application/json
97 Entries are formatted as JSON data structures, one per line (like
98 journalctl --output json). See Journal JSON Format[1] for more
99 information.
100
101 text/event-stream
102 Entries are formatted as JSON data structures, wrapped in a format
103 suitable for Server-Sent Events[2] (like journalctl --output
104 json-sse).
105
106 application/vnd.fdo.journal
107 Entries are serialized into a binary (but mostly text-based) stream
108 suitable for backups and network transfer (like journalctl --output
109 export). See Journal Export Format[3] for more information.
110
112 Range: entries=cursor[[:num_skip]:num_entries]
113
114 where cursor is a cursor string, num_skip is an integer, num_entries is
115 an unsigned integer.
116
117 Range defaults to all available events.
118
120 Following parameters can be used as part of the URL:
121
122 follow
123 wait for new events (like journalctl --follow, except that the
124 number of events returned is not limited).
125
126 discrete
127 Test that the specified cursor refers to an entry in the journal.
128 Returns just this entry.
129
130 boot
131 Limit events to the current boot of the system (like journalctl
132 -b).
133
134 KEY=match
135 Match journal fields. See systemd.journal-fields(7).
136
138 Retrieve events from this boot from local journal in Journal Export
139 Format[3]:
140
141 curl --silent -H'Accept: application/vnd.fdo.journal' \
142 'http://localhost:19531/entries?boot'
143
144 Listen for core dumps:
145
146 curl 'http://localhost:19531/entries?follow&MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1'
147
149 systemd(1), journalctl(1), systemd.journal-fields(7), systemd-
150 journald.service(8), systemd-journal-remote.service(8), systemd-
151 journal-upload.service(8)
152
154 1. Journal JSON Format
155 https://www.freedesktop.org/wiki/Software/systemd/json
156
157 2. Server-Sent Events
158 https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events
159
160 3. Journal Export Format
161 https://www.freedesktop.org/wiki/Software/systemd/export
162
163
164
165systemd 241 SYSTEMD-JOURNAL-GATEWAYD.SERVICE(8)