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 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       -h, --help
39           Print a short help text and exit.
40
41       --version
42           Print a short version string and exit.
43

SUPPORTED URLS

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

ACCEPT HEADER

79       Accept: format
80
81       Recognized formats:
82
83       text/plain
84           The default. Plaintext syslog-like output, one line per journal
85           entry (like journalctl --output short).
86
87       application/json
88           Entries are formatted as JSON data structures, one per line (like
89           journalctl --output json). See Journal JSON Format[1] for more
90           information.
91
92       application/event-stream
93           Entries are formatted as JSON data structures, wrapped in a format
94           suitable for Server-Sent Events[2] (like journalctl --output
95           json-sse).
96
97       application/vnd.fdo.journal
98           Entries are serialized into a binary (but mostly text-based) stream
99           suitable for backups and network transfer (like journalctl --output
100           export). See Journal Export Format[3] for more information.
101

RANGE HEADER

103       Range: entries=cursor[[:num_skip]:num_entries]
104
105       where cursor is a cursor string, num_skip is an integer, num_entries is
106       an unsigned integer.
107
108       Range defaults to all available events.
109

URL GET PARAMETERS

111       Following parameters can be used as part of the URL:
112
113       follow
114           wait for new events (like journalctl --follow, except that the
115           number of events returned is not limited).
116
117       discrete
118           Test that the specified cursor refers to an entry in the journal.
119           Returns just this entry.
120
121       boot
122           Limit events to the current boot of the system (like journalctl
123           --this--boot).
124
125       KEY=match
126           Match journal fields. See systemd.journal-fields(7).
127

EXAMPLES

129       Retrieve events from this boot from local journal in Journal Export
130       Format[3]:
131
132           curl --silent -H'Accept: application/vnd.fdo.journal' \
133                  'http://localhost:19531/entries?boot'
134
135       Listen for core dumps:
136
137           curl 'http://localhost:19531/entries?follow&MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1'
138

NOTES

144        1. Journal JSON Format
145           http://www.freedesktop.org/wiki/Software/systemd/json
146
147        2. Server-Sent Events
148           https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events
149
150        3. Journal Export Format
151           http://www.freedesktop.org/wiki/Software/systemd/export
152
153
154
155systemd 219                                SYSTEMD-JOURNAL-GATEWAYD.SERVICE(8)