Page MenuHomeVyOS Platform

syslog: typos in rsyslog.conf
Closed, ResolvedPublicBUG

Description

The vyos configuration for syslog remote hosts can generate two typos in the rsyslog.conf file which prevent rsyslogd from running.

  1. If "format octet-counted" is specified, it results in the typo below:

The generated /run/rsyslog/rsyslog.conf file is given the following line:

Current (with typo):  TCP_Framing="octed-counted"
Correct (typo fixed): TCP_Framing="octet-counted"
                                       ^ typo

https://github.com/vyos/vyos-1x/blob/3fee8ec30dce8f3987fe468d29109ed4e1bc492a/data/templates/rsyslog/rsyslog.conf.j2#L108
https://github.com/vyos/vyos-1x/blob/3fee8ec30dce8f3987fe468d29109ed4e1bc492a/smoketest/scripts/cli/test_system_syslog.py#L229

  1. If "format include-timezone" is specified, it results in the typo below:

The generated /run/rsyslog/rsyslog.conf file is given the following line:

Current (with typo):  template="SyslogProtocol23Format"
Correct (typo fixed): template="RSYSLOG_SyslogProtocol23Format"
                                ^ missing RSYSLOG_ prefix

https://github.com/vyos/vyos-1x/blob/3fee8ec30dce8f3987fe468d29109ed4e1bc492a/data/templates/rsyslog/rsyslog.conf.j2#L106
https://github.com/vyos/vyos-1x/blob/3fee8ec30dce8f3987fe468d29109ed4e1bc492a/smoketest/scripts/cli/test_system_syslog.py#L226

Vyos documentation:
https://docs.vyos.io/en/latest/configuration/system/syslog.html#remote-host

Upstream rsyslog documentation:
https://rsyslog.readthedocs.io/en/latest/configuration/modules/omfwd.html
https://www.rsyslog.com/doc/configuration/templates.html#reserved-template-names

Details

Version
-
Is it a breaking change?
Perfectly compatible
Issue type
Bug (incorrect behavior)

Event Timeline

Viacheslav changed the subtype of this task from "Task" to "Bug".Mar 21 2025, 10:29 AM
Viacheslav subscribed.

@woodsb02 Would you like to create a PR fix?

Viacheslav raised the priority of this task from Low to High.Mar 21 2025, 10:31 AM
woodsb02 renamed this task from syslog: format octet-counted not working due to typo in rsyslog.conf to syslog: typos in rsyslog.conf.Mar 21 2025, 11:39 AM
woodsb02 updated the task description. (Show Details)
Viacheslav changed the task status from Open to In progress.Mar 21 2025, 12:15 PM
Viacheslav assigned this task to woodsb02.
woodsb02 changed Is it a breaking change? from Unspecified (possibly destroys the router) to Perfectly compatible.
woodsb02 changed Issue type from Unspecified (please specify) to Bug (incorrect behavior).
c-po lowered the priority of this task from High to Normal.Mar 29 2025, 10:23 AM
c-po added a project: VyOS 1.5 Circinus.
c-po removed a project: Bugs.
c-po moved this task from Need Triage to Completed on the VyOS Rolling board.