mirror of
https://github.com/systemd/systemd-stable.git
synced 2024-12-22 13:33:56 +03:00
man+docs: adjust links to the new page
This commit is contained in:
parent
d9044a43f6
commit
717e92ceb9
@ -7,11 +7,9 @@ SPDX-License-Identifier: LGPL-2.1-or-later
|
|||||||
|
|
||||||
# Journal File Format
|
# Journal File Format
|
||||||
|
|
||||||
_Note that this document describes the binary on-disk format of journals
|
_Note that this document describes the binary on-disk format of journals only.
|
||||||
only. For interfacing with web technologies there's the [Journal JSON
|
For interfacing with web technologies there's the [Journal JSON Format](https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-json-format).
|
||||||
Format](https://www.freedesktop.org/wiki/Software/systemd/json). For transfer
|
For transfer of journal data across the network there's the [Journal Export Format](https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format)._
|
||||||
of journal data across the network there's the [Journal Export
|
|
||||||
Format](https://www.freedesktop.org/wiki/Software/systemd/export)._
|
|
||||||
|
|
||||||
The systemd journal stores log data in a binary format with several features:
|
The systemd journal stores log data in a binary format with several features:
|
||||||
|
|
||||||
@ -39,8 +37,8 @@ some additional interfaces for you.
|
|||||||
|
|
||||||
If you need access to the raw journal data in serialized stream form without C
|
If you need access to the raw journal data in serialized stream form without C
|
||||||
API our recommendation is to make use of the [Journal Export
|
API our recommendation is to make use of the [Journal Export
|
||||||
Format](https://www.freedesktop.org/wiki/Software/systemd/export), which you can
|
Format](https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format), which you can
|
||||||
get via "journalctl -o export" or via systemd-journal-gatewayd. The export
|
get via `journalctl -o export` or via `systemd-journal-gatewayd`. The export
|
||||||
format is much simpler to parse, but complete and accurate. Due to its
|
format is much simpler to parse, but complete and accurate. Due to its
|
||||||
stream-based nature it is not indexed.
|
stream-based nature it is not indexed.
|
||||||
|
|
||||||
@ -48,8 +46,8 @@ _Or, to put this in other words: this low-level document is probably not what
|
|||||||
you want to use as base of your project. You want our [C
|
you want to use as base of your project. You want our [C
|
||||||
API](https://www.freedesktop.org/software/systemd/man/sd-journal.html) instead!
|
API](https://www.freedesktop.org/software/systemd/man/sd-journal.html) instead!
|
||||||
And if you really don't want the C API, then you want the [Journal Export
|
And if you really don't want the C API, then you want the [Journal Export
|
||||||
Format](https://www.freedesktop.org/wiki/Software/systemd/export) instead! This
|
Format or Journal JSON Format](https://systemd.io/JOURNAL_EXPORT_FORMATS) instead!
|
||||||
document is primarily for your entertainment and education. Thank you!_
|
This document is primarily for your entertainment and education. Thank you!_
|
||||||
|
|
||||||
This document assumes you have a basic understanding of the journal concepts,
|
This document assumes you have a basic understanding of the journal concepts,
|
||||||
the properties of a journal entry and so on. If not, please go and read up,
|
the properties of a journal entry and so on. If not, please go and read up,
|
||||||
|
@ -100,7 +100,7 @@ And now, here's the list of (hopefully) all APIs that we have introduced with sy
|
|||||||
| [Network](https://www.freedesktop.org/software/systemd/man/systemd.network.html) & [Netdev file format](https://www.freedesktop.org/software/systemd/man/systemd.netdev.html) | File format | yes | yes | no | no | - | no |
|
| [Network](https://www.freedesktop.org/software/systemd/man/systemd.network.html) & [Netdev file format](https://www.freedesktop.org/software/systemd/man/systemd.netdev.html) | File format | yes | yes | no | no | - | no |
|
||||||
| [Link file format](https://www.freedesktop.org/software/systemd/man/systemd.link.html) | File format | yes | yes | no | no | - | no |
|
| [Link file format](https://www.freedesktop.org/software/systemd/man/systemd.link.html) | File format | yes | yes | no | no | - | no |
|
||||||
| [Journal File Format](https://systemd.io/JOURNAL_FILE_FORMAT) | File format | yes | yes | - | maybe | - | no |
|
| [Journal File Format](https://systemd.io/JOURNAL_FILE_FORMAT) | File format | yes | yes | - | maybe | - | no |
|
||||||
| [Journal Export Format](https://www.freedesktop.org/wiki/Software/systemd/export) | File format | yes | yes | - | yes | - | no |
|
| [Journal Export Format](https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format) | File format | yes | yes | - | yes | - | no |
|
||||||
| [Cooperation in cgroup tree](https://www.freedesktop.org/wiki/Software/systemd/PaxControlGroups) | Treaty | yes | yes | libvirt | yes | libvirt | no |
|
| [Cooperation in cgroup tree](https://www.freedesktop.org/wiki/Software/systemd/PaxControlGroups) | Treaty | yes | yes | libvirt | yes | libvirt | no |
|
||||||
| [Password Agents](https://systemd.io/PASSWORD_AGENTS) | Socket+Files | yes | yes | - | yes | - | no |
|
| [Password Agents](https://systemd.io/PASSWORD_AGENTS) | Socket+Files | yes | yes | - | yes | - | no |
|
||||||
| [udev multi-seat properties](https://www.freedesktop.org/software/systemd/man/sd-login.html) | udev Property | yes | yes | X11, gdm | no | - | no |
|
| [udev multi-seat properties](https://www.freedesktop.org/software/systemd/man/sd-login.html) | udev Property | yes | yes | X11, gdm | no | - | no |
|
||||||
|
@ -301,7 +301,7 @@
|
|||||||
<para>serializes the journal into a binary (but mostly
|
<para>serializes the journal into a binary (but mostly
|
||||||
text-based) stream suitable for backups and network
|
text-based) stream suitable for backups and network
|
||||||
transfer (see
|
transfer (see
|
||||||
<ulink url="https://www.freedesktop.org/wiki/Software/systemd/export">Journal Export Format</ulink>
|
<ulink url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format">Journal Export Format</ulink>
|
||||||
for more information). To import the binary stream back
|
for more information). To import the binary stream back
|
||||||
into native journald format use
|
into native journald format use
|
||||||
<citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
|
<citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
|
||||||
@ -314,7 +314,7 @@
|
|||||||
</term>
|
</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>formats entries as JSON objects, separated by newline characters (see <ulink
|
<para>formats entries as JSON objects, separated by newline characters (see <ulink
|
||||||
url="https://www.freedesktop.org/wiki/Software/systemd/json">Journal JSON Format</ulink> for more
|
url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-json-format">Journal JSON Format</ulink> for more
|
||||||
information). Field values are generally encoded as JSON strings, with three exceptions:
|
information). Field values are generally encoded as JSON strings, with three exceptions:
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<listitem><para>Fields larger than 4096 bytes are encoded as <constant>null</constant> values. (This
|
<listitem><para>Fields larger than 4096 bytes are encoded as <constant>null</constant> values. (This
|
||||||
|
@ -79,7 +79,7 @@
|
|||||||
<para>It is also possible to invoke <command>systemd-coredump</command> with
|
<para>It is also possible to invoke <command>systemd-coredump</command> with
|
||||||
<option>--backtrace</option> option. In this case, <command>systemd-coredump</command> expects a
|
<option>--backtrace</option> option. In this case, <command>systemd-coredump</command> expects a
|
||||||
journal entry in the journal
|
journal entry in the journal
|
||||||
<ulink url="https://www.freedesktop.org/wiki/Software/systemd/export">Journal Export Format</ulink>
|
<ulink url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format">Journal Export Format</ulink>
|
||||||
on standard input. The entry should contain a <varname>MESSAGE=</varname> field and any additional
|
on standard input. The entry should contain a <varname>MESSAGE=</varname> field and any additional
|
||||||
metadata fields the caller deems reasonable. <command>systemd-coredump</command> will append additional
|
metadata fields the caller deems reasonable. <command>systemd-coredump</command> will append additional
|
||||||
metadata fields in the same way it does for core dumps received from the kernel. In this mode, no core
|
metadata fields in the same way it does for core dumps received from the kernel. In this mode, no core
|
||||||
|
@ -212,9 +212,8 @@
|
|||||||
<listitem><para>Entries are formatted as JSON data structures,
|
<listitem><para>Entries are formatted as JSON data structures,
|
||||||
one per line
|
one per line
|
||||||
(like <command>journalctl --output json</command>).
|
(like <command>journalctl --output json</command>).
|
||||||
See <ulink
|
See <ulink url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-json-format">Journal JSON Format</ulink>
|
||||||
url="https://www.freedesktop.org/wiki/Software/systemd/json">Journal
|
for more information.</para>
|
||||||
JSON Format</ulink> for more information.</para>
|
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
@ -233,13 +232,10 @@
|
|||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><constant>application/vnd.fdo.journal</constant></term>
|
<term><constant>application/vnd.fdo.journal</constant></term>
|
||||||
|
|
||||||
<listitem><para>Entries are serialized into a binary (but
|
<listitem><para>Entries are serialized into a binary (but mostly text-based) stream suitable for
|
||||||
mostly text-based) stream suitable for backups and network
|
backups and network transfer (like <command>journalctl --output export</command>). See <ulink
|
||||||
transfer
|
url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format">Journal Export Format</ulink>
|
||||||
(like <command>journalctl --output export</command>).
|
for more information.</para>
|
||||||
See <ulink
|
|
||||||
url="https://www.freedesktop.org/wiki/Software/systemd/export">Journal
|
|
||||||
Export Format</ulink> for more information.</para>
|
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
@ -303,10 +299,8 @@
|
|||||||
|
|
||||||
<refsect1>
|
<refsect1>
|
||||||
<title>Examples</title>
|
<title>Examples</title>
|
||||||
<para>Retrieve events from this boot from local journal
|
<para>Retrieve events from this boot from local journal in
|
||||||
in <ulink
|
<ulink url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format">Journal Export Format</ulink>:
|
||||||
url="https://www.freedesktop.org/wiki/Software/systemd/export">Journal
|
|
||||||
Export Format</ulink>:
|
|
||||||
<programlisting>curl --silent -H'Accept: application/vnd.fdo.journal' \
|
<programlisting>curl --silent -H'Accept: application/vnd.fdo.journal' \
|
||||||
'http://localhost:19531/entries?boot'</programlisting>
|
'http://localhost:19531/entries?boot'</programlisting>
|
||||||
</para>
|
</para>
|
||||||
|
@ -42,7 +42,7 @@
|
|||||||
|
|
||||||
<para><command>systemd-journal-remote</command> is a command to receive serialized journal
|
<para><command>systemd-journal-remote</command> is a command to receive serialized journal
|
||||||
events and store them to journal files. Input streams are in the
|
events and store them to journal files. Input streams are in the
|
||||||
<ulink url="https://www.freedesktop.org/wiki/Software/systemd/export">Journal Export Format</ulink>,
|
<ulink url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format">Journal Export Format</ulink>,
|
||||||
i.e. like the output from <command>journalctl --output=export</command>. For transport over the
|
i.e. like the output from <command>journalctl --output=export</command>. For transport over the
|
||||||
network, this serialized stream is usually carried over an HTTPS connection.</para>
|
network, this serialized stream is usually carried over an HTTPS connection.</para>
|
||||||
|
|
||||||
|
@ -515,11 +515,10 @@
|
|||||||
<title>Address Fields</title>
|
<title>Address Fields</title>
|
||||||
|
|
||||||
<para>During serialization into external formats, such as the
|
<para>During serialization into external formats, such as the
|
||||||
<ulink
|
<ulink url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format">Journal Export Format</ulink>
|
||||||
url="https://www.freedesktop.org/wiki/Software/systemd/export">Journal
|
or the
|
||||||
Export Format</ulink> or the <ulink
|
<ulink url="https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-json-format">Journal JSON Format</ulink>,
|
||||||
url="https://www.freedesktop.org/wiki/Software/systemd/json">Journal
|
the addresses of journal entries are
|
||||||
JSON Format</ulink>, the addresses of journal entries are
|
|
||||||
serialized into fields prefixed with double underscores. Note that
|
serialized into fields prefixed with double underscores. Note that
|
||||||
these are not proper fields when stored in the journal but for
|
these are not proper fields when stored in the journal but for
|
||||||
addressing metadata of entries. They cannot be written as part of
|
addressing metadata of entries. They cannot be written as part of
|
||||||
|
Loading…
Reference in New Issue
Block a user