Update RSyslog HLD with new functionality #1218

iavraham · 2023-01-16T08:39:22Z

Adding the following functionality:

Configure remote syslog servers: protocol, filter, trap severity level
Update global syslog configuration: trap severity kevel, message format

these are the implementation PRs for community review:

Repo	PR title	State
sonic-swss-common	[rsyslog]add syslog global config to db
sonic-host-services	[rsyslog]Add remote syslog configuration
sonic-buildimage	[rsyslog]Add remote syslog configuration
sonic-utilities	[syslog] Adjust runningconfiguration syslog command

linux-foundation-easycla · 2023-01-16T08:39:25Z

The committers listed above are authorized under a signed CLA.

✅ login: iavraham (ec526f5, ea826d9)

fastiuk · 2023-01-17T14:15:38Z

doc/syslog/syslog-design.md

+# 1. SONiC Syslog Source IP
+
+## 1.1. High Level Design document
+
+## 1.2. Table of contents
+
+- [1. SONiC Syslog Source IP](#1-sonic-syslog-source-ip)
+ - [1.1. High Level Design document](#11-high-level-design-document)
+ - [1.2. Table of contents](#12-table-of-contents)


We need to get rid of section numbers here and remove them from table of content.
You can use "" directive. See here

venkatmahalingam · 2023-01-17T16:37:17Z

doc/syslog/syslog-design.md

@@ -503,12 +758,14 @@ module sonic-syslog {

 leaf server_address {
 description "Syslog server IP address";


Suggest to update the description.
The server address represents either an IP address or a DNS domain name.

venkatmahalingam · 2023-01-17T16:38:49Z

doc/syslog/syslog-design.md

+
+ leaf format {
+ description "Log format";
+ type log-format;


Can we add a default 'standard' field?

zhangyanzhao · 2023-01-17T17:07:33Z

@dharmaraj-gurusamy wants to be the reviewer.

dharmaraj-gurusamy · 2023-01-20T05:50:09Z

doc/syslog/syslog-design.md

-| 0.1 | 18/04/2022 | Nazarii Hnydyn | Initial version |
-
-## About this manual
+# 1. SONiC Syslog Source IP


The original document has this as title & Introduction is marked as section 1. All section numbers seems incremented. Please correct the document headers.

dharmaraj-gurusamy · 2023-01-20T05:55:06Z

doc/syslog/syslog-design.md

+| Rev | Date | Author | Description |
+|:---:|:----------:|:--------------:|:----------------------|
+| 0.1 | 18/04/2022 | Nazarii Hnydyn | Initial version |
+| 0.2 | 08/01/2023 | Ido Avraham | extend capabilities |


Please add short note about the extended capabilities.

added detailed description

dharmaraj-gurusamy · 2023-01-20T06:06:40Z

doc/syslog/syslog-design.md

+| Parameter | Default | Description |
+|:-------------------|:---------|:------------------------------------------------------------------------------|
+| format | standard | template format |
+| trap | notice | messages with severity equal or grater then this severity will be forwarded |


severity will be a better name as trap may confuse with SNMP terminology. Please keep uniform name for both global & server specific configuration parameters.

we defined this name in our internal usage so we would prefer to leave it like that.
is it acceptable by you?

The man page (https://www.rsyslog.com/doc/v8-stable/configuration/filters.html) states priority / severity term. Hence, I would still recommend to rename either as severity / priority for better conveying the purpose.

doc/syslog/syslog-design.md

dharmaraj-gurusamy · 2023-01-20T06:11:33Z

doc/syslog/syslog-design.md

+| trap | priority | SYSLOG_CONFIG\|GLOBAL\|trap |
+| welf_firewall_name | trap | SYSLOG_CONFIG\|GLOBAL\|welf_firewall_name |
+
+* trap will set rules trap severity if not specified in the rule


Please share more details on this statement, preferably with an example.

dharmaraj-gurusamy · 2023-01-20T06:28:41Z

doc/syslog/syslog-design.md

@@ -444,7 +657,7 @@ config syslog add '2.2.2.2' \
 config syslog del '2.2.2.2'
 ```

-#### 2.6.2.2 Show command group
+#### 3.6.2.2. Show command group

 **The following command shows syslog server configuration:**


The extended parameters shall be displayed in show command output also for consistency.

dharmaraj-gurusamy · 2023-01-20T06:29:41Z

doc/syslog/syslog-design.md

+ or (/mvrf:sonic-mgmt_vrf/mvrf:MGMT_VRF_CONFIG/mvrf:vrf_global/mvrf:mgmtVrfEnabled = 'true')";
+ }
+
+ leaf filter {


filter_type will be the better name.

will change

dharmaraj-gurusamy · 2023-01-20T06:30:06Z

doc/syslog/syslog-design.md

+ type rsyslog-protocol;
+ }
+
+ leaf trap {


severity will be the better name.

answered above

dharmaraj-gurusamy · 2023-01-20T06:30:45Z

doc/syslog/syslog-design.md

+ }
+
+ leaf trap {
+ type rsyslog-severity;


Please add the default value.

dharmaraj-gurusamy · 2023-01-20T06:34:25Z

doc/syslog/syslog-design.md

+| device | none | Bind socket to given device (e.g., eth0/vrf0) |
+| ipfreebind | 2 | Manages the IP_FREEBIND option on the UDP socket |
+| filter | none | compares the log against the provided regular expression |
+| priority | notice | logs with specified priority and higher will be forwarded |


Will the default values be added in redis during upgrade scenarios (db_migrator script)? If not, we might end up in inconsistency after upgrade?

if the keys are empty we will use the global default value in the template

doc/syslog/syslog-design.md

dharmaraj-gurusamy · 2023-02-01T04:57:41Z

doc/syslog/syslog-design.md

+| Parameter | Default | Description |
+|:-------------------|:---------|:------------------------------------------------------------------------------|
+| format | standard | template format |
+| trap | notice | messages with severity equal or grater then this severity will be forwarded |


The man page (https://www.rsyslog.com/doc/v8-stable/configuration/filters.html) states priority / severity term. Hence, I would still recommend to rename either as severity / priority for better conveying the purpose.

iavraham · 2023-04-20T07:29:35Z

to merge the submodules, we first need to merge sonic-swss-common and then we can pass CI tests

SavchukRomanLv · 2023-05-11T12:54:33Z

@iavraham any time line when feature can be approved and merged? Thank you!

fastiuk · 2023-05-11T13:09:46Z

@iavraham any time line when feature can be approved and merged? Thank you!

We answered/closed all comments in this PR. Now we are waiting for maintainers to approve and merge it.

wen587 · 2023-05-15T10:11:39Z

Will review before 5/25

wen587 · 2023-05-22T02:16:12Z

doc/syslog/syslog-design.md


 Linux kernel decides which source IP to use within the default VRF.

 **Example:**
 ```
-*.* action(type="omfwd" target="2.2.2.2" protocol="udp")
+*.notice action(type="omfwd" target="2.2.2.2" protocol="udp")


Current 'show runningconfiguration syslog' is matching lines starting with '.'.
Will it break the show cli function? https://github.com/sonic-net/sonic-utilities/blob/master/show/main.py#L1687

Will it break the show cli function?

It will. I fixed it here: sonic-net/sonic-utilities#2843

iavraham changed the title ~~rsyslog hld update~~ Update RSyslog HLD with new functionality Jan 16, 2023

fastiuk mentioned this pull request Jan 16, 2023

rsyslog hld update iavraham/SONiC#1

Closed

fastiuk reviewed Jan 17, 2023

View reviewed changes

venkatmahalingam reviewed Jan 17, 2023

View reviewed changes

zhangyanzhao requested a review from lguohan January 17, 2023 17:04

dharmaraj-gurusamy suggested changes Jan 20, 2023

View reviewed changes

fastiuk assigned fastiuk and iavraham Jan 24, 2023

dharmaraj-gurusamy reviewed Feb 1, 2023

View reviewed changes

dharmaraj-gurusamy approved these changes Feb 2, 2023

View reviewed changes

qiluo-msft requested a review from wen587 May 13, 2023 00:47

wen587 reviewed May 22, 2023

View reviewed changes

fastiuk force-pushed the rsyslog_hld_update branch from 3b29864 to cd54a88 Compare May 23, 2023 20:00

fastiuk requested a review from wen587 May 24, 2023 07:21

wen587 approved these changes May 25, 2023

View reviewed changes

iavraham added 4 commits May 29, 2023 00:50

rsyslog hld update

3e50a3e

minor fixes after CR

2d70b56

Update HLD after review

bd7e768

change trap to severity

f96a9f1

fastiuk force-pushed the rsyslog_hld_update branch from e632798 to f96a9f1 Compare May 28, 2023 21:50

venkatmahalingam approved these changes May 30, 2023

View reviewed changes

qiluo-msft merged commit 4efe273 into sonic-net:master May 30, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update RSyslog HLD with new functionality #1218

Update RSyslog HLD with new functionality #1218

iavraham commented Jan 16, 2023 •

edited

Loading

linux-foundation-easycla bot commented Jan 16, 2023 •

edited

Loading

fastiuk Jan 17, 2023 •

edited

Loading

venkatmahalingam Jan 17, 2023

iavraham Jan 31, 2023

venkatmahalingam Jan 17, 2023 •

edited

Loading

iavraham Jan 31, 2023

zhangyanzhao commented Jan 17, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Feb 1, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Jan 20, 2023

iavraham Jan 31, 2023

dharmaraj-gurusamy Feb 1, 2023

iavraham commented Apr 20, 2023

SavchukRomanLv commented May 11, 2023

fastiuk commented May 11, 2023

wen587 commented May 15, 2023

wen587 May 22, 2023

fastiuk May 22, 2023

		@@ -503,12 +758,14 @@ module sonic-syslog {

		leaf server_address {
		description "Syslog server IP address";

Update RSyslog HLD with new functionality #1218

Update RSyslog HLD with new functionality #1218

Conversation

iavraham commented Jan 16, 2023 • edited Loading

linux-foundation-easycla bot commented Jan 16, 2023 • edited Loading

fastiuk Jan 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

venkatmahalingam Jan 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhangyanzhao commented Jan 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iavraham commented Apr 20, 2023

SavchukRomanLv commented May 11, 2023

fastiuk commented May 11, 2023

wen587 commented May 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iavraham commented Jan 16, 2023 •

edited

Loading

linux-foundation-easycla bot commented Jan 16, 2023 •

edited

Loading

fastiuk Jan 17, 2023 •

edited

Loading

venkatmahalingam Jan 17, 2023 •

edited

Loading