Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Create unique error codes for error messages that need context #2866

Closed
5 tasks done
Tracked by #3705
draychev opened this issue Mar 15, 2021 · 0 comments
Closed
5 tasks done
Tracked by #3705

Create unique error codes for error messages that need context #2866

draychev opened this issue Mar 15, 2021 · 0 comments
Assignees
@jaellio
Labels
area/control-plane Related to OSM's control plane area/documentation work items associated with the improvements or additions to documentation size/L 14 days (~2.5 weeks)
Milestone
v1.0.0

Comments

@draychev
Copy link
Contributor

draychev commented Mar 15, 2021 •
edited by jaellio
Loading

This GitHub Issue is for the creation (generation) of and addition of unique error codes to each error message in OSM Controller.

  • Generate unique error codes for errors logged by OSM. Each error code will then be described with a paragraph in Go code - Literate Programming style
  • Add the created unique error code to each error log statement in OSM Controller. The overall logging facility needs to be augmented to mandate the unique code.
  • The Go code needs to guarantee there are no duplicates of each code
  • ensure test/ci/code goes without a paragraph of an explanation of what has gone wrong. The error code is meant to provide context to folks troubleshooting using tools. This is meant to provide quick context, without having to read code to understand what is going wrong. The context could have explanations that include the fact that we were looping over certain list of Kubernetes primitives (for example) and ran into unexpected behavior etc.
  • The doc, which links error code to explanation should be GENERATED from Go code. Then pkg/troubleshooter will use this map of code-explanation to provide the explanation. Folks troubleshooting without a tool could use the static doc (MarkDown generated from Go map of error code to paragraph) to search for a particular code

An error log is mapped to an error code if it is of the form log.Error().Str(errcode.Kind, errcode.SomeError.String()).Msg()
@draychev draychev added area/documentation work items associated with the improvements or additions to documentation priority/P2 P2 priority labels Mar 15, 2021
@draychev draychev added the size/M 7 days (~1.5 week) label Mar 29, 2021
@shashankram shashankram mentioned this issue May 21, 2021
Closed
@draychev draychev mentioned this issue May 27, 2021
Closed
30 tasks
@draychev draychev added this to the v0.10.0 milestone Jun 2, 2021
@draychev draychev removed this from the v0.10.0 milestone Jun 28, 2021
@shashankram shashankram self-assigned this Jun 29, 2021
@shashankram shashankram added size/L 14 days (~2.5 weeks) and removed size/M 7 days (~1.5 week) labels Jun 30, 2021
@draychev draychev added this to the v0.10.0 milestone Jun 30, 2021
@draychev draychev mentioned this issue Jun 30, 2021
Closed
8 tasks
shashankram added a commit to shashankram/osm that referenced this issue Jun 30, 2021
@shashankram
errcode: introduce error code management
9fcfb09 
Introduces a pkg to manage error codes. Documentation
and tooling to inspect errors will be built around
the error code and description mapping provided by
this pkg.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
shashankram added a commit to shashankram/osm that referenced this issue Jun 30, 2021
@shashankram
errcode: introduce error code management
af1751b 
Introduces a pkg to manage error codes. Documentation
and tooling to inspect errors will be built around
the error code and description mapping provided by
this pkg.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
shashankram added a commit to shashankram/osm that referenced this issue Jun 30, 2021
@shashankram
errcode: introduce error code management
2da2782 
Introduces a pkg to manage error codes. Documentation
and tooling to inspect errors will be built around
the error code and description mapping provided by
this pkg.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
@shashankram shashankram mentioned this issue Jun 30, 2021
Merged
shashankram added a commit to shashankram/osm that referenced this issue Jun 30, 2021
@shashankram
errcode: introduce error code management
6939047 
Introduces a pkg to manage error codes. Documentation
and tooling to inspect errors will be built around
the error code and description mapping provided by
this pkg.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
shashankram added a commit to shashankram/osm that referenced this issue Jun 30, 2021
@shashankram
errcode: introduce error code management
0776376 
Introduces a pkg to manage error codes. Documentation
and tooling to inspect errors will be built around
the error code and description mapping provided by
this pkg.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
shashankram added a commit to shashankram/osm that referenced this issue Jun 30, 2021
@shashankram
errcode: introduce error code management
8bb7371 
Introduces a pkg to manage error codes. Documentation
and tooling to inspect errors will be built around
the error code and description mapping provided by
this pkg.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
shashankram added a commit to shashankram/osm that referenced this issue Jun 30, 2021
@shashankram
cmd/osm-*: log error codes for errors during startup
31b0d23 
Logs error codes for errors encountered during app
startup. Additionally moves error logging to the
caller/handler of the error to avoid duplicate
logging.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
@shashankram shashankram mentioned this issue Jun 30, 2021
Merged
shashankram added a commit to shashankram/osm that referenced this issue Jul 1, 2021
@shashankram
catalog/traffic-policies: add error codes
4af79f1 
Adds error codes for inbound and outbound
traffic policy related errors.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
@shashankram shashankram mentioned this issue Jul 1, 2021
Merged
@shashankram shashankram changed the title doc: Create unique error codes for error messages that need context Create unique error codes for error messages that need context Jul 1, 2021
@shashankram shashankram added the area/control-plane Related to OSM's control plane label Jul 1, 2021
shashankram added a commit to shashankram/osm that referenced this issue Jul 2, 2021
@shashankram
cli: add support command to list error code description
72ac7e5 
Adds a new command `osm support error-info` that lists
the mapping of one or all error codes to their description.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
shashankram added a commit to shashankram/osm that referenced this issue Jul 2, 2021
@shashankram
cli: add support command to list error code description
5e9d6a6 
Adds a new command `osm support error-info` that lists
the mapping of one or all error codes to their description.

Part of openservicemesh#2866

Signed-off-by: Shashank Ram <shashr2204@gmail.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 12, 2021
@jaellio
pkg/envoy/cds: add error codes
d354ce3 
Adds error codes for errors related to Envoy CDS.

Part of openservicemesh#2866.

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 12, 2021
@jaellio
pkg/envoy/lds: add error codes
c86ff7d 
Adds error codes for errors related to Envoy LDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 12, 2021
@jaellio
pkg/envoy/lds: add error codes
bb868b4 
Adds error codes for errors related to Envoy LDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
@jaellio jaellio mentioned this issue Jul 12, 2021
Merged
jaellio added a commit to jaellio/osm that referenced this issue Jul 12, 2021
@jaellio
pkg/envoy/lds: add error codes
cd38cbc 
Adds error codes for errors related to Envoy LDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 13, 2021
@jaellio
pkg/envoy/lds: add error codes
a371a6f 
Adds error codes for errors related to Envoy LDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 13, 2021
@jaellio
pkg/envoy/lds: add error codes
c24947c 
Adds error codes for errors related to Envoy LDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 14, 2021
@jaellio
pkg/envoy/*: add error codes for Envoy RDS and SDS
55983c2 
Adds error codes for errors related to Envoy RDS and SDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
@jaellio jaellio mentioned this issue Jul 14, 2021
Merged
jaellio added a commit to jaellio/osm that referenced this issue Jul 14, 2021
@jaellio
pkg/envoy/*: add error codes for Envoy RDS and SDS
c881fcd 
Adds error codes for errors related to Envoy RDS and SDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 14, 2021
@jaellio
pkg/*: add error codes
016c071 
Adds error codes related to Ingress and the OSM Injector.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
@jaellio jaellio mentioned this issue Jul 14, 2021
Merged
jaellio added a commit to jaellio/osm that referenced this issue Jul 14, 2021
@jaellio
pkg/*: add error codes
17196ce 
Adds error codes related to Ingress and the OSM Injector.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 14, 2021
@jaellio
pkg/*: add error codes
0682924 
Adds error codes related to Ingress and the OSM Injector.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 15, 2021
@jaellio
pkg/envoy/*: add error codes for Envoy RDS and SDS
79975f9 
Adds error codes for errors related to Envoy RDS and SDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 15, 2021
@jaellio
pkg/*: add error codes
23f9ca5 
Adds error codes related to Ingress and the OSM Injector.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
shashankram pushed a commit to shashankram/osm that referenced this issue Jul 15, 2021
@jaellio @shashankram
pkg/certificate: add error codes
89fb923 
Adds error codes for errors related to certificate providers.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
shashankram pushed a commit to shashankram/osm that referenced this issue Jul 15, 2021
@jaellio @shashankram
pkg/envoy/ads: add error codes
ff9cb81 
Adds error codes for errors related to Envoy ADS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
shashankram pushed a commit to shashankram/osm that referenced this issue Jul 15, 2021
@jaellio @shashankram
pkg/envoy/cds: add error codes
edf68da 
Adds error codes for errors related to Envoy CDS.

Part of openservicemesh#2866.

Signed-off-by: jaellio <jaellio@microsoft.com>
shashankram pushed a commit to shashankram/osm that referenced this issue Jul 15, 2021
@jaellio @shashankram
pkg/envoy/lds: add error codes
f8f452c 
Adds error codes for errors related to Envoy LDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 16, 2021
@jaellio
pkg/envoy/*: add error codes for Envoy RDS and SDS
8b88525 
Adds error codes for errors related to Envoy RDS and SDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 26, 2021
@jaellio
pkg/envoy/*: add error codes for Envoy RDS and SDS
039d278 
Adds error codes for errors related to Envoy RDS and SDS.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 27, 2021
@jaellio
pkg/*: add error codes
fffa800 
Adds error codes related to Ingress and the OSM Injector.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 30, 2021
@jaellio
pkg/*: add error codes
c162fee 
Adds error codes related to Ingress and the OSM Injector.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
jaellio added a commit to jaellio/osm that referenced this issue Jul 30, 2021
@jaellio
pkg/*: add error codes
3e7b1bb 
Adds error codes related to Ingress and the OSM Injector.

Part of openservicemesh#2866

Signed-off-by: jaellio <jaellio@microsoft.com>
@shashankram shashankram removed their assignment Aug 19, 2021
@draychev draychev modified the milestones: v0.10.0, v1.0.0 Aug 23, 2021
@jaellio jaellio closed this as completed Aug 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jaellio jaellio

Labels
area/control-plane Related to OSM's control plane area/documentation work items associated with the improvements or additions to documentation size/L 14 days (~2.5 weeks)
Projects
None yet
Milestone
v1.0.0
Development

No branches or pull requests
3 participants
@shashankram @draychev @jaellio