stats/opentelemetry: Introduce Tracing API #7852

aranjans · 2024-11-18T05:20:32Z

This pull request adds the OpenTelemetry tracing API to the grpc-go opentelemetry plugin as outlined in proposal A72.

RELEASE NOTES:

stats/opentelemetry: Introduces an experimental API for enabling and configuring OpenTelemetry tracing within gRPC-go opentelemetry plugin under stats/opentelemetry/experimental. This includes the addition of TraceOptions in the Options struct to allow users to specify the TraceProvider and TextMapPropagator.

codecov · 2024-11-18T05:25:38Z

Codecov Report

Attention: Patch coverage is 88.97059% with 15 lines in your changes missing coverage. Please review.

Project coverage is 82.25%. Comparing base (56a14ba) to head (374b933).
Report is 46 commits behind head on master.

Files with missing lines	Patch %	Lines
stats/opentelemetry/trace.go	83.33%	7 Missing and 1 partial ⚠️
stats/opentelemetry/client_tracing.go	76.47%	3 Missing and 1 partial ⚠️
stats/opentelemetry/opentelemetry.go	62.50%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7852      +/-   ##
==========================================
+ Coverage   82.09%   82.25%   +0.16%     
==========================================
  Files         379      387       +8     
  Lines       38261    39041     +780     
==========================================
+ Hits        31409    32114     +705     
- Misses       5549     5595      +46     
- Partials     1303     1332      +29

Files with missing lines	Coverage Δ
stats/opentelemetry/client_metrics.go	`89.39% <100.00%> (+1.46%)`	⬆️
stats/opentelemetry/server_metrics.go	`89.82% <100.00%> (+0.44%)`	⬆️
stats/opentelemetry/server_tracing.go	`100.00% <100.00%> (ø)`
stats/opentelemetry/opentelemetry.go	`75.00% <62.50%> (-0.87%)`	⬇️
stats/opentelemetry/client_tracing.go	`76.47% <76.47%> (ø)`
stats/opentelemetry/trace.go	`83.33% <83.33%> (ø)`

... and 59 files with indirect coverage changes

examples/features/opentelemetry/client/main.go

gcp/observability/go.mod

clientconn.go

interop/xds/go.sum

stats/opentelemetry/client_metrics.go

stats/opentelemetry/trace.go

stats/opentelemetry/opentelemetry.go

purnesh42H · 2024-11-20T05:24:21Z

@aranjans please update this with latest main branch to get rid of all go.mod and go.sum changes

aranjans · 2024-11-22T01:18:19Z

@purnesh42H Thanks for your review, I have addressed all your comments and this PR is ready for another pass.

purnesh42H

Some more non-test comments. Will review tests in next pass

clientconn.go

stats/handlers.go

stats/opentelemetry/client_metrics.go

stream.go

stats/opentelemetry/client_metrics.go

purnesh42H

Some more non-test comments. Will review tests in next pass

purnesh42H · 2024-11-22T05:36:44Z

@aranjans you should link the gRFC and concise your description

aranjans · 2024-11-23T16:05:05Z

@purnesh42H I have addressed all the comments, and updated the description to link the grfc proposal.
Feel free to close the thread which are resolved now.

stats/opentelemetry/client_metrics.go

stats/opentelemetry/opentelemetry.go

stats/opentelemetry/server_metrics.go

stats/opentelemetry/trace.go

aranjans · 2024-11-30T18:32:36Z

@purnesh42H I have addressed all your comments, and updated the PR. Kindly review the PR.

dfawley

Just a few more small things otherwise LGTM

experimental/opentelemetry/trace_options.go

stats/opentelemetry/client_tracing.go

stats/opentelemetry/opentelemetry.go

stats/opentelemetry/server_tracing.go

experimental/opentelemetry/trace_options.go

dfawley · 2025-01-23T18:27:53Z

stats/opentelemetry/trace.go

+	case *stats.End:
+		if rs.Error != nil {
+			s := status.Convert(rs.Error)
+			span.SetStatus(otelcodes.Error, s.Message())


It seems there is missing coverage for this (RPC error) and PickerUpdated - could you add test cases for them, please?

@dfawley I have added the test for rpc error, PTAL.

dfawley · 2025-01-24T21:00:22Z

stats/opentelemetry/client_metrics.go

@@ -87,6 +88,12 @@ func (h *clientStatsHandler) unaryInterceptor(ctx context.Context, method string
 		}
 	}

+	// Log an error if one of the options is missing.
+	if (h.options.TraceOptions.TextMapPropagator == nil) != (h.options.TraceOptions.TracerProvider == nil) {


This check should happen in the constructor for the otel plugin. Not on every RPC.

stats/opentelemetry/client_metrics.go

stats/opentelemetry/e2e_test.go

purnesh42H · 2025-01-28T08:17:50Z

stats/opentelemetry/opentelemetry.go

 )

 func init() {
 	otelinternal.SetPluginOption = func(o *Options, po otelinternal.PluginOption) {
 		o.MetricsOptions.pluginOption = po
+		// Log an error if one of the options is missing.
+		if (o.TraceOptions.TextMapPropagator == nil) != (o.TraceOptions.TracerProvider == nil) {
+			logger.Error("traceOptions are not set properly: one of TextMapPropagator or TracerProvider is missing.")


@aranjans How about "Tracing will not be recorded because traceOptions are not set properly: one of TextMapPropagator or TracerProvider is missing"? Also, may be it should be warning instead of error because we are only treating it as no-op for tracing but continuing with setup? @dfawley cc

aranjans added this to the 1.69 Release milestone Nov 18, 2024

aranjans added Type: Feature New features or improvements in behavior Area: Observability Includes Stats, Tracing, Channelz, Healthz, Binlog, Reflection, Admin, GCP Observability labels Nov 18, 2024

aranjans requested a review from purnesh42H November 18, 2024 08:22

purnesh42H self-assigned this Nov 19, 2024

purnesh42H reviewed Nov 20, 2024

View reviewed changes

purnesh42H assigned aranjans and unassigned purnesh42H Nov 20, 2024

aranjans force-pushed the a72 branch 3 times, most recently from 378ddd3 to 8cb8222 Compare November 21, 2024 17:44

aranjans assigned purnesh42H and unassigned aranjans Nov 22, 2024

purnesh42H reviewed Nov 22, 2024

View reviewed changes

purnesh42H assigned aranjans and unassigned purnesh42H Nov 22, 2024

purnesh42H changed the title ~~Implement A72: OpenTelemetry Tracing~~ stats/opentelemetry: Introduce Tracing API Nov 22, 2024

aranjans assigned purnesh42H and unassigned aranjans Nov 23, 2024

purnesh42H reviewed Nov 25, 2024

View reviewed changes

purnesh42H assigned aranjans and unassigned purnesh42H Nov 25, 2024

aranjans force-pushed the a72 branch from f50a6b9 to ce57921 Compare November 30, 2024 18:29

aranjans added 2 commits January 21, 2025 21:56

return noop interceptor if traceoptions are not defined properly

8e15369

make vet happy

d5913b6

arjan-bal modified the milestones: 1.70 Release, 1.71 Release Jan 22, 2025

purnesh42H assigned dfawley and unassigned dfawley and purnesh42H Jan 23, 2025

dfawley reviewed Jan 23, 2025

View reviewed changes

dfawley assigned aranjans and unassigned dfawley Jan 23, 2025

fix nits

afbf947

dfawley reviewed Jan 24, 2025

View reviewed changes

aranjans added 2 commits January 28, 2025 12:06

add test for rpc error

2fc523f

make vet happy

c1569fc

purnesh42H reviewed Jan 28, 2025

View reviewed changes

stats/opentelemetry/client_metrics.go Outdated Show resolved Hide resolved

purnesh42H reviewed Jan 28, 2025

View reviewed changes

address purnesh comments

374b933

aranjans assigned purnesh42H and dfawley and unassigned aranjans Jan 28, 2025

purnesh42H removed their assignment Jan 29, 2025

purnesh42H requested a review from dfawley January 29, 2025 03:52

dfawley approved these changes Jan 30, 2025

View reviewed changes

dfawley assigned purnesh42H and unassigned dfawley Jan 30, 2025

purnesh42H merged commit 78eebff into grpc:master Jan 30, 2025
14 of 15 checks passed

arjan-bal mentioned this pull request Jan 30, 2025

Flaky Test: MetricsAndTracesOptionEnabled #8053

Open

janardhanvissa pushed a commit to janardhanvissa/grpc-go that referenced this pull request Feb 13, 2025

stats/opentelemetry: Introduce Tracing API (grpc#7852)

5c4fa57

janardhanvissa pushed a commit to janardhanvissa/grpc-go that referenced this pull request Feb 13, 2025

stats/opentelemetry: Introduce Tracing API (grpc#7852)

03a8433

janardhanvissa pushed a commit to janardhanvissa/grpc-go that referenced this pull request Feb 15, 2025

stats/opentelemetry: Introduce Tracing API (grpc#7852)

35a0329

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

stats/opentelemetry: Introduce Tracing API #7852

stats/opentelemetry: Introduce Tracing API #7852

aranjans commented Nov 18, 2024 •

edited

Loading

codecov bot commented Nov 18, 2024 •

edited

Loading

purnesh42H commented Nov 20, 2024

aranjans commented Nov 22, 2024

purnesh42H left a comment

purnesh42H left a comment

purnesh42H commented Nov 22, 2024

aranjans commented Nov 23, 2024 •

edited

Loading

aranjans commented Nov 30, 2024

dfawley left a comment

dfawley Jan 23, 2025

aranjans Jan 28, 2025

dfawley Jan 24, 2025

purnesh42H Jan 28, 2025 •

edited

Loading

stats/opentelemetry: Introduce Tracing API #7852

stats/opentelemetry: Introduce Tracing API #7852

Conversation

aranjans commented Nov 18, 2024 • edited Loading

codecov bot commented Nov 18, 2024 • edited Loading

Codecov Report

purnesh42H commented Nov 20, 2024

aranjans commented Nov 22, 2024

purnesh42H left a comment

Choose a reason for hiding this comment

purnesh42H left a comment

Choose a reason for hiding this comment

purnesh42H commented Nov 22, 2024

aranjans commented Nov 23, 2024 • edited Loading

aranjans commented Nov 30, 2024

dfawley left a comment

Choose a reason for hiding this comment

dfawley Jan 23, 2025

Choose a reason for hiding this comment

aranjans Jan 28, 2025

Choose a reason for hiding this comment

dfawley Jan 24, 2025

Choose a reason for hiding this comment

purnesh42H Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

aranjans commented Nov 18, 2024 •

edited

Loading

codecov bot commented Nov 18, 2024 •

edited

Loading

aranjans commented Nov 23, 2024 •

edited

Loading

purnesh42H Jan 28, 2025 •

edited

Loading