]>
Commit | Line | Data |
---|---|---|
a8eedf49 | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
eea10b26 | 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> |
db9ecf05 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
a8eedf49 | 5 | |
6a70f3aa | 6 | <refentry id="sd-journal" |
798d3a52 ZJS |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
8 | ||
9 | <refentryinfo> | |
10 | <title>sd-journal</title> | |
11 | <productname>systemd</productname> | |
798d3a52 ZJS |
12 | </refentryinfo> |
13 | ||
14 | <refmeta> | |
15 | <refentrytitle>sd-journal</refentrytitle> | |
16 | <manvolnum>3</manvolnum> | |
17 | </refmeta> | |
18 | ||
19 | <refnamediv> | |
20 | <refname>sd-journal</refname> | |
21 | <refpurpose>APIs for submitting and querying log entries to and | |
22 | from the journal</refpurpose> | |
23 | </refnamediv> | |
24 | ||
25 | <refsynopsisdiv> | |
26 | <funcsynopsis> | |
27 | <funcsynopsisinfo>#include <systemd/sd-journal.h></funcsynopsisinfo> | |
28 | </funcsynopsis> | |
29 | ||
30 | <cmdsynopsis> | |
31 | <command>pkg-config --cflags --libs libsystemd</command> | |
32 | </cmdsynopsis> | |
33 | ||
34 | </refsynopsisdiv> | |
35 | ||
36 | <refsect1> | |
37 | <title>Description</title> | |
38 | ||
4bc96dc1 ZJS |
39 | <para><filename>sd-journal.h</filename> is part of |
40 | <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and | |
41 | provides APIs to submit and query log entries. The APIs exposed act both as client for the | |
798d3a52 ZJS |
42 | <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
43 | journal service and as parser for the journal files on disk. | |
44 | </para> | |
45 | ||
46 | <para>See | |
47 | <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
48 | <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
49 | <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
50 | <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
51 | <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
52 | <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
53 | <citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
eb86030e | 54 | <citerefentry><refentrytitle>sd_journal_enumerate_fields</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
798d3a52 ZJS |
55 | <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
56 | <citerefentry><refentrytitle>sd_journal_get_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
57 | <citerefentry><refentrytitle>sd_journal_get_cutoff_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
58 | <citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
39fd5b08 JS |
59 | <citerefentry><refentrytitle>sd_journal_get_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
60 | <citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
61 | <citerefentry><refentrytitle>sd_journal_has_runtime_files</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
798d3a52 | 62 | and |
39fd5b08 | 63 | <citerefentry><refentrytitle>sd_journal_has_persistent_files</refentrytitle><manvolnum>3</manvolnum></citerefentry> |
798d3a52 ZJS |
64 | for more information about the functions implemented.</para> |
65 | ||
66 | <para>Command line access for submitting entries to the journal is | |
67 | available with the | |
68 | <citerefentry><refentrytitle>systemd-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
69 | tool. Command line access for querying entries from the journal is | |
70 | available with the | |
71 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
72 | tool.</para> | |
73 | </refsect1> | |
74 | ||
a8d46a16 ZJS |
75 | <refsect1> |
76 | <title>Thread safety</title> | |
77 | ||
64a7ef8b LP |
78 | <para>Functions that operate on <structname>sd_journal</structname> objects are thread agnostic — given |
79 | <structname>sd_journal</structname> pointer may only be used from one specific thread at all times (and it has to | |
80 | be the very same one during the entire lifetime of the object), but multiple, independent threads may use multiple, | |
81 | independent objects safely. Other functions — those that are used to send entries to the journal, like | |
82 | <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> and similar, | |
83 | or those that are used to retrieve global information like | |
84 | <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and | |
a8d46a16 | 85 | <citerefentry><refentrytitle>sd_journal_get_catalog_for_message_id</refentrytitle><manvolnum>3</manvolnum></citerefentry> |
64a7ef8b | 86 | — are fully thread-safe and may be called from multiple threads in parallel.</para> |
a8d46a16 ZJS |
87 | </refsect1> |
88 | ||
5aa81803 LB |
89 | <refsect1> |
90 | <title>Optional dependencies</title> | |
91 | ||
92 | <para>Depending on which build-time options are enabled, functions that operate on | |
93 | <structname>sd_journal</structname> objects might cause optional shared libraries to be dynamically | |
94 | loaded via | |
e5610375 | 95 | <citerefentry project='man-pages'><refentrytitle>dlopen</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
5aa81803 LB |
96 | such as decompression libraries (xz, lz4, zstd) or cryptographic libraries (gcrypt). |
97 | </para> | |
98 | </refsect1> | |
99 | ||
798d3a52 ZJS |
100 | <xi:include href="libsystemd-pkgconfig.xml" /> |
101 | ||
102 | <refsect1> | |
103 | <title>See Also</title> | |
13a69c12 DT |
104 | <para><simplelist type="inline"> |
105 | <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
106 | <member><citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
107 | <member><citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
108 | <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
109 | <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
110 | <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
111 | <member><citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
112 | <member><citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
113 | <member><citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
114 | <member><citerefentry><refentrytitle>sd_journal_enumerate_fields</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
115 | <member><citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
116 | <member><citerefentry><refentrytitle>sd_journal_get_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
117 | <member><citerefentry><refentrytitle>sd_journal_get_cutoff_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
118 | <member><citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
119 | <member><citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
120 | <member><citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
121 | <member><citerefentry><refentrytitle>sd_journal_get_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
122 | <member><citerefentry><refentrytitle>sd_journal_has_runtime_files</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
123 | <member><citerefentry><refentrytitle>sd_journal_has_persistent_files</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
124 | <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
125 | <member><citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
126 | <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
127 | </simplelist></para> | |
798d3a52 | 128 | </refsect1> |
a8eedf49 LP |
129 | |
130 | </refentry> |