2012-04-04 00:31:48 +04:00
<?xml version='1.0'?> <!-- * - nxml - * -->
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
2012-04-12 02:20:58 +04:00
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
2012-04-04 00:31:48 +04:00
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2012-04-12 02:20:58 +04:00
Lesser General Public License for more details.
2012-04-04 00:31:48 +04:00
2012-04-12 02:20:58 +04:00
You should have received a copy of the GNU Lesser General Public License
2012-04-04 00:31:48 +04:00
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
<refentry id= "systemd.journal-fields" >
<refentryinfo >
<title > systemd.journal-fields</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Lennart</firstname>
<surname > Poettering</surname>
<email > lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > systemd.journal-fields</refentrytitle>
<manvolnum > 7</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd.journal-fields</refname>
<refpurpose > Special journal fields</refpurpose>
</refnamediv>
<refsect1 >
<title > Description</title>
<para > Entries in the journal resemble an environment
block in their syntax, however with fields that can
include binary data. Primarily, fields are formatted
2012-07-09 17:46:21 +04:00
UTF-8 text strings, and binary formatting is used only
where formatting as UTF-8 text strings makes little
sense. New fields may freely be defined by
applications, but a few fields have special
meaning. All fields with special meanings are
2012-08-22 04:49:17 +04:00
optional. In some cases fields may appear more than
once per entry.</para>
2012-04-04 00:31:48 +04:00
</refsect1>
<refsect1 >
<title > User Journal Fields</title>
<para > User fields are fields that are directly passed
from clients and stored in the journal.</para>
2012-08-10 21:35:43 +04:00
<variablelist class= 'journal-directives' >
2012-04-04 00:31:48 +04:00
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > MESSAGE=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The human readable
message string for this
entry. This is supposed to be
the primary text shown to the
2012-05-22 03:12:46 +04:00
user. It is usually not
translated (but might be in
some cases), and is not
supposed to be parsed for meta
data.</para>
2012-04-04 00:31:48 +04:00
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > MESSAGE_ID=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > A 128bit message
identifier ID for recognizing
certain message types, if this
is desirable. This should
contain a 128bit id formatted
as lower-case hexadecimal
string, without any separating
dashes or suchlike. This is
recommended to be a UUID
compatible ID, but this is not
enforced, and formatted
differently. Developers can
generate a new ID for this
purpose with
<command > journalctl
--new-id</command> .</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > PRIORITY=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > A priority value between
0 (<literal > emerg</literal> )
and 7
(<literal > debug</literal> )
formatted as decimal
string. This field is
compatible with syslog's
priority concept.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > CODE_FILE=</varname> </term>
<term > <varname > CODE_LINE=</varname> </term>
<term > <varname > CODE_FUNC=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The code location
generating this message, if
known. Contains the source
file name, the line number and
the function name.</para>
</listitem>
</varlistentry>
2012-07-31 18:09:01 +04:00
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > ERRNO=</varname> </term>
2012-07-31 18:09:01 +04:00
<listitem >
<para > The low-level Unix error
number causing this entry, if
any. Contains the numeric
value of
<citerefentry > <refentrytitle > errno</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry>
formatted as decimal
string.</para>
</listitem>
</varlistentry>
2012-04-04 00:31:48 +04:00
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > SYSLOG_FACILITY=</varname> </term>
<term > <varname > SYSLOG_IDENTIFIER=</varname> </term>
<term > <varname > SYSLOG_PID=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > Syslog compatibility
fields containing the facility
(formatted as decimal string),
the identifier string
(i.e. "tag"), and the client
PID.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > Trusted Journal Fields</title>
<para > Fields prefixed with an underscore are trusted
fields, i.e. fields that are implicitly added by the
journal and cannot be altered by client code.</para>
2012-08-10 21:35:43 +04:00
<variablelist class= 'journal-directives' >
2012-04-04 00:31:48 +04:00
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _PID=</varname> </term>
<term > <varname > _UID=</varname> </term>
<term > <varname > _GID=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The process, user and
group ID of the process the
journal entry originates from
formatted as decimal
string.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _COMM=</varname> </term>
<term > <varname > _EXE=</varname> </term>
<term > <varname > _CMDLINE=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The name, the executable
path and the command line of
the process the journal entry
originates from.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _AUDIT_SESSION=</varname> </term>
<term > <varname > _AUDIT_LOGINUID=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The session and login
UID of the process the journal
entry originates from, as
maintained by the kernel audit
subsystem.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _SYSTEMD_CGROUP=</varname> </term>
<term > <varname > _SYSTEMD_SESSION=</varname> </term>
<term > <varname > _SYSTEMD_UNIT=</varname> </term>
<term > <varname > _SYSTEMD_OWNER_UID=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
2012-10-26 02:16:47 +04:00
<para > The control group path in
2012-04-04 00:31:48 +04:00
the systemd hierarchy, the
systemd session ID (if any),
the systemd unit name (if any)
and the owner UID of the
systemd session (if any) of
the process the journal entry
originates from.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _SELINUX_CONTEXT=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The SELinux security
context of the process the
journal entry originates
from.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _SOURCE_REALTIME_TIMESTAMP=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The earliest trusted
timestamp of the message, if
any is known that is different
from the reception time of the
2012-04-04 01:08:04 +04:00
journal. This is the time in
usec since the epoch UTC
formatted as decimal
string.</para>
2012-04-04 00:31:48 +04:00
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _BOOT_ID=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The kernel boot ID for
the boot the message was
generated in, formatted as
128bit hexadecimal
string.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _MACHINE_ID=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The machine ID of the
originating host, as available
in
<citerefentry > <refentrytitle > machine-id</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _HOSTNAME=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The name of the
originating host.</para>
</listitem>
</varlistentry>
2012-04-04 02:43:40 +04:00
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > _TRANSPORT=</varname> </term>
2012-04-04 02:43:40 +04:00
<listitem >
<para > How the entry was
received by the journal
service. One of
<literal > driver</literal> ,
<literal > syslog</literal> ,
<literal > journal</literal> ,
<literal > stdout</literal> ,
<literal > kernel</literal> for
internally generated messages,
for those received via the
local syslog socket with the
syslog protocol, for those
received via the native
journal protocol, for the
those read from a services'
standard output or error
Reword sentences that contain psuedo-English "resp."
As you likely know, Arch Linux is in the process of moving to systemd.
So I was reading through the various systemd docs and quickly became
baffled by this new abbreviation "resp.", which I've never seen before
in my English-mother-tongue life.
Some quick Googling turned up a reference:
<http://www.transblawg.eu/index.php?/archives/870-Resp.-and-other-non-existent-English-wordsNicht-existente-englische-Woerter.html>
I guess it's a literal translation of the German "Beziehungsweise", but
English doesn't work the same way. The word "respectively" is used
exclusively to provide an ordering connection between two lists. E.g.
"the prefixes k, M, and G refer to kilo-, mega-, and giga-,
respectively." It is also never abbreviated to "resp." So the sentence
"Sets the default output resp. error output for all services and
sockets" makes no sense to a natural English speaker.
This patch removes all instances of "resp." in the man pages and
replaces them with sentences which are much more clear and, hopefully,
grammatically valid. In almost all instances, it was simply replacing
"resp." with "or," which the original author (Lennart?) could probably
just do in the future.
The only other instances of "resp." are in the src/ subtree, which I
don't feel privileged to correct.
Signed-off-by: Andrew Eikum <aeikum@codeweavers.com>
2012-10-15 22:59:12 +04:00
output, or for those read
from the kernel, respectively.
2012-04-04 02:43:40 +04:00
</para>
</listitem>
</varlistentry>
2012-04-04 00:31:48 +04:00
</variablelist>
</refsect1>
2012-08-09 19:12:07 +04:00
<refsect1 >
<title > Kernel Journal Fields</title>
<para > Kernel fields are fields that are used by
messages originating in the kernel and stored in the
journal.</para>
<variablelist >
<varlistentry >
<term > _KERNEL_DEVICE=</term>
<listitem >
<para > The kernel device
name. If the entry is
associated to a block device,
the major and minor of the
device node, separated by ':'
and prefixed by 'b'. Similar
for character devices, but
prefixed by 'c'. For network
devices the interface index,
prefixed by 'n'. For all other
devices '+' followed by the
subsystem name, followed by
':', followed by the kernel
device name.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > _KERNEL_SUBSYSTEM=</term>
<listitem >
<para > The kernel subsystem name.</para>
</listitem>
</varlistentry>
2012-08-22 04:49:17 +04:00
<varlistentry >
<term > _UDEV_SYSNAME=</term>
<listitem >
<para > The kernel device name
as it shows up in the device
tree below
<filename > /sys</filename> .</para>
</listitem>
</varlistentry>
<varlistentry >
<term > _UDEV_DEVNODE=</term>
<listitem >
<para > The device node path of
this device in
<filename > /dev</filename> .</para>
</listitem>
</varlistentry>
<varlistentry >
<term > _UDEV_DEVLINK=</term>
<listitem >
<para > Additional symlink names
pointing to the device node in
<filename > /dev</filename> . This
field is frequently set more
than once per entry.</para>
</listitem>
</varlistentry>
2012-08-09 19:12:07 +04:00
</variablelist>
</refsect1>
2012-04-04 00:31:48 +04:00
<refsect1 >
<title > Address Fields</title>
2012-10-26 03:07:07 +04:00
<para > During serialization into external formats, such
as the <ulink
url="http://www.freedesktop.org/wiki/Software/systemd/export">Journal
Export Format</ulink> or the <ulink
url="http://www.freedesktop.org/wiki/Software/systemd/json">Journal
JSON Format</ulink> , the addresses of journal entries
are serialized into fields prefixed with double
underscores. Note that these aren't proper fields when
stored in the journal, but addressing meta data of
entries. They cannot be written as part of structured
log entries via calls such as
2012-07-13 02:29:26 +04:00
<citerefentry > <refentrytitle > sd_journal_send</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> . They
may also not be used as matches for
<citerefentry > <refentrytitle > sd_journal_add_match</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </para>
2012-04-04 00:31:48 +04:00
2012-08-10 21:35:43 +04:00
<variablelist class= 'journal-directives' >
2012-04-04 00:31:48 +04:00
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > __CURSOR=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The cursor for the
entry. A cursor is an opaque
text string that uniquely
describes the position of an
entry in the journal and is
portable across machines,
platforms and journal
files.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > __REALTIME_TIMESTAMP=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The wallclock time
(CLOCK_REALTIME) at the point
in time the entry was received
2012-04-04 01:08:04 +04:00
by the journal, in usec since
the epoch UTC formatted as
decimal string. This has
2012-04-04 00:31:48 +04:00
different properties from
<literal > _SOURCE_REALTIME_TIMESTAMP=</literal>
as it is usually a bit later
but more likely to be
monotonic.</para>
</listitem>
</varlistentry>
<varlistentry >
2012-08-10 21:35:43 +04:00
<term > <varname > __MONOTONIC_TIMESTAMP=</varname> </term>
2012-04-04 00:31:48 +04:00
<listitem >
<para > The monotonic time
(CLOCK_MONOTONIC) at the point
in time the entry was received
2012-04-04 01:08:04 +04:00
by the journal in usec
formatted as decimal
string. To be useful as an
address for the entry this
should be combined with with
boot ID in
2012-04-04 00:31:48 +04:00
<literal > _BOOT_ID=</literal> .</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > journalctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2012-07-09 17:46:21 +04:00
<citerefentry > <refentrytitle > journald.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2013-01-15 07:08:33 +04:00
<citerefentry > <refentrytitle > sd-journal</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.directives</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
2012-04-04 00:31:48 +04:00
</para>
</refsect1>
</refentry>
