Do not pass the option "device" in rsyslog.conf by default when syslog server's source address is configured #17616

stephenxs · 2023-12-25T13:17:17Z

Why I did it

An in-band syslog server will not receive any syslog if it is configured without a VRF specified, which is because eth0 is always specified as the device of a syslog server and the syslog packets will be sent to eth0 regardless of its destination IP address.

Work item tracking

Microsoft ADO (number only):

How I did it

Pass the option "device" in rsyslog.conf only if when syslog server's source address is configured with a non-default VRF

How to verify it

Manually test:

Configuring a syslog server without VRF specified or with default as the VRF: no device passed in rsyslog.conf
Configuring a syslog server with non-default VRF: the configured VRF passed as device in rsyslog.conf

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

Signed-off-by: Stephen Sun <stephens@nvidia.com>

mssonicbld · 2023-12-25T13:24:25Z

@StormLiangMS,@liushilongbuaa PR: #17616 is conflict with MS internal repo
Please complete the following PR by pushing fix commit to sonicbld/conflict_prefix/17616-fix
https://msazure.visualstudio.com/One/_git/Networking-acs-buildimage/pullrequest/9283703
Then comment "/azpw ms_conflict" to rerun PR checker.

StormLiangMS · 2023-12-26T02:18:05Z

/azp run ms_conflict

azure-pipelines · 2023-12-26T02:18:11Z

No pipelines are associated with this pull request.

StormLiangMS · 2023-12-26T02:18:22Z

/azpw ms_conflict

StormLiangMS · 2023-12-26T02:39:36Z

hi @qiluo-msft could you have expert to take a look at this PR? And there is an internal conflict.

wen587 · 2023-12-26T04:21:29Z

/azpw ms_conflict

qiluo-msft · 2024-01-10T22:59:38Z

Is it covered by sonic-mgmt testcases? #Closed

stephenxs · 2024-01-11T00:58:24Z

Is it covered by sonic-mgmt testcases?

I do not think so. this was found by our internal QA test.

qiluo-msft · 2024-01-14T05:30:23Z

Is it covered by sonic-mgmt testcases?

I do not think so. this was found by our internal QA test.

Could you add a test for the behavior "an in-band syslog server will not receive any syslog if it is configured without a VRF specified"? #Closed

stephenxs · 2024-01-15T03:01:12Z

Is it covered by sonic-mgmt testcases?

I do not think so. this was found by our internal QA test.

Could you add a test for the behavior "an in-band syslog server will not receive any syslog if it is configured without a VRF specified"?

I'm not sure whether there is infra for such test cases. So, I need to check the details and get back to you
Is it possible to merge it first because it's a blocker to our 202305 release and then we will add the test case later?
Thanks

files/image_config/rsyslog/rsyslog.conf.j2

qiluo-msft · 2024-01-22T02:52:02Z

@prsunny Could you help review?

qiluo-msft · 2024-02-12T17:23:46Z

This is still applicable. We could not approve this PR if testcase is not implemented.

In reply to: 1890853775

stephenxs · 2024-03-18T14:14:38Z

This is still applicable. We could not approve this PR if testcase is not implemented.

In reply to: 1890853775

Test plan ready for review sonic-net/sonic-mgmt#11803

qiluo-msft · 2024-03-28T19:00:32Z

ADO 27353460
@StormLiangMS Please help backport.

StormLiangMS · 2024-03-29T09:09:57Z

hi @stephenxs @wen587 pls have test with 202305 on brcm/mellanox/cisco/marvell platform, would like to avoid regression.

stephenxs · 2024-03-29T09:23:17Z

hi @stephenxs @wen587 pls have test with 202305 on brcm/mellanox/cisco/marvell platform, would like to avoid regression.

@StormLiangMS this is platform independent feature. It was tested on 202305 on mellanox platform.

wen587 · 2024-03-29T09:45:34Z

Hi @StormLiangMS , I tested the rsyslog.conf generation in 202305 PROD. I tried with one MGMTdevice and one non-MGMTdevice patching the PR.
Both devices show the same difference as below:

action(type="omfwd" Target="some_ip" Port="514" Protocol="udp" Device="eth0")
Changed to
action(type="omfwd" Target="some_ip" Port="514" Protocol="udp" Template="SONiCFileFormat")
Since SONiCFileFormat is the default template. So it just eliminates the Device variable. There should be no regression.

…g server's source address is configured (sonic-net#17616) ### Why I did it An in-band syslog server will not receive any syslog if it is configured without a VRF specified, which is because `eth0` is always specified as the `device` of a syslog server and the syslog packets will be sent to `eth0` regardless of its destination IP address. ### How I did it Pass the option "device" in rsyslog.conf only if when syslog server's source address is configured with a non-default VRF #### How to verify it Manually test: 1. Configuring a syslog server without VRF specified or with `default` as the VRF: no `device` passed in `rsyslog.conf` 2. Configuring a syslog server with non-default VRF: the configured VRF passed as `device` in `rsyslog.conf`

…g server's source address is configured (#17616) (#18514) ### Why I did it An in-band syslog server will not receive any syslog if it is configured without a VRF specified, which is because `eth0` is always specified as the `device` of a syslog server and the syslog packets will be sent to `eth0` regardless of its destination IP address. ### How I did it Pass the option "device" in rsyslog.conf only if when syslog server's source address is configured with a non-default VRF #### How to verify it Manually test: 1. Configuring a syslog server without VRF specified or with `default` as the VRF: no `device` passed in `rsyslog.conf` 2. Configuring a syslog server with non-default VRF: the configured VRF passed as `device` in `rsyslog.conf` Co-authored-by: Stephen Sun <5379172+stephenxs@users.noreply.github.com>

…g server's source address is configured (sonic-net#17616) ### Why I did it An in-band syslog server will not receive any syslog if it is configured without a VRF specified, which is because `eth0` is always specified as the `device` of a syslog server and the syslog packets will be sent to `eth0` regardless of its destination IP address. ### How I did it Pass the option "device" in rsyslog.conf only if when syslog server's source address is configured with a non-default VRF #### How to verify it Manually test: 1. Configuring a syslog server without VRF specified or with `default` as the VRF: no `device` passed in `rsyslog.conf` 2. Configuring a syslog server with non-default VRF: the configured VRF passed as `device` in `rsyslog.conf`

mssonicbld · 2024-04-01T15:58:29Z

Cherry-pick PR to 202311: #18518

…g server's source address is configured (#17616) ### Why I did it An in-band syslog server will not receive any syslog if it is configured without a VRF specified, which is because `eth0` is always specified as the `device` of a syslog server and the syslog packets will be sent to `eth0` regardless of its destination IP address. ### How I did it Pass the option "device" in rsyslog.conf only if when syslog server's source address is configured with a non-default VRF #### How to verify it Manually test: 1. Configuring a syslog server without VRF specified or with `default` as the VRF: no `device` passed in `rsyslog.conf` 2. Configuring a syslog server with non-default VRF: the configured VRF passed as `device` in `rsyslog.conf`

fastiuk and others added 3 commits December 25, 2023 05:25

Don't use syslog Device when source was configured

0d9155b

Configure device only if the (management) vrf is not default

2ecfc36

Signed-off-by: Stephen Sun <stephens@nvidia.com>

Fix typo

3de9269

Signed-off-by: Stephen Sun <stephens@nvidia.com>

stephenxs requested a review from lguohan as a code owner December 25, 2023 13:17

StormLiangMS requested a review from qiluo-msft December 26, 2023 02:38

stephenxs added Request for 202305 Branch Request for 202311 Branch labels Dec 28, 2023

qiluo-msft requested a review from prsunny January 10, 2024 22:59

qiluo-msft reviewed Jan 22, 2024

View reviewed changes

files/image_config/rsyslog/rsyslog.conf.j2 Show resolved Hide resolved

qiluo-msft approved these changes Mar 23, 2024

View reviewed changes

qiluo-msft merged commit 610685d into sonic-net:master Mar 24, 2024
20 checks passed

stephenxs deleted the fix-log-sintf branch March 24, 2024 09:34

StormLiangMS added the Approved for 202305 Branch label Mar 29, 2024

StormLiangMS added Approved for 202305 Branch and removed Approved for 202305 Branch labels Mar 29, 2024

StormLiangMS mentioned this pull request Mar 30, 2024

[cherrypick 202305]Do not pass the option "device" in rsyslog.conf by default when syslog server's source address is configured #18514

Merged

11 tasks

liushilongbuaa added Approved for 202305 Branch and removed Approved for 202305 Branch labels Apr 1, 2024

mssonicbld added the Cherry Pick Conflict_202305 label Apr 1, 2024

liushilongbuaa added Included in 202305 Branch and removed Cherry Pick Conflict_202305 labels Apr 1, 2024

yxieca added the Approved for 202311 Branch label Apr 1, 2024

mssonicbld mentioned this pull request Apr 1, 2024

[action] [PR:17616] Do not pass the option "device" in rsyslog.conf by default when syslog server's source address is configured (#17616) #18518

Merged

mssonicbld added the Created PR to 202311 Branch label Apr 1, 2024

mssonicbld added Included in 202311 Branch and removed Created PR to 202311 Branch labels Apr 1, 2024

qiluo-msft mentioned this pull request Jul 23, 2024

Add remote syslog configuration #14513

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not pass the option "device" in rsyslog.conf by default when syslog server's source address is configured #17616

Do not pass the option "device" in rsyslog.conf by default when syslog server's source address is configured #17616

stephenxs commented Dec 25, 2023

mssonicbld commented Dec 25, 2023

StormLiangMS commented Dec 26, 2023

azure-pipelines bot commented Dec 26, 2023

StormLiangMS commented Dec 26, 2023

StormLiangMS commented Dec 26, 2023

wen587 commented Dec 26, 2023

qiluo-msft commented Jan 10, 2024 •

edited

Loading

stephenxs commented Jan 11, 2024

qiluo-msft commented Jan 14, 2024 •

edited

Loading

stephenxs commented Jan 15, 2024

qiluo-msft commented Jan 22, 2024

qiluo-msft commented Feb 12, 2024

stephenxs commented Mar 18, 2024

qiluo-msft commented Mar 28, 2024

StormLiangMS commented Mar 29, 2024

stephenxs commented Mar 29, 2024

wen587 commented Mar 29, 2024

mssonicbld commented Apr 1, 2024

Do not pass the option "device" in rsyslog.conf by default when syslog server's source address is configured #17616

Do not pass the option "device" in rsyslog.conf by default when syslog server's source address is configured #17616

Conversation

stephenxs commented Dec 25, 2023

Why I did it

Work item tracking

How I did it

How to verify it

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

mssonicbld commented Dec 25, 2023

StormLiangMS commented Dec 26, 2023

azure-pipelines bot commented Dec 26, 2023

StormLiangMS commented Dec 26, 2023

StormLiangMS commented Dec 26, 2023

wen587 commented Dec 26, 2023

qiluo-msft commented Jan 10, 2024 • edited Loading

stephenxs commented Jan 11, 2024

qiluo-msft commented Jan 14, 2024 • edited Loading

stephenxs commented Jan 15, 2024

qiluo-msft commented Jan 22, 2024

qiluo-msft commented Feb 12, 2024

stephenxs commented Mar 18, 2024

qiluo-msft commented Mar 28, 2024

StormLiangMS commented Mar 29, 2024

stephenxs commented Mar 29, 2024

wen587 commented Mar 29, 2024

mssonicbld commented Apr 1, 2024

qiluo-msft commented Jan 10, 2024 •

edited

Loading

qiluo-msft commented Jan 14, 2024 •

edited

Loading