Skip to content

Update RSyslog HLD with new functionality#1218

Merged
qiluo-msft merged 4 commits intosonic-net:masterfrom
iavraham:rsyslog_hld_update
May 30, 2023
Merged

Update RSyslog HLD with new functionality#1218
qiluo-msft merged 4 commits intosonic-net:masterfrom
iavraham:rsyslog_hld_update

Conversation

@iavraham
Copy link
Contributor

@iavraham iavraham commented Jan 16, 2023

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 GitHub issue/pull request detail
sonic-host-services [rsyslog]Add remote syslog configuration GitHub issue/pull request detail
sonic-buildimage [rsyslog]Add remote syslog configuration GitHub issue/pull request detail
sonic-utilities [syslog] Adjust runningconfiguration syslog command GitHub issue/pull request detail

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jan 16, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: iavraham (ec526f5, ea826d9f9937173f6698b2df29356f614bd0a0c0)

@iavraham iavraham changed the title rsyslog hld update Update RSyslog HLD with new functionality Jan 16, 2023
Comment on lines 1 to 9
Copy link
Contributor

@fastiuk fastiuk Jan 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to get rid of section numbers here and remove them from table of content.
You can use "<!-- omit in toc -->" directive. See here

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Collaborator

@venkatmahalingam venkatmahalingam Jan 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a default 'standard' field?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

@zhangyanzhao zhangyanzhao requested a review from lguohan January 17, 2023 17:04
@zhangyanzhao
Copy link
Collaborator

@dharmaraj-gurusamy wants to be the reviewer.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add short note about the extended capabilities.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added detailed description

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

filter_type will be the better name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will change

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

severity will be the better name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

answered above

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the default value.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor Author

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

@SavchukRomanLv
Copy link

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

@fastiuk
Copy link
Contributor

fastiuk commented May 11, 2023

@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.

@qiluo-msft qiluo-msft requested a review from wen587 May 13, 2023 00:47
@wen587
Copy link
Contributor

wen587 commented May 15, 2023

Will review before 5/25

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will it break the show cli function?

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

@fastiuk fastiuk force-pushed the rsyslog_hld_update branch from 3b29864 to cd54a88 Compare May 23, 2023 20:00
@fastiuk fastiuk requested a review from wen587 May 24, 2023 07:21
@fastiuk fastiuk force-pushed the rsyslog_hld_update branch from e632798 to f96a9f1 Compare May 28, 2023 21:50
@qiluo-msft qiluo-msft merged commit 4efe273 into sonic-net:master May 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants