Skip to content

Commit

Permalink
Add command reference for trap flow counters (sonic-net#1876)
Browse files Browse the repository at this point in the history
*Update CLI command reference for trap flow counters
  • Loading branch information
Junchao-Mellanox committed Nov 29, 2021
1 parent 67a267b commit b550c44
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions doc/Command-Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
* [Feature](#feature)
* [Feature show commands](#feature-show-commands)
* [Feature config commands](#feature-config-commands)
* [Flow Counters](#flow-counters)
* [Flow Counters show commands](#flow-counters-show-commands)
* [Flow Counters clear commands](#flow-counters-clear-commands)
* [Gearbox](#gearbox)
* [Gearbox show commands](#gearbox-show-commands)
* [Interfaces](#interfaces)
Expand Down Expand Up @@ -3066,6 +3069,58 @@ commands are don't care and will not update state/auto-restart value.

Go Back To [Beginning of the document](#) or [Beginning of this section](#feature)

## Flow Counters

This section explains all the Flow Counters show commands and clear commands that are supported in SONiC. Flow counters are usually used for debugging, troubleshooting and performance enhancement processes. Flow counters supports case like:

- Host interface traps (number of received traps per Trap ID)

### Flow Counters show commands

**show flowcnt-trap stats**

This command is used to show the current statistics for the registered host interface traps.

Because clear (see below) is handled on a per-user basis different users may see different counts.

- Usage:
```
show flowcnt-trap stats
```

- Example:
```
admin@sonic:~$ show flowcnt-trap stats
Trap Name Packets Bytes PPS
--------- --------- ------- -------
dhcp 100 2,000 50.25/s
For multi-ASIC:
admin@sonic:~$ show flowcnt-trap stats
ASIC ID Trap Name Packets Bytes PPS
------- ----------- --------- ------- -------
asic0 dhcp 100 2,000 50.25/s
asic1 dhcp 200 3,000 45.25/s
```

### Flow Counters clear commands

**sonic-clear flowcnt-trap**

This command is used to clear the current statistics for the registered host interface traps. This is done on a per-user basis.

- Usage:
```
sonic-clear flowcnt-trap
```

- Example:
```
admin@sonic:~$ sonic-clear flowcnt-trap
Trap Flow Counters were successfully cleared
```

Go Back To [Beginning of the document](#) or [Beginning of this section](#flow-counters)
## Gearbox

This section explains all the Gearbox PHY show commands that are supported in SONiC.
Expand Down

0 comments on commit b550c44

Please sign in to comment.