examples/features/opentelemetry: demonstrate tracing using OpenTelemetry plugin by janardhanvissa · Pull Request #8056 · grpc/grpc-go

janardhanvissa · 2025-01-30T16:44:57Z

RELEASE NOTES:

examples/features/opentelemetry: modify example to demonstrate tracing using OpenTelemtry plugin.

codecov · 2025-01-30T16:51:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.10%. Comparing base (ce35fd4) to head (ab19f69).
Report is 16 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8056      +/-   ##
==========================================
- Coverage   82.16%   82.10%   -0.06%     
==========================================
  Files         410      412       +2     
  Lines       40248    40491     +243     
==========================================
+ Hits        33068    33244     +176     
- Misses       5830     5881      +51     
- Partials     1350     1366      +16

see 57 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

purnesh42H

@janardhanvissa please use any of the trace exporter from here https://opentelemetry.io/docs/languages/go/exporters/. May be otlptracehttp or stdouttrace are good candidates

Also, please refer to https://opentelemetry.io/docs/languages/go/getting-started/ for writing otel trace exporting parts in client and server. We should try to avoid as much custom code as possible here to make it easy and fast for users to pick up.

vinothkumarr227 · 2025-02-27T07:29:04Z

+//
+// For the OpenTelemetry Collector Core distribution specifically, see
+// https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
+


nit: // Documentation:
// The builder manifests used for official OpenTelemetry Collector binaries
// can be found at the following repository:
// https://github.com/open-telemetry/opentelemetry-collector-releases
//
// For the OpenTelemetry Collector Core distribution specifically, refer to:
// https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol

These docs are for the OpenTelemetry Collector, which we're not using; we're using stdouttrace instead. These things are already removed from the go.mod.

vinothkumarr227 · 2025-02-27T07:32:15Z

 			log.Fatalf("UnaryEcho failed: %v", err)
 		}
 		fmt.Println(r)
+


nit: remove the extra space

vinothkumarr227 · 2025-02-27T07:33:54Z


 func main() {
+	flag.Parse()
+


nit: Remove the extra space and check the other places as well

vinothkumarr227 · 2025-03-27T09:19:19Z

-OpenTelemetry is configured on both the client and the server, and exports to
-the Prometheus exporter. The exporter exposes metrics on the Prometheus ports
-described above.
+OpenTelemetry is configured on both the client and the server, and exports metrics to the Prometheus exporter. The exporter exposes metrics on the Prometheus ports described above. OpenTelemetry also exports traces using the stdouttrace exporter. These traces are printed as structured data to the console output of both the client and the server.


Suggested change

OpenTelemetry is configured on both the client and the server, and exports metrics to the Prometheus exporter. The exporter exposes metrics on the Prometheus ports described above. OpenTelemetry also exports traces using the stdouttrace exporter. These traces are printed as structured data to the console output of both the client and the server.

OpenTelemetry is configured on both the client and the server, and exports metrics to the Prometheus exporter. The exporter exposes metrics on the Prometheus ports described above.

OpenTelemetry exports traces using the stdouttrace exporter, which prints structured trace data to the console output of both the client and server. Each RPC call produces trace information that captures the execution flow and timing of operations.

purnesh42H

@janardhanvissa in README.md, please all sentences to 80 cols.

purnesh42H · 2025-04-01T16:12:30Z


-This example shows how to configure OpenTelemetry on a client and server, and shows
-what type of telemetry data it can produce for certain RPC's.
+This example shows how to configure OpenTelemetry on a client and server, and shows what type of telemetry data it can produce for certain RPC's.


Please restrict the sentences to 80 cols. What is the change here?

reached 80 cols, so moved to the next line.

purnesh42H · 2025-04-01T16:13:46Z


 ## Try it

+This section shows how to configure OpenTelemetry Metrics and Traces.


we can remove this I think. The first sentence is enough

purnesh42H · 2025-04-01T16:14:03Z


+This section shows how to configure OpenTelemetry Metrics and Traces.
+
+**1. Run the gRPC Applications:**


same. No need of this

purnesh42H · 2025-04-01T16:14:09Z

 go run client/main.go
 ```

+**2. View Telemetry Data:**


no need of this

purnesh42H · 2025-04-01T16:15:44Z

-The client continuously makes RPC's to a server. The client and server both
-expose a prometheus exporter to listen and provide metrics. This defaults to
-:9464 for the server and :9465 for the client.
+The client continuously makes RPC's to a server. The client and server both expose a Prometheus exporter to listen and provide metrics. This defaults to :9464 for the server and :9465 for the client. The client and server are also configured to output traces directly to their standard output streams using stdouttrace.


wrap stdouttrace within backticks

purnesh42H · 2025-04-01T16:17:46Z


 func main() {
-	exporter, err := prometheus.New()
+	flag.Parse()


do we need this flag.Parse()? or it can be removed?

purnesh42H · 2025-04-01T16:18:14Z

 	}
-	provider := metric.NewMeterProvider(metric.WithReader(exporter))
-	go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
+	// Initialize MeterProvider with Prometheus exporter.


no need of this comment. Actually there is no change needed here. It can be reverted

purnesh42H · 2025-04-01T16:19:20Z

 	addr               = flag.String("addr", ":50051", "the server address to connect to")
-	prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint")
+	prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint for metrics")
+	serviceName        = "grpc-server"


same. Do we need this? or it can be removed?

we need to set the service name as an attribute in the resource information attached to the traces for the server.

purnesh42H · 2025-04-01T16:19:33Z


 func main() {
-	exporter, err := prometheus.New()
+	flag.Parse()


same. do we need this? or it can be removed?

purnesh42H · 2025-04-01T16:19:55Z

 	}
-	provider := metric.NewMeterProvider(metric.WithReader(exporter))
-	go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
+	// Initialize MeterProvider with Prometheus exporter.


same. No need of any change here. Let it be how it was.

…ent and server

purnesh42H

lgtm

purnesh42H · 2025-04-03T16:11:30Z

 	}
-	provider := metric.NewMeterProvider(metric.WithReader(exporter))
-	go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
+	provider := otelmetric.NewMeterProvider(otelmetric.WithReader(exporter))


nit: one comment above "Configure meter provider for metrics"

purnesh42H · 2025-04-03T16:11:45Z

+	if err != nil {
+		log.Fatalf("Failed to create stdouttrace exporter: %v", err)
+	}
+


nix new line

purnesh42H · 2025-04-03T16:11:53Z

+		log.Fatalf("Failed to create stdouttrace exporter: %v", err)
+	}
+
+	// Configure the tracer provider


can remove this

purnesh42H · 2025-04-03T16:13:33Z

+
+	// Configure the tracer provider
+	tp := sdktrace.NewTracerProvider(sdktrace.WithBatcher(traceExporter), sdktrace.WithResource(otelresource.NewWithAttributes(semconv.SchemaURL, semconv.ServiceName(serviceName))))
+	textMapPropagator := otelpropagation.TraceContext{} // Using W3C Trace Context Propagator.


Suggested change

textMapPropagator := otelpropagation.TraceContext{} // Using W3C Trace Context Propagator.

// Configure W3C Trace Context Propagator for traces

textMapPropagator := otelpropagation.TraceContext{} // Using W3C Trace Context Propagator.

purnesh42H · 2025-04-03T16:13:57Z


-	ctx := context.Background()
-	do := opentelemetry.DialOption(opentelemetry.Options{MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: provider}})
+	// Initialize stdouttrace exporter for traces


replace comment with "Configure exporter for traces"

Suggested change

// Initialize stdouttrace exporter for traces

// Configure exporter for traces

purnesh42H · 2025-04-03T16:24:07Z

@janardhanvissa could you add the screenshots of traces on clients and server please?

janardhanvissa · 2025-04-03T17:42:02Z

@janardhanvissa could you add the screenshots of traces on clients and server please?

Server

Client

dfawley · 2025-04-16T20:21:30Z

@janardhanvissa could you add the screenshots of traces on clients and server please?

For the future, for text output, can we please use a github gist or pastebin instead of screenshots?

dfawley

LGTM except for the comments in this review. Thanks!

dfawley · 2025-04-16T20:24:24Z

-This example demonstrates how to configure OpenTelemetry Tracing on a gRPC client
-and server, showcasing the trace data it produces for RPC interactions.
+This example shows how to configure OpenTelemetry on a client and server, and
+shows what type of telemetry data it can produce for certain RPC's.


Suggested change

shows what type of telemetry data it can produce for certain RPC's.

shows what type of telemetry data it can produce for certain RPCs.

dfawley · 2025-04-16T20:24:34Z

-* **Trace Visualization (Console):** By monitoring the collector's console 
-    output, you can see the flow of RPC calls and analyze the performance of
-    your gRPC services.
+The client continuously makes RPC's to a server. The client and server both


Suggested change

The client continuously makes RPC's to a server. The client and server both

The client continuously makes RPCs to a server. The client and server both

dfawley · 2025-04-16T20:26:15Z

 	addr               = flag.String("addr", ":50051", "the server address to connect to")
-	prometheusEndpoint = flag.String("prometheus_endpoint", ":9465", "the Prometheus exporter endpoint")
+	prometheusEndpoint = flag.String("prometheus_endpoint", ":9465", "the Prometheus exporter endpoint for metrics")
+	serviceName        = "grpc-client"


I'm fine with replacing the one usage of it with a literal. Or make it a const instead of a var otherwise.

dfawley · 2025-04-16T20:26:58Z

-	provider := metric.NewMeterProvider(metric.WithReader(exporter))
-	go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
+	// Configure meter provider for metrics
+	provider := otelmetric.NewMeterProvider(otelmetric.WithReader(exporter))


Now we have a meter provider and a trace provider. Let's name this meterProvider and the other one tracerProvider.

dfawley · 2025-04-16T20:27:38Z

 	addr               = flag.String("addr", ":50051", "the server address to connect to")
-	prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint")
+	prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint for metrics")
+	serviceName        = "grpc-server"


dfawley · 2025-04-16T20:27:43Z

-	provider := metric.NewMeterProvider(metric.WithReader(exporter))
-	go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
+	// Configure meter provider for metrics
+	provider := otelmetric.NewMeterProvider(otelmetric.WithReader(exporter))


janardhanvissa · 2025-04-17T04:54:34Z

@janardhanvissa could you add the screenshots of traces on clients and server please?

For the future, for text output, can we please use a github gist or pastebin instead of screenshots?

Thanks for the suggestion! We'll follow that going forward and use Gist or Pastebin for any text output.

…try plugin (grpc#8056)

janardhankrishna-sai and others added 9 commits December 23, 2024 07:09

replace dial with newclient

7ddbe46

Merge branch 'master' of https://github.com/janardhanvissa/grpc-go

0486355

Merge branch 'grpc:master' into master

53fa9cd

Merge branch 'grpc:master' into master

4435b8a

Merge branch 'grpc:master' into master

a413555

Merge branch 'grpc:master' into master

4e203c3

Merge branch 'grpc:master' into master

e9ad552

adding opentelemetry tracing for client-server

61e15e3

adding opentelemetry tracing for client-server

4a988a6

purnesh42H reviewed Feb 5, 2025

View reviewed changes

Comment thread examples/features/opentelemetry/client/main.go Outdated

Comment thread examples/features/opentelemetry/client/main.go Outdated

Comment thread examples/features/opentelemetry/client/main.go Outdated

Comment thread examples/features/opentelemetry/server/main.go Outdated

purnesh42H assigned janardhanvissa Feb 5, 2025

addressing review comments

58451b6

janardhanvissa force-pushed the tracing-otel branch from f463f2b to 58451b6 Compare February 6, 2025 09:56

janardhankrishna-sai added 9 commits February 6, 2025 10:03

reverting Newclient changes

9ac7ce3

reverting Newclient changes

c0e8885

adding dependency files

0b4231a

removing unused ctx

b8c0ef5

fixing vet issue

a33cc4b

adding trace to client/server

6215e98

fix vet issue

c68e570

fixing vet issue

02d9139

removing empty lines

9db8ad6

purnesh42H assigned purnesh42H and unassigned janardhanvissa Feb 18, 2025

purnesh42H changed the title ~~opentelemetry: add open telemetry trace for client/server~~ examples/features/opentelemetry: Add example to demonstrate OpenTelemetry Tracing Feb 19, 2025

purnesh42H reviewed Feb 19, 2025

View reviewed changes

purnesh42H assigned janardhanvissa and unassigned purnesh42H Feb 19, 2025

janardhanvissa commented Feb 19, 2025

View reviewed changes

Comment thread examples/features/opentelemetry/client/main.go Outdated

janardhanvissa requested a review from purnesh42H March 27, 2025 16:11

vinothkumarr227 reviewed Mar 27, 2025

View reviewed changes

janardhankrishna-sai added 2 commits March 28, 2025 03:16

addressing review comments

881f0e5

fixing vet issue

b129fa0

purnesh42H reviewed Apr 1, 2025

View reviewed changes

janardhankrishna-sai and others added 4 commits April 1, 2025 16:53

updating readme by wraping 80col perline and removing comment for cli…

3855e04

…ent and server

small tweak

7f2636c

small tweak

2e59ff7

Update README.md

56cf9ef

janardhanvissa requested a review from purnesh42H April 1, 2025 17:16

eshitachandwani modified the milestones: 1.72 Release, 1.73 Release Apr 3, 2025

purnesh42H approved these changes Apr 3, 2025

View reviewed changes

purnesh42H requested a review from dfawley April 3, 2025 16:14

purnesh42H assigned dfawley and unassigned janardhanvissa Apr 3, 2025

addressing review comments

b24b2fb

janardhanvissa and others added 2 commits April 4, 2025 11:09

Merge branch 'master' into tracing-otel

85c095b

deps

f5828d3

dfawley approved these changes Apr 16, 2025

View reviewed changes

dfawley assigned janardhanvissa and unassigned dfawley Apr 16, 2025

addressing review comments

ab19f69

purnesh42H merged commit eb4b687 into grpc:master Apr 17, 2025

janardhanvissa added a commit to janardhanvissa/grpc-go that referenced this pull request Apr 23, 2025

examples/features/opentelemetry: demonstrate tracing using OpenTeleme…

a48f868

…try plugin (grpc#8056)

github-actions Bot locked as resolved and limited conversation to collaborators Oct 15, 2025

	OpenTelemetry is configured on both the client and the server, and exports metrics to the Prometheus exporter. The exporter exposes metrics on the Prometheus ports described above. OpenTelemetry also exports traces using the stdouttrace exporter. These traces are printed as structured data to the console output of both the client and the server.
	OpenTelemetry is configured on both the client and the server, and exports metrics to the Prometheus exporter. The exporter exposes metrics on the Prometheus ports described above.
	OpenTelemetry exports traces using the stdouttrace exporter, which prints structured trace data to the console output of both the client and server. Each RPC call produces trace information that captures the execution flow and timing of operations.


		## Try it

		This section shows how to configure OpenTelemetry Metrics and Traces.


		This section shows how to configure OpenTelemetry Metrics and Traces.

		1. Run the gRPC Applications:

	textMapPropagator := otelpropagation.TraceContext{} // Using W3C Trace Context Propagator.
	// Configure W3C Trace Context Propagator for traces
	textMapPropagator := otelpropagation.TraceContext{} // Using W3C Trace Context Propagator.

	// Initialize stdouttrace exporter for traces
	// Configure exporter for traces

	shows what type of telemetry data it can produce for certain RPC's.
	shows what type of telemetry data it can produce for certain RPCs.

	The client continuously makes RPC's to a server. The client and server both
	The client continuously makes RPCs to a server. The client and server both

Uh oh!

Conversation

janardhanvissa commented Jan 30, 2025 • edited by purnesh42H Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

purnesh42H left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

purnesh42H left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

janardhanvissa commented Jan 30, 2025 •

edited by purnesh42H

Loading

codecov Bot commented Jan 30, 2025 •

edited

Loading