]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.journal-fields.xml
log: include TID= field in structred log output
[thirdparty/systemd.git] / man / systemd.journal-fields.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
5
6 <refentry id="systemd.journal-fields">
7
8 <refentryinfo>
9 <title>systemd.journal-fields</title>
10 <productname>systemd</productname>
11 </refentryinfo>
12
13 <refmeta>
14 <refentrytitle>systemd.journal-fields</refentrytitle>
15 <manvolnum>7</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>systemd.journal-fields</refname>
20 <refpurpose>Special journal fields</refpurpose>
21 </refnamediv>
22
23 <refsect1>
24 <title>Description</title>
25
26 <para>Entries in the journal (as written by
27 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
28 resemble a UNIX process environment block in syntax but with fields that may include binary data.
29 Primarily, fields are formatted UTF-8 text strings, and binary encoding is used only where formatting as
30 UTF-8 text strings makes little sense. New fields may freely be defined by applications, but a few fields
31 have special meanings. All fields with special meanings are optional. In some cases, fields may appear
32 more than once per entry.</para>
33 </refsect1>
34
35 <refsect1>
36 <title>User Journal Fields</title>
37
38 <para>User fields are fields that are directly passed from clients
39 and stored in the journal.</para>
40
41 <variablelist class='journal-directives'>
42 <varlistentry>
43 <term><varname>MESSAGE=</varname></term>
44 <listitem>
45 <para>The human-readable message string for this entry. This
46 is supposed to be the primary text shown to the user. It is
47 usually not translated (but might be in some cases), and is
48 not supposed to be parsed for metadata.</para>
49 </listitem>
50 </varlistentry>
51
52 <varlistentry>
53 <term><varname>MESSAGE_ID=</varname></term>
54 <listitem>
55 <para>A 128-bit message identifier ID for recognizing certain message types, if this is desirable. This
56 should contain a 128-bit ID formatted as a lower-case hexadecimal string, without any separating dashes or
57 suchlike. This is recommended to be a UUID-compatible ID, but this is not enforced, and formatted
58 differently. Developers can generate a new ID for this purpose with <command>systemd-id128 new</command>.
59 </para>
60 </listitem>
61 </varlistentry>
62
63 <varlistentry>
64 <term><varname>PRIORITY=</varname></term>
65 <listitem>
66 <para>A priority value between 0 (<literal>emerg</literal>)
67 and 7 (<literal>debug</literal>) formatted as a decimal
68 string. This field is compatible with syslog's priority
69 concept.</para>
70 </listitem>
71 </varlistentry>
72
73 <varlistentry>
74 <term><varname>CODE_FILE=</varname></term>
75 <term><varname>CODE_LINE=</varname></term>
76 <term><varname>CODE_FUNC=</varname></term>
77 <listitem>
78 <para>The code location generating this message, if known.
79 Contains the source filename, the line number and the
80 function name.</para>
81 </listitem>
82 </varlistentry>
83
84 <varlistentry>
85 <term><varname>ERRNO=</varname></term>
86 <listitem>
87 <para>The low-level Unix error number causing this entry, if
88 any. Contains the numeric value of
89 <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>
90 formatted as a decimal string.</para>
91 </listitem>
92 </varlistentry>
93
94 <varlistentry>
95 <term><varname>INVOCATION_ID=</varname></term>
96 <term><varname>USER_INVOCATION_ID=</varname></term>
97 <listitem>
98 <para>A randomized, unique 128-bit ID identifying each runtime cycle of the unit. This is different from
99 <varname>_SYSTEMD_INVOCATION_ID</varname> in that it is only used for messages coming from systemd code
100 (e.g. logs from the system/user manager or from forked processes performing systemd-related setup).</para>
101 </listitem>
102 </varlistentry>
103
104 <varlistentry>
105 <term><varname>SYSLOG_FACILITY=</varname></term>
106 <term><varname>SYSLOG_IDENTIFIER=</varname></term>
107 <term><varname>SYSLOG_PID=</varname></term>
108 <term><varname>SYSLOG_TIMESTAMP=</varname></term>
109 <listitem>
110 <para>Syslog compatibility fields containing the facility (formatted as
111 decimal string), the identifier string (i.e. "tag"), the client PID, and
112 the timestamp as specified in the original datagram. (Note that the tag is
113 usually derived from glibc's
114 <varname>program_invocation_short_name</varname> variable, see
115 <citerefentry project='die-net'><refentrytitle>program_invocation_short_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.)</para>
116 <para>Note that the journal service does not validate the values of any structured
117 journal fields whose name is not prefixed with an underscore, and this includes any
118 syslog related fields such as these. Hence, applications that supply a facility, PID,
119 or log level are expected to do so properly formatted, i.e. as numeric integers formatted
120 as decimal strings.</para>
121 </listitem>
122 </varlistentry>
123
124 <varlistentry>
125 <term><varname>SYSLOG_RAW=</varname></term>
126 <listitem>
127 <para>The original contents of the syslog line as received in the syslog
128 datagram. This field is only included if the <varname>MESSAGE=</varname>
129 field was modified compared to the original payload or the timestamp could
130 not be located properly and is not included in
131 <varname>SYSLOG_TIMESTAMP=</varname>. Message truncation occurs when when
132 the message contains leading or trailing whitespace (trailing and leading
133 whitespace is stripped), or it contains an embedded
134 <constant>NUL</constant> byte (the <constant>NUL</constant> byte and
135 anything after it is not included). Thus, the original syslog line is
136 either stored as <varname>SYSLOG_RAW=</varname> or it can be recreated
137 based on the stored priority and facility, timestamp, identifier, and the
138 message payload in <varname>MESSAGE=</varname>.
139 </para>
140 </listitem>
141 </varlistentry>
142
143 <varlistentry>
144 <term><varname>DOCUMENTATION=</varname></term>
145 <listitem>
146 <para>A documentation URL with further information about the topic of the log message. Tools such
147 as <command>journalctl</command> will include a hyperlink to an URL specified this way in their
148 output. Should be a <literal>http://</literal>, <literal>https://</literal>,
149 <literal>file:/</literal>, <literal>man:</literal> or <literal>info:</literal> URL.</para>
150 </listitem>
151 </varlistentry>
152
153 <varlistentry>
154 <term><varname>TID=</varname></term>
155 <listitem>
156 <para>The numeric thread ID (TID) the log message originates from.</para>
157 </listitem>
158 </varlistentry>
159 </variablelist>
160 </refsect1>
161
162 <refsect1>
163 <title>Trusted Journal Fields</title>
164
165 <para>Fields prefixed with an underscore are trusted fields, i.e.
166 fields that are implicitly added by the journal and cannot be
167 altered by client code.</para>
168
169 <variablelist class='journal-directives'>
170 <varlistentry>
171 <term><varname>_PID=</varname></term>
172 <term><varname>_UID=</varname></term>
173 <term><varname>_GID=</varname></term>
174 <listitem>
175 <para>The process, user, and group ID of the process the
176 journal entry originates from formatted as a decimal
177 string. Note that entries obtained via <literal>stdout</literal> or
178 <literal>stderr</literal> of forked processes will contain credentials valid for a parent
179 process (that initiated the connection to <command>systemd-journald</command>).</para>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry>
184 <term><varname>_COMM=</varname></term>
185 <term><varname>_EXE=</varname></term>
186 <term><varname>_CMDLINE=</varname></term>
187 <listitem>
188 <para>The name, the executable path, and the command line of
189 the process the journal entry originates from.</para>
190 </listitem>
191 </varlistentry>
192
193 <varlistentry>
194 <term><varname>_CAP_EFFECTIVE=</varname></term>
195 <listitem>
196 <para>The effective
197 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
198 of the process the journal entry originates from.</para>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry>
203 <term><varname>_AUDIT_SESSION=</varname></term>
204 <term><varname>_AUDIT_LOGINUID=</varname></term>
205 <listitem>
206 <para>The session and login UID of the process the journal
207 entry originates from, as maintained by the kernel audit
208 subsystem.</para>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry>
213 <term><varname>_SYSTEMD_CGROUP=</varname></term>
214 <term><varname>_SYSTEMD_SLICE=</varname></term>
215 <term><varname>_SYSTEMD_UNIT=</varname></term>
216 <term><varname>_SYSTEMD_USER_UNIT=</varname></term>
217 <term><varname>_SYSTEMD_USER_SLICE=</varname></term>
218 <term><varname>_SYSTEMD_SESSION=</varname></term>
219 <term><varname>_SYSTEMD_OWNER_UID=</varname></term>
220
221 <listitem>
222 <para>The control group path in the systemd hierarchy, the
223 the systemd slice unit name, the systemd unit name, the
224 unit name in the systemd user manager (if any), the systemd
225 session ID (if any), and the owner UID of the systemd user
226 unit or systemd session (if any) of the process the journal
227 entry originates from.</para>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry>
232 <term><varname>_SELINUX_CONTEXT=</varname></term>
233 <listitem>
234 <para>The SELinux security context (label) of the process
235 the journal entry originates from.</para>
236 </listitem>
237 </varlistentry>
238
239 <varlistentry>
240 <term><varname>_SOURCE_REALTIME_TIMESTAMP=</varname></term>
241 <listitem>
242 <para>The earliest trusted timestamp of the message, if any
243 is known that is different from the reception time of the
244 journal. This is the time in microseconds since the epoch
245 UTC, formatted as a decimal string.</para>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry>
250 <term><varname>_BOOT_ID=</varname></term>
251 <listitem>
252 <para>The kernel boot ID for the boot the message was
253 generated in, formatted as a 128-bit hexadecimal
254 string.</para>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry>
259 <term><varname>_MACHINE_ID=</varname></term>
260 <listitem>
261 <para>The machine ID of the originating host, as available
262 in
263 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry>
268 <term><varname>_SYSTEMD_INVOCATION_ID=</varname></term>
269 <listitem>
270 <para>The invocation ID for the runtime cycle of the unit
271 the message was generated in, as available to processes
272 of the unit in <varname>$INVOCATION_ID</varname> (see
273 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry>
278 <term><varname>_HOSTNAME=</varname></term>
279 <listitem>
280 <para>The name of the originating host.</para>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry>
285 <term><varname>_TRANSPORT=</varname></term>
286 <listitem>
287 <para>How the entry was received by the journal service.
288 Valid transports are:
289 </para>
290 <variablelist>
291 <varlistentry>
292 <term>
293 <option>audit</option>
294 </term>
295 <listitem>
296 <para>for those read from the kernel audit subsystem
297 </para>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry>
302 <term>
303 <option>driver</option>
304 </term>
305 <listitem>
306 <para>for internally generated messages
307 </para>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry>
312 <term>
313 <option>syslog</option>
314 </term>
315 <listitem>
316 <para>for those received via the local syslog socket
317 with the syslog protocol
318 </para>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry>
323 <term>
324 <option>journal</option>
325 </term>
326 <listitem>
327 <para>for those received via the native journal
328 protocol
329 </para>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry>
334 <term>
335 <option>stdout</option>
336 </term>
337 <listitem>
338 <para>for those read from a service's standard output
339 or error output
340 </para>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry>
345 <term>
346 <option>kernel</option>
347 </term>
348 <listitem>
349 <para>for those read from the kernel
350 </para>
351 </listitem>
352 </varlistentry>
353 </variablelist>
354 </listitem>
355 </varlistentry>
356 <varlistentry>
357 <term><varname>_STREAM_ID=</varname></term>
358 <listitem>
359 <para>Only applies to <literal>_TRANSPORT=stdout</literal> records: specifies a randomized 128bit ID assigned
360 to the stream connection when it was first created. This ID is useful to reconstruct individual log streams
361 from the log records: all log records carrying the same stream ID originate from the same stream.</para>
362 </listitem>
363 </varlistentry>
364 <varlistentry>
365 <term><varname>_LINE_BREAK=</varname></term>
366 <listitem>
367 <para>Only applies to <literal>_TRANSPORT=stdout</literal> records: indicates that the log message
368 in the standard output/error stream was not terminated with a normal newline character
369 (<literal>\n</literal>, i.e. ASCII 10). Specifically, when set this field is one of
370 <option>nul</option> (in case the line was terminated by a NUL byte), <option>line-max</option> (in
371 case the maximum log line length was reached, as configured with <varname>LineMax=</varname> in
372 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
373 <option>eof</option> (if this was the last log record of a stream and the stream ended without a
374 final newline character), or <option>pid-change</option> (if the process which generated the log
375 output changed in the middle of a line). Note that this record is not generated when a normal
376 newline character was used for marking the log line end.</para>
377 </listitem>
378 </varlistentry>
379 <varlistentry>
380 <term><varname>_NAMESPACE=</varname></term>
381
382 <listitem><para>If this file was written by a <command>systemd-journald</command> instance managing a
383 journal namespace that is not the default, this field contains the namespace identifier. See
384 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
385 for details about journal namespaces.</para>
386 </listitem>
387 </varlistentry>
388 </variablelist>
389 </refsect1>
390
391 <refsect1>
392 <title>Kernel Journal Fields</title>
393
394 <para>Kernel fields are fields that are used by messages
395 originating in the kernel and stored in the journal.</para>
396
397 <variablelist class='journal-directives'>
398 <varlistentry>
399 <term><varname>_KERNEL_DEVICE=</varname></term>
400 <listitem>
401 <para>The kernel device name. If the entry is associated to
402 a block device, the major and minor of the device node,
403 separated by <literal>:</literal> and prefixed by
404 <literal>b</literal>. Similar for character devices but
405 prefixed by <literal>c</literal>. For network devices, this
406 is the interface index prefixed by <literal>n</literal>. For
407 all other devices, this is the subsystem name prefixed by
408 <literal>+</literal>, followed by <literal>:</literal>,
409 followed by the kernel device name.</para>
410 </listitem>
411 </varlistentry>
412 <varlistentry>
413 <term><varname>_KERNEL_SUBSYSTEM=</varname></term>
414 <listitem>
415 <para>The kernel subsystem name.</para>
416 </listitem>
417 </varlistentry>
418 <varlistentry>
419 <term><varname>_UDEV_SYSNAME=</varname></term>
420 <listitem>
421 <para>The kernel device name as it shows up in the device
422 tree below <filename>/sys</filename>.</para>
423 </listitem>
424 </varlistentry>
425 <varlistentry>
426 <term><varname>_UDEV_DEVNODE=</varname></term>
427 <listitem>
428 <para>The device node path of this device in
429 <filename>/dev</filename>.</para>
430 </listitem>
431 </varlistentry>
432 <varlistentry>
433 <term><varname>_UDEV_DEVLINK=</varname></term>
434 <listitem>
435 <para>Additional symlink names pointing to the device node
436 in <filename>/dev</filename>. This field is frequently set
437 more than once per entry.</para>
438 </listitem>
439 </varlistentry>
440 </variablelist>
441 </refsect1>
442
443 <refsect1>
444 <title>Fields to log on behalf of a different program</title>
445
446 <para>Fields in this section are used by programs to specify that
447 they are logging on behalf of another program or unit.
448 </para>
449
450 <para>Fields used by the <command>systemd-coredump</command>
451 coredump kernel helper:
452 </para>
453
454 <variablelist class='journal-directives'>
455 <varlistentry>
456 <term><varname>COREDUMP_UNIT=</varname></term>
457 <term><varname>COREDUMP_USER_UNIT=</varname></term>
458 <listitem>
459 <para>Used to annotate messages containing coredumps from
460 system and session units. See
461 <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
462 </para>
463 </listitem>
464 </varlistentry>
465 </variablelist>
466
467 <para>Privileged programs (currently UID 0) may attach
468 <varname>OBJECT_PID=</varname> to a message. This will instruct
469 <command>systemd-journald</command> to attach additional fields on
470 behalf of the caller:</para>
471
472 <variablelist class='journal-directives'>
473 <varlistentry>
474 <term><varname>OBJECT_PID=<replaceable>PID</replaceable></varname></term>
475 <listitem>
476 <para>PID of the program that this message pertains to.
477 </para>
478 </listitem>
479 </varlistentry>
480
481 <varlistentry>
482 <term><varname>OBJECT_UID=</varname></term>
483 <term><varname>OBJECT_GID=</varname></term>
484 <term><varname>OBJECT_COMM=</varname></term>
485 <term><varname>OBJECT_EXE=</varname></term>
486 <term><varname>OBJECT_CMDLINE=</varname></term>
487 <term><varname>OBJECT_AUDIT_SESSION=</varname></term>
488 <term><varname>OBJECT_AUDIT_LOGINUID=</varname></term>
489 <term><varname>OBJECT_SYSTEMD_CGROUP=</varname></term>
490 <term><varname>OBJECT_SYSTEMD_SESSION=</varname></term>
491 <term><varname>OBJECT_SYSTEMD_OWNER_UID=</varname></term>
492 <term><varname>OBJECT_SYSTEMD_UNIT=</varname></term>
493 <term><varname>OBJECT_SYSTEMD_USER_UNIT=</varname></term>
494 <listitem>
495 <para>These are additional fields added automatically by
496 <command>systemd-journald</command>. Their meaning is the
497 same as
498 <varname>_UID=</varname>,
499 <varname>_GID=</varname>,
500 <varname>_COMM=</varname>,
501 <varname>_EXE=</varname>,
502 <varname>_CMDLINE=</varname>,
503 <varname>_AUDIT_SESSION=</varname>,
504 <varname>_AUDIT_LOGINUID=</varname>,
505 <varname>_SYSTEMD_CGROUP=</varname>,
506 <varname>_SYSTEMD_SESSION=</varname>,
507 <varname>_SYSTEMD_UNIT=</varname>,
508 <varname>_SYSTEMD_USER_UNIT=</varname>, and
509 <varname>_SYSTEMD_OWNER_UID=</varname>
510 as described above, except that the process identified by
511 <replaceable>PID</replaceable> is described, instead of the
512 process which logged the message.</para>
513 </listitem>
514 </varlistentry>
515 </variablelist>
516
517 </refsect1>
518
519 <refsect1>
520 <title>Address Fields</title>
521
522 <para>During serialization into external formats, such as the
523 <ulink
524 url="https://www.freedesktop.org/wiki/Software/systemd/export">Journal
525 Export Format</ulink> or the <ulink
526 url="https://www.freedesktop.org/wiki/Software/systemd/json">Journal
527 JSON Format</ulink>, the addresses of journal entries are
528 serialized into fields prefixed with double underscores. Note that
529 these are not proper fields when stored in the journal but for
530 addressing metadata of entries. They cannot be written as part of
531 structured log entries via calls such as
532 <citerefentry><refentrytitle>sd_journal_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
533 They may also not be used as matches for
534 <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
535 </para>
536
537 <variablelist class='journal-directives'>
538 <varlistentry>
539 <term><varname>__CURSOR=</varname></term>
540 <listitem>
541 <para>The cursor for the entry. A cursor is an opaque text
542 string that uniquely describes the position of an entry in
543 the journal and is portable across machines, platforms and
544 journal files.
545 </para>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry>
550 <term><varname>__REALTIME_TIMESTAMP=</varname></term>
551 <listitem>
552 <para>The wallclock time
553 (<constant>CLOCK_REALTIME</constant>) at the point in time
554 the entry was received by the journal, in microseconds since
555 the epoch UTC, formatted as a decimal string. This has
556 different properties from
557 <literal>_SOURCE_REALTIME_TIMESTAMP=</literal>, as it is
558 usually a bit later but more likely to be monotonic.
559 </para>
560 </listitem>
561 </varlistentry>
562
563 <varlistentry>
564 <term><varname>__MONOTONIC_TIMESTAMP=</varname></term>
565 <listitem>
566 <para>The monotonic time
567 (<constant>CLOCK_MONOTONIC</constant>) at the point in time
568 the entry was received by the journal in microseconds,
569 formatted as a decimal string. To be useful as an address
570 for the entry, this should be combined with the boot ID in
571 <literal>_BOOT_ID=</literal>.
572 </para>
573 </listitem>
574 </varlistentry>
575 </variablelist>
576 </refsect1>
577
578 <refsect1>
579 <title>See Also</title>
580 <para>
581 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
582 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
583 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
584 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
585 <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
586 <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
587 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
588 </para>
589 </refsect1>
590
591 </refentry>