Skip to content

Commit 6bef652

Browse files
[doc] add documentation on automatic techsupport based on memory (#2411)
- What I did Added documentation on automatic techsupport based on memory availability - How I did it Update documentation Signed-off-by: Stepan Blyschak <[email protected]>
1 parent 4a78374 commit 6bef652

File tree

1 file changed

+51
-18
lines changed

1 file changed

+51
-18
lines changed

doc/Command-Reference.md

+51-18
Original file line numberDiff line numberDiff line change
@@ -10487,7 +10487,8 @@ In SONiC, there usually exists a set of tables related/relevant to a particular
1048710487
1048810488
### Event Driven Techsupport Invocation
1048910489
10490-
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
10490+
This feature/capability makes the techsupport invocation event-driven based on system events like core dump generation or low RAM availability.
10491+
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
1049110492
1049210493
#### config auto-techsupport global commands
1049310494
@@ -10559,22 +10560,52 @@ This feature/capability makes the techsupport invocation event-driven based on c
1055910560
config auto-techsupport global since <string>
1056010561
```
1056110562
10563+
**config auto-techsupport global available-mem-threshold**
10564+
10565+
Configure available memory threshold in %. System will automatically generate a techsupport dump when available memory goes below the configured threshold. Setting this field to 0 will disable techsupport invokation.
10566+
10567+
- Usage:
10568+
```
10569+
config auto-techsupport global available-mem-threshold <float up to two decimal places>
10570+
```
10571+
- Parameters:
10572+
- available-mem-threshold: Memory threshold. Configure 0 to disable techsupport invocation on memory usage threshold crossing
10573+
- Example:
10574+
```
10575+
config auto-techsupport global available-mem-threshold 20
10576+
```
10577+
10578+
**config auto-techsupport global min-available-mem**
10579+
10580+
Configure minimum available memory in MB. System will automatically generate a techsupport dump when available memory goes below the configured threshold.
10581+
10582+
- Usage:
10583+
```
10584+
config auto-techsupport global min-available-mem <uint32>
10585+
```
10586+
- Parameters:
10587+
- min-available-mem: Minimum free memory amount in MB to trigger techsupport dump
10588+
- Example:
10589+
```
10590+
config auto-techsupport global min-available-mem 200
10591+
```
1056210592
1056310593
#### config auto-techsupport-feature commands
1056410594
1056510595
**config auto-techsupport-feature add**
1056610596
1056710597
- Usage:
1056810598
```
10569-
config auto-techsupport-feature add <feature_name> --state <enabled/disabled> --rate-limit-interval <uint16>
10599+
config auto-techsupport-feature add <feature_name> --state <enabled/disabled> --rate-limit-interval <uint16> --available-mem-threshold <float up to two decimal places>
1057010600
```
1057110601
- Parameters:
1057210602
- state: enable/disable the capability for the specific feature/container.
1057310603
- 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
10604+
- available-mem-threshold: Memory threshold. Configure 0 to disable techsupport invocation on memory usage threshold crossing.
1057410605
1057510606
- Example:
1057610607
```
10577-
config auto-techsupport-feature add bgp --state enabled --rate-limit-interval 200
10608+
config auto-techsupport-feature add bgp --state enabled --rate-limit-interval 200 --available-mem-threshold 50
1057810609
```
1057910610
1058010611
@@ -10596,6 +10627,7 @@ This feature/capability makes the techsupport invocation event-driven based on c
1059610627
```
1059710628
config auto-techsupport-feature update <feature_name> --state <enabled/disabled>
1059810629
config auto-techsupport-feature update <feature_name> --rate-limit-interval <uint16>
10630+
config auto-techsupport-feature update <feature_name> --available-mem-threshold <float up to two decimal places>
1059910631
```
1060010632
1060110633
- Example:
@@ -10616,9 +10648,9 @@ This feature/capability makes the techsupport invocation event-driven based on c
1061610648
- Example:
1061710649
```
1061810650
admin@sonic:~$ show auto-techsupport global
10619-
STATE RATE LIMIT INTERVAL (sec) MAX TECHSUPPORT LIMIT (%) MAX CORE LIMIT (%) SINCE
10620-
------- --------------------------- -------------------------- ------------------ ----------
10621-
enabled 180 10.0 5.0 2 days ago
10651+
STATE RATE LIMIT INTERVAL (sec) MAX TECHSUPPORT LIMIT (%) MAX CORE LIMIT (%) AVAILABLE MEM THRESHOLD (%) MIN AVAILABLE MEM (Kb) SINCE
10652+
------- --------------------------- --------------------------- -------------------- ----------------------------- ------------------------ ------------
10653+
enabled 180 10 5 10 200 2 days ago
1062210654
```
1062310655
1062410656
**show auto-techsupport-feature**
@@ -10631,13 +10663,13 @@ This feature/capability makes the techsupport invocation event-driven based on c
1063110663
- Example:
1063210664
```
1063310665
admin@sonic:~$ show auto-techsupport-feature
10634-
FEATURE NAME STATE RATE LIMIT INTERVAL (sec)
10635-
-------------- -------- --------------------------
10636-
bgp enabled 600
10637-
database enabled 600
10638-
dhcp_relay enabled 600
10639-
lldp enabled 600
10640-
swss disabled 800
10666+
FEATURE NAME STATE RATE LIMIT INTERVAL (sec) AVAILABLE MEM THRESHOLD (%)
10667+
-------------- -------- -------------------------- ------------------------------
10668+
bgp enabled 600 10
10669+
database enabled 600 10
10670+
dhcp_relay enabled 600 10
10671+
lldp enabled 600 10
10672+
swss disabled 800 10
1064110673
```
1064210674
1064310675
**show auto-techsupport history**
@@ -10650,11 +10682,12 @@ This feature/capability makes the techsupport invocation event-driven based on c
1065010682
- Example:
1065110683
```
1065210684
admin@sonic:~$ show auto-techsupport history
10653-
TECHSUPPORT DUMP TRIGGERED BY CORE DUMP
10654-
---------------------------------------- -------------- -----------------------------
10655-
sonic_dump_r-lionfish-16_20210901_221402 bgp bgpcfgd.1630534439.55.core.gz
10656-
sonic_dump_r-lionfish-16_20210901_203725 snmp python3.1630528642.23.core.gz
10657-
sonic_dump_r-lionfish-16_20210901_222408 teamd python3.1630535045.34.core.gz
10685+
TECHSUPPORT DUMP TRIGGERED BY EVENT TYPE CORE DUMP
10686+
---------------------------------------- -------------- -------------- -----------------------------
10687+
sonic_dump_r-lionfish-16_20210901_221402 bgp core bgpcfgd.1630534439.55.core.gz
10688+
sonic_dump_r-lionfish-16_20210901_203725 snmp core python3.1630528642.23.core.gz
10689+
sonic_dump_r-lionfish-16_20210901_222408 teamd core python3.1630535045.34.core.gz
10690+
sonic_dump_r-lionfish-16_20210901_222511 N/A memory N/A
1065810691
```
1065910692
1066010693
Go Back To [Beginning of the document](#) or [Beginning of this section](#troubleshooting-commands)

0 commit comments

Comments
 (0)