[HLD] Event Driven TechSupport Invocation & CoreDump Mgmt by vivekrnv · Pull Request #818 · sonic-net/SONiC

vivekrnv · 2021-07-22T20:52:36Z

Signed-off-by: Vivek Reddy Karri vkarri@nvidia.com

The high-level design document for the "Event Driven TechSupport Invocation & CoreDump Mgmt" enhancement

Repo	PR title	State
sonic-buildimage	[Auto Techsupport] Event driven Techsupport Changes
sonic-utilities	[Auto Techsupport] Event driven Techsupport Changes

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

nazariig · 2021-09-02T15:38:44Z

doc/auto_techsupport_and_coredump_mgmt.md

+state = enabled|disabled;                   # Enable this to make the Techsupport Invocation event driven based on core-dump generation
+rate_limit_interval = 300;                  # Minimum Time in seconds, between two successive techsupport invocations.
+                                              Manual Invocations will be considered as well in the cooloff calculation
+max_techsupport_size = 10;                  # A perentage value should be specified. 


@vivekreddynv typo? Did you mean percentage?

nazariig · 2021-09-02T15:38:56Z

doc/auto_techsupport_and_coredump_mgmt.md

+                                              This signifies maximum Size to which /var/dump/ directory can be grown until. 
+                                              The actual value in bytes is calculate based on the available space in the filesystem hosting /var/dump
+                                              When the limit is crossed, the older techsupport dumps are incrementally deleted                         
+max_core_size = 5;                          # A perentage value should be specified. 


@vivekreddynv typo? Did you mean percentage?

nazariig · 2021-09-02T15:43:03Z

doc/auto_techsupport_and_coredump_mgmt.md

+
+Where `<comm>` value in the command name associated with a process. comm value of a running process can be read from `/proc/[pid]/comm` file
+
+## 4. Schema Additions


@vivekreddynv suggest to follow SONiC DB schema description conventions (ABNF):

https://github.com/Azure/sonic-swss/blob/master/doc/swss-schema.md

https://datatracker.ietf.org/doc/html/rfc5234

nazariig · 2021-09-02T15:44:42Z

doc/auto_techsupport_and_coredump_mgmt.md

+        description "First Revision";
+    }
+
+    typedef enable-knob {


@vivekreddynv we already have this type in SONiC:
https://github.com/Azure/sonic-buildimage/blob/master/src/sonic-yang-models/yang-models/sonic-types.yang#L54

typedef admin_status { type enumeration { enum up; enum down; } }

I feel "enabled|disabled" makes better sense here over "up|down".

@vivekreddynv sorry, a typo:
https://github.com/Azure/sonic-buildimage/blob/master/src/sonic-yang-models/yang-models/sonic-types.yang#L119

typedef admin_mode { type enumeration { enum enabled; enum disabled; } }

Oh okay, I'll change this

nazariig · 2021-09-02T15:45:58Z

doc/auto_techsupport_and_coredump_mgmt.md

+                leaf feature_name {
+                    description "The name of this feature";
+                    /* TODO: Leafref once the FEATURE YANG is added*/
+                    type string;


@vivekreddynv please add a key length constraint

liat-grozovik · 2021-11-11T16:15:16Z

@nazariig do you have any further comments? if not can you please approve?

#### What I did sonic-utilities changes required for feature "Event Driven TechSupport Invocation & CoreDump Mgmt". [HLD](sonic-net/SONiC#818 ) Summary of the changes: - Added the AUTO GEN CLI for the CFG DB tables required for this feature - Added the coredump_gen_handler.py & techsupport_cleanup.py scripts. - Added the UT's required for these scripts. - Enhanced coredump-compress & generate-dump scripts

#### Why I did it Changes required for feature "Event Driven TechSupport Invocation & CoreDump Mgmt". [HLD](sonic-net/SONiC#818 ) Requires: sonic-net/sonic-utilities#1796. Merging in any order would be fine. Summary of the changes: - Added the YANG Models for the new tables introduces as a part of this feature. - Enhanced init_cfg.json with the default config required - Added a compile Time flag which enables/disables the config required for this feature inside the init_cfg.json - Enhanced the supervisor-proc-exit-listener script to populate `<feature>:<critical_proc> = <comm>:<pid>` info in the STATE_DB when it observes an proc exit notification for the critical processes running inside the docker.

#### What I did sonic-utilities changes required for feature "Event Driven TechSupport Invocation & CoreDump Mgmt". [HLD](sonic-net/SONiC#818 ) Summary of the changes: - Added the AUTO GEN CLI for the CFG DB tables required for this feature - Added the coredump_gen_handler.py & techsupport_cleanup.py scripts. - Added the UT's required for these scripts. - Enhanced coredump-compress & generate-dump scripts

vivekrnv and others added 30 commits June 4, 2021 17:07

Crash Capture Tech Support Enhancement

80c212c

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

Update crash_capture.md

6bde847

Update crash_capture.md

854bc22

Update crash_capture.md

833c134

Update crash_capture.md

6a3c953

Update crash_capture.md

9755a92

Renamed the Techsupport doc

2b86bd0

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

Update auto_techsupport_gen.md

2c4679b

Update auto_techsupport_gen.md

1b232e5

Update auto_techsupport_gen.md

b948f22

Update auto_techsupport_gen.md

4b4b7a8

Update auto_techsupport_gen.md

ea7f926

Update auto_techsupport_gen.md

47890a9

Update auto_techsupport_gen.md

498a52c

Updated Config DB Schema

42f9b2d

Update auto_techsupport_gen.md

79208a9

Updated Schema, Yang Model and CLI

5ac6d65

Minor Fixes

3521be3

max_cdd-Dump changed to percentage based

59a4739

Updated the size-based cleanup

4730879

Update auto_techsupport_gen.md

848cb00

Update auto_techsupport_gen.md

d82e2c7

Update auto_techsupport_gen.md

2a325bf

Update auto_techsupport_gen.md

584c465

Update auto_techsupport_gen.md

e667ed3

Update auto_techsupport_gen.md

b8c9bad

Update auto_techsupport_gen.md

406c3b1

Update auto_techsupport_gen.md

a3523b3

Simplified the Design

4f07a40

Updated 6.5 section

1149eb4

vivekrnv added 7 commits August 30, 2021 09:45

HLD Updated

f1d218a

YANG aligned

c27f348

Update auto_techsupport_and_coredump_mgmt.md

1f5283d

Updated schema, YANG and CLI

6ef60cb

Schema Updated

c69cb01

Added extra details

7429c9f

Updated

c019e2b

nazariig reviewed Sep 2, 2021

View reviewed changes

nazariig previously approved these changes Sep 2, 2021

View reviewed changes

This was referenced Sep 3, 2021

[Auto Techsupport] Event driven Techsupport Changes sonic-net/sonic-buildimage#8670

Merged

[Auto Techsupport] Event driven Techsupport Changes sonic-net/sonic-utilities#1796

Merged

Updated YANG

425b926

vivekrnv dismissed nazariig’s stale review via 425b926 September 3, 2021 04:46

vivekrnv added 4 commits September 2, 2021 21:47

Update auto_techsupport_and_coredump_mgmt.md

014ec97

Schema Updated

cb59885

Update auto_techsupport_and_coredump_mgmt.md

7d09588

Update auto_techsupport_and_coredump_mgmt.md

3bf3914

qiluo-msft requested a review from ganglyu September 21, 2021 08:22

ganglyu approved these changes Oct 17, 2021

View reviewed changes

nazariig approved these changes Nov 11, 2021

View reviewed changes

liat-grozovik merged commit 23545e2 into sonic-net:master Nov 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HLD] Event Driven TechSupport Invocation & CoreDump Mgmt #818

[HLD] Event Driven TechSupport Invocation & CoreDump Mgmt #818
liat-grozovik merged 72 commits intosonic-net:masterfrom
vivekrnv:techsupport_enhancement

vivekrnv commented Jul 22, 2021 •

edited

Loading

Uh oh!

nazariig Sep 2, 2021

Uh oh!

nazariig Sep 2, 2021

Uh oh!

nazariig Sep 2, 2021

Uh oh!

vivekrnv Sep 3, 2021

Uh oh!

nazariig Sep 2, 2021

Uh oh!

vivekrnv Sep 2, 2021

Uh oh!

nazariig Sep 2, 2021 •

edited

Loading

Uh oh!

vivekrnv Sep 2, 2021

Uh oh!

nazariig Sep 2, 2021 •

edited

Loading

Uh oh!

liat-grozovik commented Nov 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants


		Where `<comm>` value in the command name associated with a process. comm value of a running process can be read from `/proc/[pid]/comm` file

		## 4. Schema Additions

Conversation

vivekrnv commented Jul 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nazariig Sep 2, 2021

Choose a reason for hiding this comment

Uh oh!

nazariig Sep 2, 2021

Choose a reason for hiding this comment

Uh oh!

nazariig Sep 2, 2021

Choose a reason for hiding this comment

Uh oh!

vivekrnv Sep 3, 2021

Choose a reason for hiding this comment

Uh oh!

nazariig Sep 2, 2021

Choose a reason for hiding this comment

Uh oh!

vivekrnv Sep 2, 2021

Choose a reason for hiding this comment

Uh oh!

nazariig Sep 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vivekrnv Sep 2, 2021

Choose a reason for hiding this comment

Uh oh!

nazariig Sep 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

liat-grozovik commented Nov 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vivekrnv commented Jul 22, 2021 •

edited

Loading

nazariig Sep 2, 2021 •

edited

Loading

nazariig Sep 2, 2021 •

edited

Loading