Responded to Easwar's comments

Author: zasweq

examples/features/csm_observability/README.md

@@ -1,10 +1,12 @@
 # CSM Observability
 
-This examples shows how to configure CSM Observability for a binary, and shows
-what type of telemetry data it can produce for certain RPC's with additional CSM
-Labels. The Client accepts configuration from an xDS Control plane as the
-default address that it connects to is "xds:///helloworld:50051", but this can
-be overridden with the command line flag --addr.
+This examples shows how to configure CSM Observability for gRPC client and
+server applications (configured once per binary), and shows what type of
+telemetry data it can produce for certain RPCs with additional CSM Labels. The
+gRPC Client accepts configuration from an xDS Control plane as the default
+address that it connects to is "xds:///helloworld:50051", but this can be
+overridden with the command line flag --server_addr. This can be plugged into
+the steps outlined in the CSM Observability User Guide.
 
 ## Try it (locally if overwritten xDS Address)
 
@@ -17,6 +19,7 @@ go run client/main.go
 ```
 
 ```
+Curl to the port where Prometheus exporter is outputting metrics data:
 curl localhost:9464/metrics
 ```
 

examples/features/csm_observability/client/main.go

@@ -39,22 +39,19 @@ import (
 )
 
 var (
-	addr     = flag.String("addr", "xds:///helloworld:50051", "the server address to connect to")
-	promAddr = flag.String("promAddr", ":9464", "the Prometheus exporter endpoint")
+	addr     = flag.String("server_addr", "xds:///helloworld:50051", "the server address to connect to")
+	promAddr = flag.String("prom_addr", ":9464", "the Prometheus exporter endpoint")
 )
 
 func main() {
 	exporter, err := prometheus.New()
 	if err != nil {
 		log.Fatalf("Failed to start prometheus exporter: %v", err)
 	}
-	provider := metric.NewMeterProvider(
-		metric.WithReader(exporter),
-	)
+	provider := metric.NewMeterProvider(metric.WithReader(exporter))
 	go http.ListenAndServe(*promAddr, promhttp.Handler())
 
-	ctx := context.Background()
-	cleanup := csm.EnableObservability(ctx, opentelemetry.Options{MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: provider}})
+	cleanup := csm.EnableObservability(context.Background(), opentelemetry.Options{MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: provider}})
 	defer cleanup()
 
 	cc, err := grpc.NewClient(*addr, grpc.WithTransportCredentials(insecure.NewCredentials()))
@@ -67,11 +64,13 @@ func main() {
 	// Make a RPC every second. This should trigger telemetry to be emitted from
 	// the client and the server.
 	for {
+		ctx, cancel := context.WithTimeout(context.Background(), time.Second)
 		r, err := c.UnaryEcho(ctx, &echo.EchoRequest{Message: "this is examples/opentelemetry"})
 		if err != nil {
 			log.Fatalf("UnaryEcho failed: %v", err)
 		}
 		fmt.Println(r)
 		time.Sleep(time.Second)
+		cancel()
 	}
 }

examples/features/csm_observability/server/main.go

@@ -37,8 +37,8 @@ import (
 )
 
 var (
-	addr     = flag.String("addr", ":50051", "the server address to connect to")
-	promAddr = flag.String("promAddr", ":9464", "the Prometheus exporter endpoint")
+	addr     = flag.String("server_addr", ":50051", "the server address to connect to")
+	promAddr = flag.String("prom_addr", ":9464", "the Prometheus exporter endpoint")
 )
 
 type echoServer struct {
@@ -55,26 +55,22 @@ func main() {
 	if err != nil {
 		log.Fatalf("Failed to start prometheus exporter: %v", err)
 	}
-	provider := metric.NewMeterProvider(
-		metric.WithReader(exporter),
-	)
+	provider := metric.NewMeterProvider(metric.WithReader(exporter))
 	go http.ListenAndServe(*promAddr, promhttp.Handler())
 
 	cleanup := csm.EnableObservability(context.Background(), opentelemetry.Options{MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: provider}})
 	defer cleanup()
 
 	lis, err := net.Listen("tcp", *addr)
 	if err != nil {
-		log.Fatalf("failed to listen: %v", err)
+		log.Fatalf("Failed to listen: %v", err)
 	}
 	s := grpc.NewServer()
-	pb.RegisterEchoServer(s, &echoServer{
-		addr: *addr,
-	})
+	pb.RegisterEchoServer(s, &echoServer{addr: *addr})
 
-	log.Printf("serving on %s\n", *addr)
+	log.Printf("Serving on %s\n", *addr)
 
 	if err := s.Serve(lis); err != nil {
-		log.Fatalf("failed to serve: %v", err)
+		log.Fatalf("Failed to serve: %v", err)
 	}
 }