Skip to content

Commit f614803

Browse files
authored
[Auto Techsupport] Added Event Driven TS to Command Reference (sonic-net#1985)
Added the Event Driven Tech Support related information to the Command Reference Guide. HLD
1 parent d9f3afe commit f614803

File tree

1 file changed

+172
-1
lines changed

1 file changed

+172
-1
lines changed

doc/Command-Reference.md

Lines changed: 172 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@
172172
* [SONiC Installer](#sonic-installer)
173173
* [Troubleshooting Commands](#troubleshooting-commands)
174174
* [Debug Dumps](#debug-dumps)
175+
* [Event Driven Techsupport Invocation](#event-driven-techsupport-invocation)
175176
* [Routing Stack](#routing-stack)
176177
* [Quagga BGP Show Commands](#Quagga-BGP-Show-Commands)
177178
* [ZTP Configuration And Show Commands](#ztp-configuration-and-show-commands)
@@ -10084,8 +10085,178 @@ In SONiC, there usually exists a set of tables related/relevant to a particular
1008410085
}
1008510086
}
1008610087
```
10087-
10088+
10089+
### Event Driven Techsupport Invocation
10090+
10091+
This feature/capability makes the techsupport invocation event-driven based on core dump generation. This feature is only applicable for the processes running in the containers. More detailed explanation can be found in the HLD https://github.com/Azure/SONiC/blob/master/doc/auto_techsupport_and_coredump_mgmt.md
10092+
10093+
#### config auto-techsupport global commands
10094+
10095+
**config auto-techsupport global state**
10096+
10097+
- Usage:
10098+
```
10099+
config auto-techsupport global state <enabled/disabled>
10100+
```
10101+
10102+
- Example:
10103+
```
10104+
config auto-techsupport global state enabled
10105+
```
10106+
10107+
**config auto-techsupport global rate-limit-interval <uint16>**
10108+
10109+
- Usage:
10110+
```
10111+
config auto-techsupport global rate-limit-interval <uint16>
10112+
```
10113+
- Parameters:
10114+
- rate-limit-interval: Minimum time in seconds to wait after the last techsupport creation time before invoking a new one.
10115+
10116+
- Example:
10117+
```
10118+
config auto-techsupport global rate-limit-interval 200
10119+
```
10120+
10121+
**config auto-techsupport global max-techsupport-limit <float upto two decimal places>**
10122+
10123+
- Usage:
10124+
```
10125+
config auto-techsupport global max-techsupport-limit <float upto two decimal places>
10126+
```
10127+
- Parameters:
10128+
- max-techsupport-limit: A percentage value should be specified. This signifies maximum size to which /var/dump/ directory can be grown until.
10129+
10130+
- Example:
10131+
```
10132+
config auto-techsupport global max-techsupport-limit 10.15
10133+
```
10134+
10135+
**config auto-techsupport global max-core-limit <float upto two decimal places>**
10136+
10137+
- Usage:
10138+
```
10139+
config auto-techsupport global max-core-limit <float upto two decimal places>
10140+
```
10141+
- Parameters:
10142+
- max-core-limit: A percentage value should be specified. This signifies maximum size to which /var/core/ directory can be grown until.
10143+
10144+
- Example:
10145+
```
10146+
config auto-techsupport global max-core-limit 10.15
10147+
```
10148+
10149+
**config auto-techsupport global since**
10150+
10151+
- Usage:
10152+
```
10153+
config auto-techsupport global since <string>
10154+
```
10155+
- Parameters:
10156+
- since: This limits the auto-invoked techsupport to only collect the logs & core-dumps generated since the time provided. Any valid date string of the formats specified here can be used. (https://www.gnu.org/software/coreutils/manual/html_node/Date-input-formats.html). If this value is not explicitly configured or a non-valid string is provided, a default value of "2 days ago" is used.
10157+
10158+
- Example:
10159+
```
10160+
config auto-techsupport global since <string>
10161+
```
10162+
10163+
10164+
#### config auto-techsupport-feature commands
10165+
10166+
**config auto-techsupport-feature add**
1008810167
10168+
- Usage:
10169+
```
10170+
config auto-techsupport-feature add <feature_name> --state <enabled/disabled> --rate-limit-interval <uint16>
10171+
```
10172+
- Parameters:
10173+
- state: enable/disable the capability for the specific feature/container.
10174+
- rate-limit-interval: Rate limit interval for the corresponding feature. Configure 0 to explicitly disable. For the techsupport to be generated by auto-techsupport, both the global and feature specific rate-limit-interval has to be passed
10175+
10176+
- Example:
10177+
```
10178+
config auto-techsupport-feature add bgp --state enabled --rate-limit-interval 200
10179+
```
10180+
10181+
10182+
**config auto-techsupport-feature delete**
10183+
10184+
- Usage:
10185+
```
10186+
config auto-techsupport-feature delete <feature_name>
10187+
```
10188+
10189+
- Example:
10190+
```
10191+
config auto-techsupport-feature delete swss
10192+
```
10193+
10194+
**config auto-techsupport-feature update**
10195+
10196+
- Usage:
10197+
```
10198+
config auto-techsupport-feature update <feature_name> --state <enabled/disabled>
10199+
config auto-techsupport-feature update <feature_name> --rate-limit-interval <uint16>
10200+
```
10201+
10202+
- Example:
10203+
```
10204+
config auto-techsupport-feature update snmp --state enabled
10205+
config auto-techsupport-feature update swss --rate-limit-interval 200
10206+
```
10207+
10208+
#### Show CLI:
10209+
10210+
**show auto-techsupport global**
10211+
10212+
- Usage:
10213+
```
10214+
show auto-techsupport global
10215+
```
10216+
10217+
- Example:
10218+
```
10219+
admin@sonic:~$ show auto-techsupport global
10220+
STATE RATE LIMIT INTERVAL (sec) MAX TECHSUPPORT LIMIT (%) MAX CORE LIMIT (%) SINCE
10221+
------- --------------------------- -------------------------- ------------------ ----------
10222+
enabled 180 10.0 5.0 2 days ago
10223+
```
10224+
10225+
**show auto-techsupport-feature**
10226+
10227+
- Usage:
10228+
```
10229+
show auto-techsupport-feature
10230+
```
10231+
10232+
- Example:
10233+
```
10234+
admin@sonic:~$ show auto-techsupport-feature
10235+
FEATURE NAME STATE RATE LIMIT INTERVAL (sec)
10236+
-------------- -------- --------------------------
10237+
bgp enabled 600
10238+
database enabled 600
10239+
dhcp_relay enabled 600
10240+
lldp enabled 600
10241+
swss disabled 800
10242+
```
10243+
10244+
**show auto-techsupport history**
10245+
10246+
- Usage:
10247+
```
10248+
show auto-techsupport history
10249+
```
10250+
10251+
- Example:
10252+
```
10253+
admin@sonic:~$ show auto-techsupport history
10254+
TECHSUPPORT DUMP TRIGGERED BY CORE DUMP
10255+
---------------------------------------- -------------- -----------------------------
10256+
sonic_dump_r-lionfish-16_20210901_221402 bgp bgpcfgd.1630534439.55.core.gz
10257+
sonic_dump_r-lionfish-16_20210901_203725 snmp python3.1630528642.23.core.gz
10258+
sonic_dump_r-lionfish-16_20210901_222408 teamd python3.1630535045.34.core.gz
10259+
```
1008910260
1009010261
Go Back To [Beginning of the document](#) or [Beginning of this section](#troubleshooting-commands)
1009110262

0 commit comments

Comments
 (0)