Skip to content

Commit d463f0e

Browse files
committed
Update PR sonic-net#70 with DPB translation disclaimer.
1 parent 2cd2a27 commit d463f0e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

system/syslog-msg-intf-name-xlate-HLD.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Syslog Message Interface Name Translation
55

66
# High Level Design Document
77

8-
#### Rev 0.6
8+
#### Rev 0.7
99

1010
# Table of Contents
1111

@@ -33,6 +33,7 @@ Syslog Message Interface Name Translation
3333
| 0.4 | 07/23/2020 | Greg Paussa | Do not rely on PORT table for base port alias names. |
3434
| 0.5 | 08/03/2020 | Greg Paussa | Handle non-base breakout port alias name variations. Special-case master port references in log messages. |
3535
| 0.6 | 08/12/2020 | Greg Paussa | Use STATE_DB update to indicate DPB change instead of CONFIG_DB. |
36+
| 0.7 | 08/24/2020 | Greg Paussa | Added disclaimer for DPB log message translations in Section 1.1. |
3637

3738
# About this Manual
3839

@@ -113,6 +114,8 @@ A high-level view of the operation:
113114
7. The rsyslog service cannot infer or otherwise determine the semantic intent of an interface name that appears in a syslog message.
114115
- The rsyslog daemon performs a literal substitution of the standard alias for its native name while configured for standard interface naming mode, regardless of where it appears in the syslog message.
115116
- Rsyslog is not aware of the context of the message sender, for example, whether it originated a message before or after processing DPB-related port events that modify a standard alias name.
117+
- **Interface name translation in some DPB event logs may not be accurate in the context of the event, or may not get translated.**
118+
- Such log messages should be fixed at the source (back-end).
116119

117120
8. It is SUGGESTED to also translate non-SONiC native names in syslog messages, such as Linux device names "eth1" into standard naming convention as well.
118121
- Only if it makes sense to do so and does not put undue burden on rsyslog.

0 commit comments

Comments
 (0)