Skip to content

New Smartdocs for journalctl #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

New Smartdocs for journalctl #531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions DC-SLES-journalctl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# This file originates from the project https://github.com/openSUSE/doc-kit
# This file can be edited downstream.

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

## Profiling
PROFOS="sles"
PROFCONDITION="16.0"
STRUCTID="sles-cockpit"
#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"
171 changes: 171 additions & 0 deletions articles/journalctl.asm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
<?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/cockpit-about-cockpit.xml" xml:id="_cocpit-about-cockpit"/>

<!-- glue -->
<resource href="../glues/cockpit-managing-filesystem.xml" xml:id="_cockpit-managingfs-glue"/>

<!-- tasks -->
<resource href="../tasks/cockpit-primary-servers.xml" xml:id="_cockpit-primary-servers"/>
<!-- references -->
<resource href="../references/cockpit-logs.xml" xml:id="_cockpit-logs-reference"/>
</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-journalctl">
<merge>
<title>Viewing logs using &journalctl;</title>
<!-- History -->
<revhistory xml:id="rh-sles-cockpit">
<revision><date>2025-09-11</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">View logs using &journalctl;</meta>
<meta name="description">
How to view and manage &productnameshort; logs using &journalctl;</meta>
<!-- Search -->
<meta name="social-descr">View &productnameshort; logs using &journalctl;</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>
You can view and analyze logs from &systemd-journald; using the &journalctl; command-line tool.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
This article is intended to provide a complete overview of
tasks that can be performed using the &journalctl; 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 &journalctl;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<para>
To fully view the system-wide logs such as kernel, system services, or other user logs using &journaltl; command-line tool, you must have
&sudo; privileges.
</para>
<para>The &systemd-journald; service must be running as it collects the logs. </para>
<para>For persistent logs across reboots, <filename>var/log/journal</filename> file must be available. Volatile logs are saved in <filename>/run/log/journal</filename>
</listitem>
</varlistentry>
</variablelist>
</abstract>
</merge>
<module renderas="section" resourceref="_journalctl-viewing-logs">
<merge>
<abstract>
<para>
Using the &cockpit; <guimenu>Overview</guimenu> part, you can
perform changes to the default server configuration or the
configuration you provided during the manual installation. In this
part, you can change the host name or change the system date or time
zone.
</para>
</abstract>
</merge>
</module>
<module renderas="section" resourceref="_cockpit-selinux">
<module renderas="section" resourceref="_cockpit-troubleshooting-selinux">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
</assembly>