=======
Journal
=======

.. sidebar:: Contents

  .. contents::
      :depth: 3
      :local:

This chapter covers some aspects related to the :osdx:cfg:`system journal` configuration tool,
which allows you to configure the behaviour of the journal command in OSDx.

Journal is a tool that is responsible for collecting and managing systemd logs, allowing the user to access the data to,
for example, identify errors or monitor the system.

The :osdx:cfg:`system journal` configuration must be configured using one of the following values:

* ``max-use``: This option accepts values ranging between 0 and 100. This percentage specifies the maximum amount of memory that the dedicated filesystem (about 10% of RAM) can use for storing rotated journalctl files. The system will store 4 GB at most, so if you choose a percentage whose memory is higher than this value, the system will store 4GB anyway. By default, this value is set to 10%.

:ref:`Here <troubleshooting/logging/index:Journal>`, you can find more information about journal operational commands.

Configuration
=============

This is the syntax to configure the behaviour of the :osdx:cfg:`system journal` configuration in OSDx:

.. code-block:: none

  set system journal max-use [ ... ]


Examples
========

Configure journal limit
-----------------------

Imagine you want to configure the memory used to store logs.
To achieve this goal, you have to change this value to one between 0 and 100:

.. code-block:: none

  set system journal max-use 10

.. important::  If you have stored more memory than your limit, the memory will be flushed. In any other case, you will keep your journal files.

Command Summary
===============

.. osdx:cmdtree:: op

  system journal

.. osdx:cmdtree:: cfg

  system journal