Skip to content

Commit a9fd2a7

Browse files
Junchao-MellanoxStormLiangMS
authored andcommitted
[Command Ref] Add doc for syslog rate limit (#2508)
- What I did Add command reference doc for syslog rate limit feature - How I did it Add command reference doc for syslog rate limit feature - How to verify it Manual check Previous command output (if the output of a command-line utility has changed) New command output (if the output of a command-line utility has changed) admin@sonic:~$ show syslog rate-limit-container SERVICE INTERVAL BURST -------------- ---------- ------- bgp 0 0 database 300 20000 lldp 300 20000 mgmt-framework 300 20000 pmon 300 20000 radv 300 20000 snmp 300 20000 swss 300 20000 syncd 300 20000 teamd 300 20000 telemetry 300 20000 admin@sonic:~$ show syslog rate-limit-container bgp SERVICE INTERVAL BURST -------------- ---------- ------- bgp 0 0
1 parent 80546ff commit a9fd2a7

File tree

1 file changed

+89
-3
lines changed

1 file changed

+89
-3
lines changed

doc/Command-Reference.md

+89-3
Original file line numberDiff line numberDiff line change
@@ -3357,7 +3357,7 @@ This command displays basic information about the gearbox phys configured on the
33573357
PHY Id Name Firmware
33583358
-------- ------- ----------
33593359
1 sesto-1 v0.1
3360-
3360+
33613361
```
33623362
33633363
Go Back To [Beginning of the document](#) or [Beginning of this section](#gearbox)
@@ -8702,7 +8702,7 @@ Go Back To [Beginning of the document](#) or [Beginning of this section](#subint
87028702
87038703
### Syslog Show Commands
87048704
8705-
This subsection explains how to display configured syslog servers.
8705+
This subsection explains how to display syslog related configuration.
87068706
87078707
**show syslog**
87088708
@@ -8721,9 +8721,58 @@ This command displays configured syslog servers.
87218721
2.2.2.2 1.1.1.1 514 default
87228722
```
87238723
8724+
**show syslog rate-limit-host**
8725+
8726+
This command displays rate limit configuration for host.
8727+
8728+
- Usage
8729+
```
8730+
show syslog rate-limit-host
8731+
```
8732+
8733+
- Example:
8734+
```
8735+
admin@sonic:~$ show syslog rate-limit-host
8736+
INTERVAL BURST
8737+
---------- --------
8738+
500 50000
8739+
```
8740+
8741+
**show syslog rate-limit-container**
8742+
8743+
This command displays rate limit configuration for containers.
8744+
8745+
- Usage
8746+
```
8747+
show syslog rate-limit-container [<service_name>]
8748+
```
8749+
8750+
- Example:
8751+
```
8752+
admin@sonic:~$ show syslog rate-limit-container
8753+
SERVICE INTERVAL BURST
8754+
-------------- ---------- -------
8755+
bgp 0 0
8756+
database 300 20000
8757+
lldp 300 20000
8758+
mgmt-framework 300 20000
8759+
pmon 300 20000
8760+
radv 300 20000
8761+
snmp 300 20000
8762+
swss 300 20000
8763+
syncd 300 20000
8764+
teamd 300 20000
8765+
telemetry 300 20000
8766+
8767+
admin@sonic:~$ show syslog rate-limit-container bgp
8768+
SERVICE INTERVAL BURST
8769+
-------------- ---------- -------
8770+
bgp 0 0
8771+
```
8772+
87248773
### Syslog Config Commands
87258774
8726-
This subsection explains how to configure syslog servers.
8775+
This subsection explains how to configure syslog.
87278776
87288777
**config syslog add**
87298778
@@ -8767,6 +8816,43 @@ This command is used to delete the configured syslog server.
87678816
Running command: systemctl restart rsyslog-config
87688817
```
87698818
8819+
**config syslog rate-limit-host**
8820+
8821+
This command is used to configure syslog rate limit for host.
8822+
8823+
- Usage:
8824+
```
8825+
config syslog rate-limit-host
8826+
```
8827+
8828+
- Parameters:
8829+
- _interval_: determines the amount of time that is being measured for rate limiting.
8830+
- _burst_: defines the amount of messages, that have to occur in the time limit of interval, to trigger rate limiting
8831+
8832+
- Example:
8833+
```
8834+
admin@sonic:~$ sudo config syslog rate-limit-host --interval 300 --burst 20000
8835+
```
8836+
8837+
**config syslog rate-limit-container**
8838+
8839+
This command is used to configure syslog rate limit for containers.
8840+
8841+
- Usage:
8842+
```
8843+
config syslog rate-limit-container <container-name>
8844+
```
8845+
8846+
- Parameters:
8847+
- _interval_: determines the amount of time that is being measured for rate limiting.
8848+
- _burst_: defines the amount of messages, that have to occur in the time limit of interval, to trigger rate limiting
8849+
8850+
- Example:
8851+
```
8852+
admin@sonic:~$ sudo config syslog rate-limit-container bgp --interval 300 --burst 20000
8853+
```
8854+
8855+
87708856
Go Back To [Beginning of the document](#) or [Beginning of this section](#syslog)
87718857
87728858
## System State

0 commit comments

Comments
 (0)