Add remote syslog configuration #14513

iavraham · 2023-04-04T09:06:36Z

Add an ability to configure remote syslog servers
Add an initial configuration for remote syslog
Extend YANG module and add unit tests

Why I did it

Adding the following functionality to rsyslog feature:

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

How I did it

added parameters to syslog server and global configuration.

How to verify it

create syslog server using CLI/adding to Redis-DB
verify server is added to file /etc/rsyslog.conf and server is functional.

Description for the changelog

extend rsyslog capabilities, added server and global configuration parameters.

Link to config_db schema for YANG module changes

https://github.com/iavraham/sonic-buildimage/blob/master/src/sonic-yang-models/yang-models/sonic-syslog.yang

src/sonic-yang-models/tests/yang_model_tests/tests_config/syslog.json

qiluo-msft · 2023-05-13T00:51:16Z

files/image_config/rsyslog/rsyslog-config.sh

@@ -17,7 +17,10 @@ if [[ ($NUM_ASIC -gt 1) ]]; then
 else
 udp_server_ip=$(ip -j -4 addr list lo scope host | jq -r -M '.[0].addr_info[0].local')
 fi
+hostname=$(hostname)


hostname

There is DEVICE_METADATA/hostname in ConfigDB. Could you check which one is better? #Closed

it is better to take from linux than DEVICE_METADATA/hostname.
example: DB can be empty if not configured with CLI. hostname can also be dynamically assigned using DHCP.

If DEVICE_METADATA/hostname has value, it should be preferred.

The hostname can be dynamically assigned by DHCP, in that case, DB value may contain the wrong hostname.
Plus DEVICE_METADATA is a configuration and not a STATE, once data is placed to DEVICE_METADATA it will update the system hostname according to https://github.com/sonic-net/sonic-host-services/blob/bc08806b64002c506b8401eae5d9e1c760651e49/scripts/hostcfgd#L1568
So in my opinion it is better to take it from the hostname utility as the most appropriate one.

dgsudharsan · 2023-05-17T20:56:10Z

@iavraham Can you please update configuration.md to reflect the new schema changes?

fastiuk · 2023-05-23T20:01:15Z

@iavraham Can you please update configuration.md to reflect the new schema changes?

done

dgsudharsan · 2023-05-24T21:48:03Z

src/sonic-yang-models/tests/yang_model_tests/tests_config/syslog.json

@@ -136,17 +136,6 @@
 }
 }
 },
- "SYSLOG_SERVER_INVALID_IPADDR_TEST" : {


Why is this test removed? Is it because syslog server can be a string and hence IP validation cannot be done?

dgsudharsan · 2023-05-24T23:09:15Z

files/image_config/rsyslog/rsyslog.conf.j2

+{% set regex = conf.get('filter_regex') -%}
+
+{% set fmodifier = '!' if filter == 'exclude' else '' %}
+{% set device = 'mgmt' if vrf in ['mgmt', 'management'] else 'eth0' %}


This assumes that syslog server is reachable only through mgmt network or eth0. What if the server is reachable through the data network or OOB mgmt port?

oh, yes. I missed the address as well. I will fix it.
Good catch!

fastiuk · 2023-05-30T20:24:41Z

/azp run

azure-pipelines · 2023-05-30T20:24:46Z

Commenter does not have sufficient privileges for PR 14513 in repo sonic-net/sonic-buildimage

files/build_templates/init_cfg.json.j2

### Description of PR Summary: Fixes test fail in sonic-net/sonic-buildimage#14513 ### Approach #### What is the motivation for this PR? Align the test according to the new rsyslog server type. Originally only IPv4 and IPv6 addresses were supported. Now hostames are supported as well #### How did you do it? Update the generic updater test to follow new schema #### How did you verify/test it? Run it on t1 setup

fastiuk · 2023-07-03T11:27:07Z

@qiluo-msft all comments addressed. Please take a look and if everything looks good to you, please merge that PR

wen587

LGTM

* Add an ability to configure remote syslog servers * Add an initial configuration for remote syslog * Extend YANG module and add unit tests Signed-off-by: Yevhen Fastiuk <yfastiuk@nvidia.com>

Signed-off-by: Yevhen Fastiuk <yfastiuk@nvidia.com>

fastiuk · 2023-07-04T20:22:49Z

@qiluo-msft updated according to the last comment. Could you please take a look?

dgsudharsan · 2023-07-06T17:26:36Z

@qiluo-msft Can you please review and signoff?

Signed-off-by: Yevhen Fastiuk <yfastiuk@nvidia.com>

) cherry-pick: #14513 depends: sonic-net/sonic-utilities#2939 * Add an ability to configure remote syslog servers * Add an initial configuration for remote syslog * Extend YANG module and add unit tests #### Why I did it Adding the following functionality to rsyslog feature: * Configure remote syslog servers: protocol, filter, severity level * Update global syslog configuration: severity level, message format #### How I did it added parameters to syslog server and global configuration. #### How to verify it create syslog server using CLI/adding to Redis-DB verify server is added to file /etc/rsyslog.conf and server is functional. #### Description for the changelog extend rsyslog capabilities, added server and global configuration parameters. #### Link to config_db schema for YANG module changes [sonic-syslog.yang](https://github.com/sonic-net/sonic-buildimage/blob/master/src/sonic-yang-models/yang-models/sonic-syslog.yang)

* Add an ability to configure remote syslog servers * Add an initial configuration for remote syslog * Extend YANG module and add unit tests #### Why I did it Adding the following functionality to rsyslog feature: - Configure remote syslog servers: protocol, filter, severity level - Update global syslog configuration: severity level, message format #### How I did it added parameters to syslog server and global configuration. #### How to verify it create syslog server using CLI/adding to Redis-DB verify server is added to file /etc/rsyslog.conf and server is functional. #### Description for the changelog extend rsyslog capabilities, added server and global configuration parameters. #### Link to config_db schema for YANG module changes https://github.com/iavraham/sonic-buildimage/blob/master/src/sonic-yang-models/yang-models/sonic-syslog.yang

…-net#8668) ### Description of PR Summary: Fixes test fail in sonic-net/sonic-buildimage#14513 ### Approach #### What is the motivation for this PR? Align the test according to the new rsyslog server type. Originally only IPv4 and IPv6 addresses were supported. Now hostames are supported as well #### How did you do it? Update the generic updater test to follow new schema #### How did you verify/test it? Run it on t1 setup

qiluo-msft · 2024-07-23T21:04:58Z

Hard coded eth0 is fixed in a future #17616

iavraham requested review from qiluo-msft and lguohan as code owners April 4, 2023 09:06

iavraham force-pushed the rsyslog-merge branch from a7b73fa to 844e079 Compare April 10, 2023 09:36

dgsudharsan suggested changes Apr 14, 2023

View reviewed changes

src/sonic-yang-models/tests/yang_model_tests/tests_config/syslog.json Show resolved Hide resolved

fastiuk closed this Apr 14, 2023

fastiuk reopened this Apr 14, 2023

iavraham mentioned this pull request Apr 19, 2023

Update RSyslog HLD with new functionality sonic-net/SONiC#1218

Merged

iavraham closed this May 8, 2023

iavraham reopened this May 8, 2023

qiluo-msft reviewed May 13, 2023

View reviewed changes

qiluo-msft requested review from wen587 and qiluo-msft May 15, 2023 07:07

iavraham force-pushed the rsyslog-merge branch 2 times, most recently from c3e5cbc to d2a0298 Compare May 17, 2023 15:11

fastiuk closed this May 22, 2023

fastiuk reopened this May 22, 2023

fastiuk self-assigned this May 22, 2023

fastiuk force-pushed the rsyslog-merge branch 2 times, most recently from 0cb8f8f to 062545d Compare May 23, 2023 19:58

dgsudharsan reviewed May 24, 2023

View reviewed changes

dgsudharsan approved these changes May 24, 2023

View reviewed changes

dgsudharsan suggested changes May 24, 2023

View reviewed changes

fastiuk force-pushed the rsyslog-merge branch 2 times, most recently from f5ed003 to b6d90a3 Compare May 26, 2023 18:51

fastiuk closed this May 28, 2023

fastiuk reopened this May 28, 2023

qiluo-msft requested a review from ganglyu June 29, 2023 18:32

qiluo-msft reviewed Jun 29, 2023

View reviewed changes

files/build_templates/init_cfg.json.j2 Outdated Show resolved Hide resolved

fastiuk closed this Jun 29, 2023

fastiuk reopened this Jun 29, 2023

fastiuk closed this Jun 30, 2023

fastiuk reopened this Jun 30, 2023

wen587 approved these changes Jul 3, 2023

View reviewed changes

fastiuk added 3 commits July 4, 2023 18:48

Add remote syslog configuration

2e43092

* Add an ability to configure remote syslog servers * Add an initial configuration for remote syslog * Extend YANG module and add unit tests Signed-off-by: Yevhen Fastiuk <yfastiuk@nvidia.com>

Doc: update configuration reference

e2ebb72

Signed-off-by: Yevhen Fastiuk <yfastiuk@nvidia.com>

Update sonic-utilities submodule

0d7bb0d

Signed-off-by: Yevhen Fastiuk <yfastiuk@nvidia.com>

fastiuk force-pushed the rsyslog-merge branch from c4c77a1 to 0d7bb0d Compare July 4, 2023 15:48

YANG: Add defaults for new syslog GLOBAL parameters

df9d120

fastiuk added 2 commits July 5, 2023 21:44

Merge branch 'master' into rsyslog-merge

5dd69f8

Merge branch 'master' into rsyslog-merge

b46bd00

fastiuk added 2 commits July 10, 2023 12:16

RSyslog: Move defaults to Jinja2 template

cd0f659

Signed-off-by: Yevhen Fastiuk <yfastiuk@nvidia.com>

Merge remote-tracking branch 'upstream/master' into rsyslog-merge

4091c1c

dgsudharsan requested a review from qiluo-msft July 10, 2023 17:52

qiluo-msft approved these changes Jul 10, 2023

View reviewed changes

qiluo-msft merged commit 72021fd into sonic-net:master Jul 10, 2023
16 checks passed

fastiuk mentioned this pull request Jul 18, 2023

[syslog] Add remote syslog configuration (cherry-pick to 202305) #15897

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add remote syslog configuration #14513

Add remote syslog configuration #14513

iavraham commented Apr 4, 2023

qiluo-msft May 13, 2023 •

edited

Loading

iavraham May 16, 2023

qiluo-msft Jun 29, 2023

fastiuk Jun 29, 2023

dgsudharsan commented May 17, 2023

fastiuk commented May 23, 2023

dgsudharsan May 24, 2023

fastiuk May 26, 2023

dgsudharsan May 24, 2023

fastiuk May 25, 2023

fastiuk May 26, 2023

fastiuk commented May 30, 2023

azure-pipelines bot commented May 30, 2023

fastiuk commented Jul 3, 2023

wen587 left a comment

fastiuk commented Jul 4, 2023

dgsudharsan commented Jul 6, 2023

qiluo-msft commented Jul 23, 2024

Add remote syslog configuration #14513

Add remote syslog configuration #14513

Conversation

iavraham commented Apr 4, 2023

Why I did it

How I did it

How to verify it

Description for the changelog

Link to config_db schema for YANG module changes

qiluo-msft May 13, 2023 • edited Loading

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

dgsudharsan commented May 17, 2023

fastiuk commented May 23, 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

fastiuk commented May 30, 2023

azure-pipelines bot commented May 30, 2023

fastiuk commented Jul 3, 2023

wen587 left a comment

Choose a reason for hiding this comment

fastiuk commented Jul 4, 2023

dgsudharsan commented Jul 6, 2023

qiluo-msft commented Jul 23, 2024

qiluo-msft May 13, 2023 •

edited

Loading