Skip to content

Commit

Permalink
[Auto Techsupport] Added Event Driven TS to Command Reference (sonic-…
Browse files Browse the repository at this point in the history
…net#1985)

Added the Event Driven Tech Support related information to the Command Reference Guide. HLD
  • Loading branch information
vivekrnv authored Jan 19, 2022
1 parent d9f3afe commit f614803
Showing 1 changed file with 172 additions and 1 deletion.
173 changes: 172 additions & 1 deletion doc/Command-Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@
* [SONiC Installer](#sonic-installer)
* [Troubleshooting Commands](#troubleshooting-commands)
* [Debug Dumps](#debug-dumps)
* [Event Driven Techsupport Invocation](#event-driven-techsupport-invocation)
* [Routing Stack](#routing-stack)
* [Quagga BGP Show Commands](#Quagga-BGP-Show-Commands)
* [ZTP Configuration And Show Commands](#ztp-configuration-and-show-commands)
Expand Down Expand Up @@ -10084,8 +10085,178 @@ In SONiC, there usually exists a set of tables related/relevant to a particular
}
}
```
### Event Driven Techsupport Invocation
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
#### config auto-techsupport global commands
**config auto-techsupport global state**
- Usage:
```
config auto-techsupport global state <enabled/disabled>
```
- Example:
```
config auto-techsupport global state enabled
```
**config auto-techsupport global rate-limit-interval <uint16>**
- Usage:
```
config auto-techsupport global rate-limit-interval <uint16>
```
- Parameters:
- rate-limit-interval: Minimum time in seconds to wait after the last techsupport creation time before invoking a new one.
- Example:
```
config auto-techsupport global rate-limit-interval 200
```
**config auto-techsupport global max-techsupport-limit <float upto two decimal places>**
- Usage:
```
config auto-techsupport global max-techsupport-limit <float upto two decimal places>
```
- Parameters:
- max-techsupport-limit: A percentage value should be specified. This signifies maximum size to which /var/dump/ directory can be grown until.
- Example:
```
config auto-techsupport global max-techsupport-limit 10.15
```
**config auto-techsupport global max-core-limit <float upto two decimal places>**
- Usage:
```
config auto-techsupport global max-core-limit <float upto two decimal places>
```
- Parameters:
- max-core-limit: A percentage value should be specified. This signifies maximum size to which /var/core/ directory can be grown until.
- Example:
```
config auto-techsupport global max-core-limit 10.15
```
**config auto-techsupport global since**
- Usage:
```
config auto-techsupport global since <string>
```
- Parameters:
- 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.
- Example:
```
config auto-techsupport global since <string>
```
#### config auto-techsupport-feature commands
**config auto-techsupport-feature add**
- Usage:
```
config auto-techsupport-feature add <feature_name> --state <enabled/disabled> --rate-limit-interval <uint16>
```
- Parameters:
- state: enable/disable the capability for the specific feature/container.
- 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
- Example:
```
config auto-techsupport-feature add bgp --state enabled --rate-limit-interval 200
```
**config auto-techsupport-feature delete**
- Usage:
```
config auto-techsupport-feature delete <feature_name>
```
- Example:
```
config auto-techsupport-feature delete swss
```
**config auto-techsupport-feature update**
- Usage:
```
config auto-techsupport-feature update <feature_name> --state <enabled/disabled>
config auto-techsupport-feature update <feature_name> --rate-limit-interval <uint16>
```
- Example:
```
config auto-techsupport-feature update snmp --state enabled
config auto-techsupport-feature update swss --rate-limit-interval 200
```
#### Show CLI:
**show auto-techsupport global**
- Usage:
```
show auto-techsupport global
```
- Example:
```
admin@sonic:~$ show auto-techsupport global
STATE RATE LIMIT INTERVAL (sec) MAX TECHSUPPORT LIMIT (%) MAX CORE LIMIT (%) SINCE
------- --------------------------- -------------------------- ------------------ ----------
enabled 180 10.0 5.0 2 days ago
```
**show auto-techsupport-feature**
- Usage:
```
show auto-techsupport-feature
```
- Example:
```
admin@sonic:~$ show auto-techsupport-feature
FEATURE NAME STATE RATE LIMIT INTERVAL (sec)
-------------- -------- --------------------------
bgp enabled 600
database enabled 600
dhcp_relay enabled 600
lldp enabled 600
swss disabled 800
```
**show auto-techsupport history**
- Usage:
```
show auto-techsupport history
```
- Example:
```
admin@sonic:~$ show auto-techsupport history
TECHSUPPORT DUMP TRIGGERED BY CORE DUMP
---------------------------------------- -------------- -----------------------------
sonic_dump_r-lionfish-16_20210901_221402 bgp bgpcfgd.1630534439.55.core.gz
sonic_dump_r-lionfish-16_20210901_203725 snmp python3.1630528642.23.core.gz
sonic_dump_r-lionfish-16_20210901_222408 teamd python3.1630535045.34.core.gz
```
Go Back To [Beginning of the document](#) or [Beginning of this section](#troubleshooting-commands)
Expand Down

0 comments on commit f614803

Please sign in to comment.