Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
a1e91fe
New Smartdocs for journalctl
harneshalaka Sep 11, 2025
fdca762
New topic.
harneshalaka Nov 23, 2025
71350c4
Updated.
harneshalaka Nov 24, 2025
ab3205d
Fixed errors.
harneshalaka Nov 24, 2025
29a9c44
Fixed errors.
harneshalaka Nov 24, 2025
70e8f7c
Fixed errors.
harneshalaka Nov 24, 2025
f7a11bf
Fixed errors.
harneshalaka Nov 24, 2025
d6ed57d
Fixed errors.
harneshalaka Nov 24, 2025
069b734
Fixed errors.
harneshalaka Nov 24, 2025
5437555
Fixed errors.
harneshalaka Nov 24, 2025
acd6720
Fixed errors.
harneshalaka Nov 24, 2025
1f6a987
Fixed errors.
harneshalaka Nov 24, 2025
c8d1128
Fixed errors.
harneshalaka Nov 24, 2025
df14ed1
Apply suggestions from code review
harneshalaka Nov 26, 2025
a8351fc
Fixed editorial comments.
harneshalaka Nov 26, 2025
ab0a086
Updated.
harneshalaka Nov 27, 2025
7718321
Fixed feedback.
harneshalaka Nov 27, 2025
ae6297d
Fixed feedback.
harneshalaka Nov 27, 2025
f3f480e
Fixed errors.
harneshalaka Nov 27, 2025
8dcc2e7
Moved contents from concept.
harneshalaka Nov 28, 2025
c0bc7b5
Co-authored-by: lvicoun <[email protected]>
harneshalaka Nov 26, 2025
485543c
Fixed feedback.
harneshalaka Nov 28, 2025
8a5941a
Fixed comments.
harneshalaka Nov 28, 2025
65cdc6e
Fixed validation errors.
harneshalaka Nov 28, 2025
b74a66e
Fixed comments from JanaH.
harneshalaka Dec 2, 2025
cfcb6ac
Fixed comments from JanaH.
harneshalaka Dec 2, 2025
2c061b5
Fixed comments from JanaH.
harneshalaka Dec 2, 2025
7fceb5b
Fixed comments from JanaH.
harneshalaka Dec 2, 2025
e907260
Merge branch 'sharne/journalctl' of github.com:SUSE/doc-modular into …
harneshalaka Dec 2, 2025
3d679d1
Added first batch of changes.
lvicoun Dec 4, 2025
fbb2bac
Changed the journal section.
lvicoun Dec 5, 2025
5d26a1a
Completed the article.
lvicoun Dec 9, 2025
f234c65
Apply suggestions from code review
harneshalaka Dec 11, 2025
3e8e782
Update articles/journalctl.asm.xml
harneshalaka Dec 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions DC-SLES-journalctl
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# This file originates from the project https://github.com/openSUSE/doc-kit
# This file can be edited downstream.

## Basics
MAIN="journalctl.asm.xml"
SRC_DIR="articles"
IMG_SRC_DIR="images"

## Profiling
PROFOS="sles"
PROFCONDITION="16.0"
#PROFARCH="x86_64;zseries;power;aarch64"

DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"

## stylesheet location
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2021-ns"
157 changes: 157 additions & 0 deletions articles/journalctl.asm.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-model href="https://cdn.docbook.org/schema/5.2/rng/assemblyxi.rnc"
type="application/relax-ng-compact-syntax"?>
<!DOCTYPE assembly
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to https://github.com/SUSE/doc-sle/blob/main/xml/systemd.xml -->
<assembly version="5.2" xml:lang="en"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns="http://docbook.org/ns/docbook">
<!-- R E S O U R C E S -->
<resources>
<!-- concepts -->
<resource href="../concepts/journal-about-journald.xml" xml:id="_journal-about-journald"/>
<resource href="../concepts/journal-structure.xml" xml:id="_journal-structure"/>
<resource href="../concepts/journactl-about.xml" xml:id="_journactl-about"/>
<!-- glue -->
<!-- tasks-->
<resource href="../tasks/journald-configure.xml" xml:id="_journald-configure"/>
<resource href="../tasks/systemd-journald-troubleshooting.xml" xml:id="_systemd-journald-troubleshooting"/>
<resource href="../tasks/journald-filter-journals.xml" xml:id="_journald-filter-journals"/>
<!-- references-->
<resource href="../references/journalctl-usage.xml" xml:id="_journalctl-usage"/>
</resources>

<!-- Appendix -->
<resources>
<resource href="../common/legal.xml" xml:id="_legal">
<description>Legal Notice</description>
</resource>
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
<description>GNU Free Documentation License</description>
</resource>
</resources>
<structure renderas="article" xml:id="sles-journald">
<merge>
<title>Mastering System Logs: From <command>systemd-journald</command> to <command>journalctl</command></title>
<!-- History -->
<revhistory xml:id="rh-sles-journald">
<revision><date>2025-11-26</date>
<revdescription>
<para>
Initial version
</para>
</revdescription>
</revision>
</revhistory>
<!-- Maintainer -->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<!-- Architecture -->
<meta name="architecture" its:translate="no">
<phrase>&x86-64;</phrase>
<phrase>&power;</phrase>
<phrase>&zseries;</phrase>
<phrase>&aarch64;</phrase>
</meta>
<!-- Productname & Version -->
<meta name="productname">
<productname version="16.0">&sles;</productname>
<productname version="16.0">&sles4sap;</productname>
<productname version="16.0">&sleha;</productname>
</meta>
<!-- Social Media -->
<meta name="title">Mastering System Logs: From <command>systemd-journald</command> to <command>journalctl</command></meta>
<meta name="description">
Learn how to view and manage &productnameshort; logs using <command>journalctl</command></meta>
<!-- Search -->
<meta name="social-descr">View and filter logs with <command>journalctl</command></meta>
<!-- Task -->
<meta name="task" its:translate="no">
<phrase>Configuration</phrase>
<phrase>Storage</phrase>
<phrase>Maintenance</phrase>
<phrase>Administration</phrase>
</meta>

<meta name="category" its:translate="no"><phrase>Systems Management</phrase>
</meta>
<!-- Series -->
<meta name="series" its:translate="no">Products &amp; Solutions</meta>

<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Documentation</dm:component>
<dm:product os="sles">SUSE Linux Enterprise Server 16.0</dm:product>
<dm:product os="sles4sap">SUSE Linux Enterprise Server 16.0</dm:product>
<dm:product os="sleha">SUSE Linux Enterprise Server 16.0</dm:product>
<dm:assignee>[email protected]</dm:assignee>
</dm:bugtracker>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<abstract>
<variablelist>
<varlistentry>
<term>WHAT?</term>
<listitem>
<para>
View and analyze logs from <command>systemd-journald</command> using the <command>journalctl</command> command-line tool.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
This article provides a complete overview of tasks that can be performed using the <command>journalctl</command> command-line tool.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
The average reading time of this article is approximately 30 minutes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
You will be able to view your system logs using <command>journalctl</command>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<para>
You must have &sudo; privileges.
</para>
</listitem>
</varlistentry>
</variablelist>
</abstract>
</merge>
<module renderas="section" resourceref="_journal-about-journald">
<module renderas="section" resourceref="_journald-configure"/>
</module>
<module renderas="section" resourceref="_journal-structure"/>
<module renderas="section" resourceref="_journactl-about">
<module renderas="section" resourceref="_journalctl-usage"/>
</module>
<module renderas="section" resourceref="_journald-filter-journals"/>

<module renderas="section" resourceref="_systemd-journald-troubleshooting"/>
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
</assembly>
38 changes: 38 additions & 0 deletions concepts/journactl-about.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="journald-about-journactl"
role="concept" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>The <command>journalctl</command> command</title><!-- can be changed via merge in the assembly -->
<!--add author's email address-->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract><!-- can be changed via merge in the assembly -->
<para>
<command>journalctl</command> is a command-line utility used to query and display logs collected by
the <command>systemd-journald</command>.
</para>
</abstract>
</info>
<para>
Because the logging system stores data in a binary format (for performance and security) rather
than plain text, you cannot use standard tools like <command>cat</command> or
<command>less</command> to open the files directly. So, the <command>journalctl</command>
command decodes the data and displays it according to the provided parameters.
</para>

</topic>
34 changes: 34 additions & 0 deletions concepts/journal-about-journald.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="concept-about-journald"
role="concept" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>The <command>systemd-journald</command> service</title>
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract>
<para>
<command>journald</command> is a &systemd; service responsible for collecting, indexing, and storing log data. The collected events include kernel messages, initrd (initial RAM disk) messages,
service startup/shutdown, application events, and authentication and session data.
</para>
</abstract>
</info>
<para>
On &productname;, the <literal>systemd-journald</literal> service is enabled and started by
default. The service logs the data into the journal described in <xref linkend="journal-what-it-is"/>.
</para>


</topic>
Loading