Refine sig-instrumentation devel docs (#5915)

* Updated sig-instrumentation devel docs

* klog.ErrorS example

Signed-off-by: Parul <[email protected]>

* add os.Exit

Signed-off-by: Parul <[email protected]>

Co-authored-by: Parul <[email protected]>

Author: CatherineF-dev

contributors/devel/sig-instrumentation/instrumentation.md

@@ -198,11 +198,11 @@ Those pieces of information should be normalized into an info-level metric
 which is always set to 1. For example:
 
 ```
-kube_pod_info{pod=...,namespace=...,pod_ip=...,host_ip=..,node=..., ...}
+kube_pod_info{pod=...,namespace=...,pod_ip=...,host_ip=..,node=..., ...} 1
 ```
 
 The metric system can later denormalize those along the identifying labels
-“pod” and “namespace” labels. This leads to...
+“pod” and “namespace” labels.
 
 ## Resource Referencing
 

contributors/devel/sig-instrumentation/migration-to-structured-logging.md

@@ -172,7 +172,7 @@ type KMetadata interface {
 1. Change log functions to structured equivalent
 1. Remove string formatting from log message
 1. Name arguments
-1. Use `klog.KObj` and `klog.KRef` for Kubernetes object references
+1. Use `klog.KObj` and `klog.KRef` for Kubernetes objects references
 1. Verify log output
 
 ## Change log functions to structured equivalent
@@ -211,6 +211,25 @@ the process, you should call `os.Exit()` yourself.
 
 Fatal calls use a default exit code of 255. When migrating, please use an exit code of 1 and include an "ACTION REQUIRED:" release note.
 
+For example
+```go
+func validateFlags(cfg *config.Config, flags *pflag.FlagSet) error {
+	if err := cfg.ReadAndValidate(flags); err != nil {
+		klog.FatalF("Error in reading and validating flags %s", err)
+      os.Exit(1)
+	}
+}
+```
+should be changed to
+```go
+func validateFlags(cfg *config.Config, flags *pflag.FlagSet) error {
+	if err := cfg.ReadAndValidate(flags); err != nil {
+		klog.ErrorS(err, "Error in reading and validating flags")
+      os.Exit(1)
+	}
+}
+```
+
 ## Remove string formatting from log message
 
 With structured logging, log messages are no longer formatted, leaving argument marshalling up to the logging client