Add CLI for route flow counter feature #2031

Junchao-Mellanox · 2022-01-24T02:18:09Z

HLD: sonic-net/SONiC#908
Command reference PR: #2069

What I did

Add CLIs for route flow counter feature

How I did it

Add show command show flowcnt-route config and command group show flowcnt-route stats
Add config command group config flowcnt-route pattern
Add clear command group sonic-clear flowcnt-route

How to verify it

Full unit test cover
Manual test
sonic-mgmt test cases

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

Enable/disable configuration:

counterpoll flowcnt-route  <enable | disable>
Example:
admin@sonic:~$ counterpoll flowcnt-route enable

Polling interval configuration:

counterpoll flowcnt-route interval <time_in_msec> // default - 1000ms
Example:
admin@sonic:~$ counterpoll flowcnt-route interval 2000

Show configuration:

counterpoll show
Example:
admin@sonic:~$ counterpoll show
Type                              Interval (in ms)          Status
--------------------------        ------------------        --------
FLOW_CNT_ROUTE_STAT               default(10000)            disable

Config route pattern:

config flowcnt-route pattern <add | remove> [--vrf <vrf>] [--max <route-max>] <prefix-pattern>    // configure route pattern
Example:
admin@sonic:~$ config flowcnt-route pattern add --vrf Vrf_1 --max 50 2.2.0.0/16
Route Pattern Flow Counter configuration is successful

admin@sonic:~$ config flowcnt-route pattern remove --vrf Vrf_1 2.2.0.0/16
Route Pattern Flow Counter configuration is successful

Show configuration:

show flowcnt-route config
Example:
admin@sonic:~$ show flowcnt-route config
Route pattern          VRF                 Max
-----------------------------------------------
3.3.0.0/16             default             50

Show counters value:

show flowcnt-route stats   // show statistics of all route flow counters
Example:
admin@sonic:~$ show flowcnt-route stats
Route pattern       VRF               Matched routes           Packets          Bytes
--------------------------------------------------------------------------------------
3.3.0.0/16          default           3.3.1.0/24               100              4543
                                      3.3.2.3/32               3443             929229
                                      3.3.0.0/16               0                0


show flowcnt-route stats pattern [<prefix-pattern> [ --vrf <vrf>] ]   // show statistics of all routes matching the configured route pattern
Example:
admin@sonic:~$ show flowcnt-route stats pattern 3.3.0.0/16
Route pattern       VRF               Matched routes           Packets          Bytes
--------------------------------------------------------------------------------------
3.3.0.0/16          default           3.3.1.0/24               100              4543
                                      3.3.2.3/32               3443             929229
                                      3.3.0.0/16               0                0

show flowcnt-route stats route [<prefix> [ --vrf <vrf>] ]             // show statistics of the specific route matching the configured route pattern
Example:
admin@sonic:~$ show flowcnt-route stats route 3.3.3.2/32 --vrf Vrf_1
Route                     VRF              Route Pattern           Packets          Bytes
-----------------------------------------------------------------------------------------
3.3.3.2/32                Vrf_1            3.3.0.0/16              100              4543

Clear counters:

sonic-clear flowcnt-route    // clear all route flow counters
Example:
admin@sonic:~$ sonic-clear flowcnt-route
Route Flow Counters were successfully cleared

sonic-clear flowcnt-route pattern  [<prefix-pattern> [ --vrf <vrf>] ]   // clear flow counters of all routes matching the configured route pattern
Example:
admin@sonic:~$ sonic-clear flowcnt-route pattern 3.3.0.0/16 --vrf Vrf_1
Flow Counters of all routes matching the configured route pattern were successfully cleared

sonic-clear flowcnt-route route [<prefix> [ --vrf <vrf>] ]  // clear flow counters of the specific route matching the configured prefix
Example:
admin@sonic:~$ sonic-clear flowcnt-route route 3.3.3.2/32 --vrf Vrf_1
Flow Counters of the specified route were successfully cleared

lgtm-com · 2022-01-24T02:30:29Z

This pull request introduces 4 alerts when merging 0ec2252 into 01dfb9c - view on LGTM.com

new alerts:

3 for Unused import
1 for Module is imported with 'import' and 'import from'

lgtm-com · 2022-01-24T06:25:10Z

This pull request introduces 1 alert when merging ffd14087fdb2b1b059daa2108433cb8b5359338c into 01dfb9c - view on LGTM.com

new alerts:

1 for Unused import

Junchao-Mellanox · 2022-01-25T01:42:47Z

/azpw run Azure.sonic-utilities

mssonicbld · 2022-01-25T01:42:48Z

/AzurePipelines run Azure.sonic-utilities

azure-pipelines · 2022-01-25T01:42:58Z

Azure Pipelines successfully started running 1 pipeline(s).

lgtm-com · 2022-01-25T16:19:15Z

This pull request introduces 1 alert when merging 7c498a40e20a7a4d6d34cddc459f6c546f66affa into 01dfb9c - view on LGTM.com

new alerts:

1 for Unused import

dgsudharsan · 2022-01-25T18:22:40Z

@Junchao-Mellanox Can you please update the description to include the output of the new show commands introduced? Please also update the command reference

flow_counter_util/route.py

config/flow_counters.py

scripts/flow_counters_stat

utilities_common/cli.py

tests/mock_tables/state_db.json

tests/mock_tables/counters_db.json

tests/mock_tables/asic1/counters_db.json

tests/mock_tables/asic0/counters_db.json

tests/counterpoll_input/config_db.json

tests/flow_counter_stats_test.py

Junchao-Mellanox · 2022-01-26T03:19:40Z

@Junchao-Mellanox Can you please update the description to include the output of the new show commands introduced? Please also update the command reference

Updated description. There is another PR which updated the command reference.

lgtm-com · 2022-01-26T03:24:52Z

This pull request introduces 1 alert when merging 8674385d6b5c9a0935381a295f0f2d49c1cb7a92 into 01dfb9c - view on LGTM.com

new alerts:

1 for Unused import

dgsudharsan · 2022-01-26T05:43:25Z

@Junchao-Mellanox Can you please update the description to include the output of the new show commands introduced? Please also update the command reference

Updated description. There is another PR which updated the command reference.

Please add the link here.

Junchao-Mellanox · 2022-01-26T07:15:03Z

/azpw run Azure.sonic-utilities

mssonicbld · 2022-01-26T07:15:06Z

/AzurePipelines run Azure.sonic-utilities

azure-pipelines · 2022-01-26T07:15:18Z

Azure Pipelines successfully started running 1 pipeline(s).

lgtm-com · 2022-01-26T07:42:31Z

This pull request introduces 1 alert when merging 2b91d783b95f686cd729d6b2b35e0cb552b52a71 into 01dfb9c - view on LGTM.com

new alerts:

1 for Unused import

Junchao-Mellanox · 2022-02-08T03:00:08Z

/azpw run Azure.sonic-utilities

mssonicbld · 2022-02-08T03:00:10Z

/AzurePipelines run Azure.sonic-utilities

azure-pipelines · 2022-02-08T03:00:22Z

Azure Pipelines successfully started running 1 pipeline(s).

Junchao-Mellanox · 2022-02-09T00:24:34Z

/azpw run Azure.sonic-utilities

mssonicbld · 2022-02-09T00:24:35Z

/AzurePipelines run Azure.sonic-utilities

azure-pipelines · 2022-02-09T00:24:46Z

Azure Pipelines successfully started running 1 pipeline(s).

Junchao-Mellanox · 2022-02-10T04:46:32Z

/azpw run Azure.sonic-utilities

azure-pipelines · 2022-02-14T10:04:13Z

Azure Pipelines successfully started running 1 pipeline(s).

Junchao-Mellanox · 2022-02-17T07:55:47Z

/azpw run Azure.sonic-utilities

mssonicbld · 2022-02-17T07:55:48Z

/AzurePipelines run Azure.sonic-utilities

azure-pipelines · 2022-02-17T07:55:59Z

Azure Pipelines successfully started running 1 pipeline(s).

Junchao-Mellanox · 2022-02-17T08:01:48Z

/azpw run Azure.sonic-utilities

mssonicbld · 2022-02-17T08:01:49Z

/AzurePipelines run Azure.sonic-utilities

azure-pipelines · 2022-02-17T08:02:00Z

Azure Pipelines successfully started running 1 pipeline(s).

lgtm-com · 2022-03-02T02:18:18Z

This pull request introduces 1 alert when merging c826391 into d440df7 - view on LGTM.com

new alerts:

1 for Unused import

Junchao-Mellanox · 2022-03-02T06:40:51Z

/azpw run Azure.sonic-utilities

mssonicbld · 2022-03-02T06:40:53Z

/AzurePipelines run Azure.sonic-utilities

azure-pipelines · 2022-03-02T06:41:05Z

Azure Pipelines successfully started running 1 pipeline(s).

…watermark counters (#2091) This is to backport the changes in #2082 #2031 updated the flex counter polling interval to 60s for watermark counters but the show command wasn't updated to reflect the correct default value #### What I did Display the correct poll interval for watermark related counters in the 'counterpoll show' command #### How I did it Update the default interval to be the same as the one updated by the Orchs #### How to verify it Issue "counterpoll show", the queue, pg and buffer pool watermark should show default 60s Updated the counterpoll unit tests to reflect the same

lgtm-com · 2022-04-12T14:11:23Z

This pull request introduces 2 alerts when merging 5ed1006 into 576c9ef - view on LGTM.com

new alerts:

2 for Unused import

lgtm-com · 2022-04-14T02:22:30Z

This pull request introduces 1 alert when merging 7383b62 into 23e9398 - view on LGTM.com

new alerts:

1 for Unused import

lgtm-com · 2022-04-14T02:52:43Z

This pull request introduces 1 alert when merging 4cb17e9 into 23e9398 - view on LGTM.com

new alerts:

1 for Unused import

- What I did Add CLIs document for route flow counter feature, CLI PR: #2031 - How I did it Add CLIs document for route flow counter feature - How to verify it Run build

Junchao-Mellanox requested review from keboliu, dgsudharsan and prsunny January 24, 2022 02:20

Junchao-Mellanox mentioned this pull request Jan 24, 2022

High level design for route flow counter sonic-net/SONiC#908

Merged

dgsudharsan suggested changes Jan 26, 2022

View reviewed changes

tests/flow_counter_stats_test.py Show resolved Hide resolved

tests/flow_counter_stats_test.py Show resolved Hide resolved

tests/flow_counter_stats_test.py Outdated Show resolved Hide resolved

Junchao-Mellanox requested a review from dgsudharsan January 26, 2022 03:18

dgsudharsan previously approved these changes Jan 26, 2022

View reviewed changes

Junchao-Mellanox dismissed dgsudharsan’s stale review via 2b91d78 January 26, 2022 07:32

Junchao-Mellanox mentioned this pull request Feb 15, 2022

[Command-Reference] Add CLI docs for route flow counter #2069

Merged

Merge branch 'master' into route-flow-counter

c826391

Junchao-Mellanox dismissed dgsudharsan’s stale review via c826391 March 2, 2022 02:10

keboliu previously approved these changes Mar 2, 2022

View reviewed changes

dgsudharsan previously approved these changes Mar 2, 2022

View reviewed changes

neethajohn mentioned this pull request Mar 3, 2022

[202012] [counterpoll] Display the correct default poll interval for watermark counters #2091

Merged

Merge branch 'master' into route-flow-counter

5ed1006

Fix LGTM warning

7383b62

Junchao-Mellanox dismissed stale reviews from dgsudharsan and keboliu via 7383b62 April 14, 2022 02:11

Fix LGTM warning

4cb17e9

liat-grozovik approved these changes Apr 18, 2022

View reviewed changes

liat-grozovik merged commit 3732ac5 into sonic-net:master Apr 18, 2022

yozhao101 mentioned this pull request May 8, 2022

[master][sonic-utilities] Update sonic-utilities submodule sonic-net/sonic-buildimage#10781

Closed

Add CLI for route flow counter feature #2031

Add CLI for route flow counter feature #2031

Conversation

Junchao-Mellanox commented Jan 24, 2022 • edited

What I did

How I did it

How to verify it

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

lgtm-com bot commented Jan 24, 2022

lgtm-com bot commented Jan 24, 2022

Junchao-Mellanox commented Jan 25, 2022

mssonicbld commented Jan 25, 2022

azure-pipelines bot commented Jan 25, 2022

lgtm-com bot commented Jan 25, 2022

dgsudharsan commented Jan 25, 2022

Junchao-Mellanox commented Jan 26, 2022

lgtm-com bot commented Jan 26, 2022

dgsudharsan commented Jan 26, 2022

Junchao-Mellanox commented Jan 26, 2022

mssonicbld commented Jan 26, 2022

azure-pipelines bot commented Jan 26, 2022

lgtm-com bot commented Jan 26, 2022

Junchao-Mellanox commented Feb 8, 2022

mssonicbld commented Feb 8, 2022

azure-pipelines bot commented Feb 8, 2022

Junchao-Mellanox commented Feb 9, 2022

mssonicbld commented Feb 9, 2022

azure-pipelines bot commented Feb 9, 2022

Junchao-Mellanox commented Feb 10, 2022

azure-pipelines bot commented Feb 14, 2022

Junchao-Mellanox commented Feb 17, 2022

mssonicbld commented Feb 17, 2022

azure-pipelines bot commented Feb 17, 2022

Junchao-Mellanox commented Feb 17, 2022

mssonicbld commented Feb 17, 2022

azure-pipelines bot commented Feb 17, 2022

lgtm-com bot commented Mar 2, 2022

Junchao-Mellanox commented Mar 2, 2022

mssonicbld commented Mar 2, 2022

azure-pipelines bot commented Mar 2, 2022

lgtm-com bot commented Apr 12, 2022

lgtm-com bot commented Apr 14, 2022

lgtm-com bot commented Apr 14, 2022

Junchao-Mellanox commented Jan 24, 2022 •

edited