Skip to content

journald: add read-old-on-error() option #301

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
HofiOne wants to merge 1 commit into
base: master
Choose a base branch
from
Open

journald: add read-old-on-error() option #301

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: 16 additions & 3 deletions doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ description: >-

The systemd-journal() driver has the following options:

{% include doc/admin-guide/options/chain-hostnames.md %}

{% include doc/admin-guide/options/default-facility.md %}

{% include doc/admin-guide/options/default-priority.md %}
Expand All @@ -22,8 +24,6 @@ The systemd-journal() driver has the following options:
*Description:* The default level value if the `PRIORITY` entry does not
exist.

{% include doc/admin-guide/options/chain-hostnames.md %}

{% include doc/admin-guide/options/format.md %}

{% include doc/admin-guide/options/hook.md %}
Expand Down Expand Up @@ -147,8 +147,21 @@ get a prefix (for example: ".SDATA.journald."). By default, {{ site.product.shor
*Description:* If set to **yes**, {{ site.product.short_name }} will start reading the
records from the beginning of the journal, if the journal has not been
read yet. If set to **no**, {{ site.product.short_name }} will read only the new
records. If the source has a state in the persist file, this option will
records.

**NOTE:** If the source has a state in the persist file, this option will
have no effect.
{: .notice--info}

See read-old-on-error() for the behavior of {{ site.product.short_name }} when the source has a state in the persist file but {{ site.product.short_name }} cannot locate this position at startup.

## read-old-on-error()

| Accepted values:| yes \| no|
|Default:| yes|

*Description:* When the source has a state in the persist file, {{ site.product.short_name }} attempts to read the journal from the last recorded position at startup.\
If {{ site.product.short_name }} cannot locate this position (for example, because the journal has been rotated or cleared since the last read), this option determines whether {{ site.product.short_name }} starts reading records from the beginning of the journal or only processes new records. If set to `yes`, it reads from the beginning; otherwise, it reads only new records.

{% include doc/admin-guide/options/sdata-prefix.md %}

Expand Down
28 changes: 13 additions & 15 deletions doc/_admin-guide/060_Sources/190_systemd-journal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,41 @@ description: >-
The systemd-journal() source is used on various Linux distributions,
such as RHEL (from RHEL7) and CentOS. The systemd-journal() source
driver can read the structured name-value format of the journald system
service, making it easier to reach the custom fields in the message. By
default, {{ site.product.short_name }} adds the .journald. prefix to the name of every
parsed value. For a list and description of name-value pairs that
journald provides, see the documentation of journald for your platform
(for example, man systemd.journal-fields).
service, making it easier to reach the custom fields in the message.
---

The systemd-journal() source driver is designed to read only local
messages through the systemd-journal API. It is not possible to set the
location of the journal files, or the directories.
location of the journal files, or the directories.\
By default, {{ site.product.short_name }} adds the `.journald.` prefix to the name of every
parsed value. For a list and description of name-value pairs that
journald provides, see the documentation of journald for your platform
(for example, `man systemd.journal-fields`).

**NOTE:** The log-msg-size() option is not applicable for this source. Use
the **max-field-size()** option instead.
the max-field-size() option instead.
{: .notice--info}

>**NOTE:** This source will not handle the following cases:
>
>
- Corrupted journal file
- Incorrect journal configuration
- Any other journald-related bugs
{: .notice--info}

**NOTE:** If you are using RHEL-7, the default source in the configuration
is systemd-journal() instead of unix-dgram(\"/dev/log\") and
file(\"/proc/kmsg\"). If you are using unix-dgram(\"/dev/log\") or
unix-stream(\"/dev/log\") in your configuration as a source, {{ site.product.short_name }} will revert to using systemd-journal() instead.
is systemd-journal() instead of unix-dgram("/dev/log") and
file("/proc/kmsg"). If you are using unix-dgram("/dev/log") or
unix-stream("/dev/log") in your configuration as a source, {{ site.product.short_name }} will revert to using systemd-journal() instead.
{: .notice--info}

![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:**
Only one systemd-journal() source can be configured in the configuration file.
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** Only one systemd-journal() source can be configured in the configuration file.
If there is more than one systemd-journal() source configured, {{ site.product.short_name }}
will not start.
{: .notice--warning}

![]({{ site.baseurl}}/assets/images/caution.png)
**CAUTION:**
The systemd-journal() source cannot operate under an Ubuntu 24.04 LTS (Noble Numbat) platform. For more information on supported platforms, see Supported platforms.
**CAUTION:** The systemd-journal() source cannot operate under an Ubuntu 24.04 LTS (Noble Numbat) platform. For more information on supported platforms, see Supported platforms.
{: .notice--warning}

**Declaration**
Expand Down