You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[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]>
Copy file name to clipboardExpand all lines: doc/Command-Reference.md
+51-18
Original file line number
Diff line number
Diff line change
@@ -10487,7 +10487,8 @@ In SONiC, there usually exists a set of tables related/relevant to a particular
10487
10487
10488
10488
### Event Driven Techsupport Invocation
10489
10489
10490
-
This feature/capability makes the techsupport invocation event-driven based on core dump generation. This feature is only applicable forthe processes runningin 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 forthe processes runningin 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
10491
10492
10492
10493
#### config auto-techsupport global commands
10493
10494
@@ -10559,22 +10560,52 @@ This feature/capability makes the techsupport invocation event-driven based on c
10559
10560
config auto-techsupport global since <string>
10560
10561
```
10561
10562
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
config auto-techsupport-feature add <feature_name> --state <enabled/disabled> --rate-limit-interval <uint16> --available-mem-threshold <float up to two decimal places>
10570
10600
```
10571
10601
- Parameters:
10572
10602
- state: enable/disable the capability for the specific feature/container.
10573
10603
- 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.
0 commit comments