X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-journal-remote.xml;h=2687662a14a23ff93db7f342cf2214c99231aed6;hp=ef123ce4814ff755c8da8989af9e0f2991b7a39e;hb=83e7d8850c38baee0da3097f27e191359aa70006;hpb=cc64d0175a3c2c974709e9962c00fbe04d74c43f diff --git a/man/systemd-journal-remote.xml b/man/systemd-journal-remote.xml index ef123ce48..2687662a1 100644 --- a/man/systemd-journal-remote.xml +++ b/man/systemd-journal-remote.xml @@ -1,27 +1,28 @@ - + - + systemd-journal-remote @@ -44,14 +45,14 @@ along with systemd; If not, see . systemd-journal-remote - Stream journal messages over the network + Receive journal messages over the network systemd-journal-remote OPTIONS - -o/--output=DIR|FILE + -o/--output=DIR|FILE SOURCES @@ -62,12 +63,14 @@ along with systemd; If not, see . systemd-journal-remote is a command to receive serialized journal events and store them to the journal. - Input streams must be in the + Input streams are in the Journal Export Format , i.e. like the output from - journalctl --output=export. + journalctl --output=export. For transport over + the network, this serialized stream is usually carried over an + HTTPS connection. @@ -79,14 +82,14 @@ along with systemd; If not, see . (systemd-journal-remote requests and pulls the data), or "passive" (systemd-journal-remote waits for a - connection and than receives events pushed by the other side). + connection and then receives events pushed by the other side). systemd-journal-remote can read more than one event stream at a time. They will be interleaved in the output file. In case of "active" connections, each "source" is one - stream, and in case of "passive" connections each connection can + stream, and in case of "passive" connections, each connection can result in a separate stream. Sockets can be configured in "accept" mode (i.e. only one connection), or "listen" mode (i.e. multiple connections, each resulting in a stream). @@ -131,7 +134,7 @@ along with systemd; If not, see . ADDRESS must be an - address suitable for (c.f. + address suitable for (cf. systemd.socket5). systemd-journal-remote will listen on this socket for connections. Each connection is expected to be a @@ -143,14 +146,19 @@ along with systemd; If not, see . - ADDRESS must be an + ADDRESS must be + either a negative integer, in which case it will be + interpreted as the (negated) file descriptor number, or an address suitable for (c.f. systemd.socket5). - HTTP or HTTPS server will be spawned on this port, - respectively, for the first and second options. Currenntly - Only POST requests to /upload with - Content-Type: application/vnd.fdo.journal - are supported. + In the first case, matching file descriptor must be inherited + through + $LISTEN_FDS/$LISTEN_PID. + In the second case, an HTTP or HTTPS server will be spawned on + this port, respectively for and + . Currenntly, only POST requests + to /upload with Content-Type: + application/vnd.fdo.journal are supported. @@ -160,10 +168,15 @@ along with systemd; If not, see . systemd-journal-remote supports the $LISTEN_FDS/$LISTEN_PID - protocol. Open sockets inherited through socket - activation behave like those opened with - described above. - + protocol. Open sockets inherited through socket activation + behave like those opened with + described above, unless they are specified as an argument in + + or + + above. In the latter case, an HTTP or HTTPS server will be + spawned using this descriptor and connections must be made + over the HTTP protocol. @@ -174,51 +187,46 @@ along with systemd; If not, see . Sinks The location of the output journal can be specified - with or . + with or . For "active" + sources, this option is required. - Will write to this journal. The filename must - end with .journal. The file will be - created if it does not exist. When necessary (journal file - full, or corrupted) the file will be renamed following normal - journald rules and a new journal file will be created in it's - stead. + Will write to this journal file. The filename + must end with .journal. The file will be + created if it does not exist. If necessary (journal file full, + or corrupted), the file will be renamed following normal + journald rules and a new journal file will be created in its + stead. Will create journal files underneath directory - DIR. The directory must exist. When - necessary (journal files over size, or corrupted) journal + DIR. The directory must exist. If + necessary (journal files over size, or corrupted), journal files will be rotated following normal journald rules. Names of files underneath DIR will be generated using the rules described below. - If is not used, output directory - /var/log/journal/machine-id/ - will be used, where machine-id is the - identifier of the current system (see - machine-id5). - In case the output file is not specified, journal files will be - created underneath the selected directory. Files will be called - remote-variable.journal, - where the variable part is generated - based on what passive and active sources are specified. It is - recommended to give a full output filename. - - In case of "active" sources, if the hostname is known it - will be used in the variable part. - Otherwise, local address and port number will be used, or - stdin for events passed over standard - input, and multiple if more than one source - is specified. + If is not used, the output + directory /var/log/journal/remote/ will be + used. In case the output file is not specified, journal files + will be created underneath the selected directory. Files will be + called + remote-hostname.journal, + where the hostname part is the + escaped hostname of the source endpoint of the connection, or the + numerical address if the hostname cannot be determined. + + In case of "active" sources, the output file name must + always be given explicitly. @@ -228,18 +236,17 @@ along with systemd; If not, see . - - - - Print a short help - text and exit. - + - - + One of none or + host. For the first, only one output + journal file is used. For the latter, a separate output file + is used, based on the hostname of the other endpoint of a + connection. - Print a short version - string and exit. + In case of "active" sources, the output file name must + always be given explicitly and only none + is allowed. @@ -262,7 +269,7 @@ along with systemd; If not, see . - Program to invoke to retrieve data. Journal + Program to invoke to retrieve data. The journal event stream must be generated on standard output. Examples: @@ -272,6 +279,9 @@ along with systemd; If not, see . --getter='wget --header="Accept: application/vnd.fdo.journal" -O- https://some.host:19531/' + + + @@ -296,9 +306,10 @@ systemd-journal-remote --url http://some.host:19531/ See Also + systemd-journal-upload8, journalctl1, systemd-journald.service8, - systemd-journal-gatewayd.service8. + systemd-journal-gatewayd.service8