systemd-journal-gatewayd.socket(8)

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       -D DIR, --directory=DIR
45           Takes a directory path as argument. If specified,
46           systemd-journal-gatewayd will serve the specified journal directory
47           DIR instead of the default runtime and system journal paths.
48
49       -h, --help
50           Print a short help text and exit.
51
52       --version
53           Print a short version string and exit.
54

SUPPORTED URLS

56       The following URLs are recognized:
57
58       /browse
59           Interactive browsing.
60
61       /entries[?option1&option2=value...]
62           Retrieval of events in various formats.
63
64           The Accept: part of the HTTP header determines the format.
65           Supported values are described below.
66
67           The Range: part of the HTTP header determines the range of events
68           returned. Supported values are described below.
69
70           GET parameters can be used to modify what events are returned.
71           Supported parameters are described below.
72
73       /machine
74           Return a JSON structure describing the machine.
75
76           Example:
77
78               { "machine_id" : "8cf7ed9d451ea194b77a9f118f3dc446",
79                 "boot_id" : "3d3c9efaf556496a9b04259ee35df7f7",
80                 "hostname" : "fedora",
81                 "os_pretty_name" : "Fedora 19 (Rawhide)",
82                 "virtualization" : "kvm",
83                 ...}
84
85
86       /fields/FIELD_NAME
87           Return a list of values of this field present in the logs.
88

ACCEPT HEADER

90       Accept: format
91
92       Recognized formats:
93
94       text/plain
95           The default. Plaintext syslog-like output, one line per journal
96           entry (like journalctl --output short).
97
98       application/json
99           Entries are formatted as JSON data structures, one per line (like
100           journalctl --output json). See Journal JSON Format[1] for more
101           information.
102
103       text/event-stream
104           Entries are formatted as JSON data structures, wrapped in a format
105           suitable for Server-Sent Events[2] (like journalctl --output
106           json-sse).
107
108       application/vnd.fdo.journal
109           Entries are serialized into a binary (but mostly text-based) stream
110           suitable for backups and network transfer (like journalctl --output
111           export). See Journal Export Format[3] for more information.
112

RANGE HEADER

114       Range: entries=cursor[[:num_skip]:num_entries]
115
116       where cursor is a cursor string, num_skip is an integer, num_entries is
117       an unsigned integer.
118
119       Range defaults to all available events.
120

URL GET PARAMETERS

122       Following parameters can be used as part of the URL:
123
124       follow
125           wait for new events (like journalctl --follow, except that the
126           number of events returned is not limited).
127
128       discrete
129           Test that the specified cursor refers to an entry in the journal.
130           Returns just this entry.
131
132       boot
133           Limit events to the current boot of the system (like journalctl
134           -b).
135
136       KEY=match
137           Match journal fields. See systemd.journal-fields(7).
138

EXAMPLES

140       Retrieve events from this boot from local journal in Journal Export
141       Format[3]:
142
143           curl --silent -H'Accept: application/vnd.fdo.journal' \
144                  'http://localhost:19531/entries?boot'
145
146       Listen for core dumps:
147
148           curl 'http://localhost:19531/entries?follow&MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1'
149

NOTES

156        1. Journal JSON Format
157           https://www.freedesktop.org/wiki/Software/systemd/json
158
159        2. Server-Sent Events
160           https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events
161
162        3. Journal Export Format
163           https://www.freedesktop.org/wiki/Software/systemd/export
164
165
166
167systemd 248                                SYSTEMD-JOURNAL-GATEWAYD.SERVICE(8)