Enable runtime config log level #19611
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
prgeor
reviewed
Jul 26, 2024
prgeor
reviewed
Jul 26, 2024
xincunli-sonic
suggested changes
Jul 30, 2024
keboliu
approved these changes
Aug 5, 2024
|
Hi @xincunli-sonic , we had a offline discussion about the multi asic issue. I have already updated the CLI to handle multi ASIC configuration, that part is not in this PR. Could you please review and sign off this one? |
|
/azpw run ms_checker |
|
/AzurePipelines run ms_checker |
|
No pipelines are associated with this pull request. |
|
/azpw ms_conflict -f |
Junchao-Mellanox
force-pushed
the
master-runtime-log-config
branch
from
3f0f5b9 to
d81abd5
Compare
|
/azpw run Azure.sonic-buildimage |
|
/AzurePipelines run Azure.sonic-buildimage |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@Junchao-Mellanox can you point to the HLD link in the PR description? |
prgeor
reviewed
Aug 26, 2024
Added |
|
/azpw run Azure.sonic-buildimage |
|
/AzurePipelines run Azure.sonic-buildimage |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azpw run Azure.sonic-buildimage |
|
/AzurePipelines run Azure.sonic-buildimage |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azpw run Azure.sonic-buildimage |
|
/AzurePipelines run Azure.sonic-buildimage |
|
Azure Pipelines successfully started running 1 pipeline(s). |
prgeor
reviewed
Sep 6, 2024
prgeor
approved these changes
Sep 16, 2024
|
Hi @liat-grozovik , could you please help merge? |
|
Hi @qiluo-msft , could you please help merge this PR? All reviewers have approved the PR. |
rkavitha-hcl
pushed a commit
to rkavitha-hcl/sonic-buildimage
that referenced
this pull request
Nov 15, 2024
HLD link: sonic-net/SONiC#1522 - Why I did it SONiC provides two Python logger implementations: sonic_py_common.logger.Logger and sonic_py_common.syslogger.SysLogger. Both of them do not provide the ability to change log level at real time. Sometimes, in order to get more debug information, developer has to manually change the log level in code on a running switch and restart the Python daemon. This is not convenient. SONiC also provides a C/C++ logger implementation in sonic-platform-common.common.logger.cpp. This C/C++ logger implementation is also a wrapper of Linux standard syslog which is widely used by swss/syncd. It provides the ability to set log level on fly by starting a thread to listen to CONFIG DB LOGGER table change. SONiC infrastructure also provides the Python wrapper for sonic-platform-common.common.logger.cpp which is swsscommon.Logger. However, this logger implementation also has some drawbacks: swsscommon.Logger assumes redis DB is ready to connect. This is a valid assumption for swss/syncd. But it is not good for a Python logger implementation because some Python script may be called before redis server starting. swsscommon.Logger wraps Linux syslog which only support single log identifier for a daemon. So, swsscommon.Logger is not an option too. This PR is a Python logger enhancement which allows user setting log level at run time. - How I did it swsscommon.Logger depends on a thread to listen to CONFIG DB LOGGER table change. It refreshes log level for each logger instances once the thread detects a DB entry change. A thread is considered heavy in a python script, especially that there are many short and simple python scripts which also use logger. To keep python logger light weight, it uses a different design than swsscommon.Logger: A class level logger registry shall be added to SysLoggerclass Each logger instance shall register itself to logger register if enables runtime configuration Logger configuration shall be refreshed by CLI which send a SIGHUP signal to the daemon - How to verify it Manual test New unit test cases
aidan-gallagher
pushed a commit
to aidan-gallagher/sonic-buildimage
that referenced
this pull request
Nov 16, 2024
HLD link: sonic-net/SONiC#1522 - Why I did it SONiC provides two Python logger implementations: sonic_py_common.logger.Logger and sonic_py_common.syslogger.SysLogger. Both of them do not provide the ability to change log level at real time. Sometimes, in order to get more debug information, developer has to manually change the log level in code on a running switch and restart the Python daemon. This is not convenient. SONiC also provides a C/C++ logger implementation in sonic-platform-common.common.logger.cpp. This C/C++ logger implementation is also a wrapper of Linux standard syslog which is widely used by swss/syncd. It provides the ability to set log level on fly by starting a thread to listen to CONFIG DB LOGGER table change. SONiC infrastructure also provides the Python wrapper for sonic-platform-common.common.logger.cpp which is swsscommon.Logger. However, this logger implementation also has some drawbacks: swsscommon.Logger assumes redis DB is ready to connect. This is a valid assumption for swss/syncd. But it is not good for a Python logger implementation because some Python script may be called before redis server starting. swsscommon.Logger wraps Linux syslog which only support single log identifier for a daemon. So, swsscommon.Logger is not an option too. This PR is a Python logger enhancement which allows user setting log level at run time. - How I did it swsscommon.Logger depends on a thread to listen to CONFIG DB LOGGER table change. It refreshes log level for each logger instances once the thread detects a DB entry change. A thread is considered heavy in a python script, especially that there are many short and simple python scripts which also use logger. To keep python logger light weight, it uses a different design than swsscommon.Logger: A class level logger registry shall be added to SysLoggerclass Each logger instance shall register itself to logger register if enables runtime configuration Logger configuration shall be refreshed by CLI which send a SIGHUP signal to the daemon - How to verify it Manual test New unit test cases
bradh352
added a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Nov 29, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
9 tasks
bradh352
added a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Nov 29, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
bradh352
added a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 1, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
github-actions bot
pushed a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 1, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
bradh352
added a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 1, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
github-actions bot
pushed a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 3, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
github-actions bot
pushed a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 3, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
github-actions bot
pushed a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 4, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
github-actions bot
pushed a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 4, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
github-actions bot
pushed a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 5, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
github-actions bot
pushed a commit
to bradh352/sonic-buildimage
that referenced
this pull request
Dec 6, 2024
As of sonic-net#19611 and sonic-net/sonic-utilities#3428 a new database field of `require_manual_refresh` was added. This leads to YANG failures in the factory-default configuration for the `xcvrd` log entry which by default is written as true. Signed-off-by: Brad House (@bradh352)
StormLiangMS
pushed a commit
that referenced
this pull request
Dec 6, 2024
Why I did it YANG failures during config replace with default configuration. As of #19611 and sonic-net/sonic-utilities#3428 a new database field of require_manual_refresh was added. This leads to YANG failures in the factory-default configuration for the xcvrd log entry which by default is written as true. Work item tracking How I did it Updated YANG file for new field. How to verify it Verify config replace works with factory default configuration.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
HLD link: sonic-net/SONiC#1522
Why I did it
SONiC provides two Python logger implementations:
sonic_py_common.logger.Loggerandsonic_py_common.syslogger.SysLogger. Both of them do not provide the ability to change log level at real time. Sometimes, in order to get more debug information, developer has to manually change the log level in code on a running switch and restart the Python daemon. This is not convenient.SONiC also provides a C/C++ logger implementation in
sonic-platform-common.common.logger.cpp. This C/C++ logger implementation is also a wrapper of Linux standardsyslogwhich is widely used by swss/syncd. It provides the ability to set log level on fly by starting a thread to listen to CONFIG DB LOGGER table change. SONiC infrastructure also provides the Python wrapper forsonic-platform-common.common.logger.cppwhich isswsscommon.Logger. However, this logger implementation also has some drawbacks:swsscommon.Loggerassumes redis DB is ready to connect. This is a valid assumption for swss/syncd. But it is not good for a Python logger implementation because some Python script may be called before redis server starting.swsscommon.Loggerwraps Linux syslog which only support single log identifier for a daemon.So,
swsscommon.Loggeris not an option too.This PR is a Python logger enhancement which allows user setting log level at run time.
Work item tracking
How I did it
swsscommon.Loggerdepends on a thread to listen to CONFIG DB LOGGER table change. It refreshes log level for each logger instances once the thread detects a DB entry change. A thread is considered heavy in a python script, especially that there are many short and simple python scripts which also use logger. To keep python logger light weight, it uses a different design thanswsscommon.Logger:SysLoggerclassHow to verify it
Manual test
New unit test cases
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)