feat(internal/trace): add OpenTelemetry support #8655

quartzmo · 2023-10-06T21:40:07Z

Add GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING env var for opt-in OpenTelemetry tracing.

OpenCensus sunsetting and OpenTelemetry support

The OpenCensus project is obsolete and was archived on July 31st, 2023. This means that any security vulnerabilities that are found will not be patched. We recommend that you begin migrating to OpenCensus tracing to OpenTelemetry, the successor project.

One year after the Google Cloud Go client libraries release the experimental, opt-in OpenTelemetry tracing support in this PR (mid-Q4 2023), the prior experimental OpenCensus tracing will be removed.

Using the OpenTelemetry-Go - OpenCensus Bridge, you can immediately begin exporting your traces with OpenTelemetry, even while dependencies remain instrumented with OpenCensus. If you do not use the bridge, you will need to migrate your entire application and all of its instrumented dependencies at once. For simple applications, this may be possible, but we expect the bridge to be helpful if multiple libraries with instrumentation are used.

Please refer to the following resources:

Testing support for library maintainers

PTAL at internal/testutil/trace_otel.go and the update to trace_test.go. I wasn't able to match the existing testutil api perfectly, so testing support for OpenTelemetry will not be completely transparent. However, the new testutil functions are very close:

OpenCensus

te := testutil.NewTestExporter()
defer te.Unregister()
...
spans := te.Spans

OpenTelemetry

ctx := context.Background()
te := testutil.NewOpenTelemetryTestExporter()
defer te.Unregister(ctx)
...
spans := te.Spans()

Add GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING env var flag for opt-in OpenTelemetry tracing. refs: googleapis#2205

internal/trace/trace.go

internal/trace/trace_test.go

internal/trace/trace.go

codyoss · 2023-11-06T22:55:36Z

internal/trace/trace.go

@@ -53,6 +113,18 @@ func toStatus(err error) trace.Status {
 	}
 }

+// toOpenTelemetryStatus converts an error to an equivalent OpenTelemetry status description.
+func toOpenTelemetryStatusDescription(err error) string {
+	var err2 *googleapi.Error


Should this just be an APIError now? Everything should return those now, right? Same with the above toStatus stuff

I'll look into this, thanks!

I think this logic in bigtable shows a situation where the err closing the span could be an unwrapped Status or even a io.EOF:

https://github.com/googleapis/google-cloud-go/blob/bigtable/v1.20.0/bigtable/bigtable.go#L182-L215

sure, but I just meant L117 here. Other cases can still be left.

ah sorry, i misunderstood

After trying this, I think it's best to just extract the googleapi.Error (if found), since it exposes the HTTP error message. With APIError, that message is only exposed by Error() but it gets some added prefix:

trace_test.go:131: got googleapi: Error 400: INVALID ARGUMENT, want INVALID ARGUMENT

I think that would be fine to call Error and all HTTP APIError *should have wrap a googleapis.Error. But I am fine with this for now. We can always make that change later.

internal/trace/trace.go

internal/trace/trace_test.go

bhshkh · 2023-11-07T21:41:18Z

Sorry, marked as draft by mistake

quartzmo · 2023-11-10T19:00:39Z

I tested this manually using only an OpenTelemetry exporter and the cloud.google.com/go/storage client, and observed the storage span in Cloud Trace console when GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING=opentelemetry.

/cc @cjcotter

refs: googleapis/google-api-go-client#2127 refs: googleapis#8655

refs: googleapis/google-api-go-client#2127 refs: #8655

* Change default for GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING env var flag to OpenTelemetry. * See https://github.com/googleapis/google-cloud-go/blob/main/debug.md\#telemetry refs: googleapis#2205 refs: googleapis#8655

* Change default for `GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING` env var flag to OpenTelemetry. * See https://togithub.com/googleapis/google-cloud-go/blob/main/debug.md\#telemetry refs: #2205 refs: #8655

product-auto-label bot added the size: s Pull request size is small. label Oct 6, 2023

quartzmo force-pushed the trace-otel branch from f1004e7 to 1b7d79b Compare October 23, 2023 22:38

product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Oct 23, 2023

quartzmo force-pushed the trace-otel branch from 1b7d79b to 63ba456 Compare October 24, 2023 23:32

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Oct 24, 2023

quartzmo force-pushed the trace-otel branch from 63ba456 to fafd62e Compare October 26, 2023 21:56

feat(internal/trace): add OpenTelemetry support

4cef291

Add GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING env var flag for opt-in OpenTelemetry tracing. refs: googleapis#2205

quartzmo force-pushed the trace-otel branch from fafd62e to 4cef291 Compare October 27, 2023 21:50

quartzmo marked this pull request as ready for review October 27, 2023 22:11

quartzmo requested a review from a team as a code owner October 27, 2023 22:11

go mod tidy

a66581c

shollyman reviewed Oct 27, 2023

View reviewed changes

internal/trace/trace.go Show resolved Hide resolved

alvarowolfx reviewed Oct 30, 2023

View reviewed changes

internal/trace/trace_test.go Show resolved Hide resolved

quartzmo added 2 commits October 30, 2023 16:26

fix loading of env var

f3ec6f9

Merge branch 'main' into trace-otel

377e01e

alvarowolfx mentioned this pull request Oct 30, 2023

test(bigquery): OpenTelemetry tracing support #8941

Closed

quartzmo added 4 commits November 2, 2023 11:01

Merge branch 'main' into trace-otel

b557636

fix tests

3e86c4e

update docs

df3bf45

add internal/testutil/trace_otel.go

7e634e4

quartzmo force-pushed the trace-otel branch from 575bac1 to 7e634e4 Compare November 3, 2023 22:52

product-auto-label bot added the stale: old Pull request is old and needs attention. label Nov 6, 2023

Merge branch 'main' into trace-otel

1c8f42e

shollyman reviewed Nov 6, 2023

View reviewed changes

internal/trace/trace_test.go Outdated Show resolved Hide resolved

quartzmo added 2 commits November 6, 2023 13:50

add openTelemetryTracingEnabled pkg var

c04a801

fix test fixture name

f98c2e5

codyoss reviewed Nov 6, 2023

View reviewed changes

change tracer name and move attributes sort to test

68cea9a

quartzmo removed the stale: old Pull request is old and needs attention. label Nov 7, 2023

bhshkh marked this pull request as draft November 7, 2023 21:39

bhshkh marked this pull request as ready for review November 7, 2023 21:40

product-auto-label bot added the stale: old Pull request is old and needs attention. label Nov 8, 2023

codyoss approved these changes Nov 10, 2023

View reviewed changes

quartzmo added 2 commits November 10, 2023 10:37

use APIError in TestToOpenTelemetryStatusDescription

541e0ee

Merge branch 'main' into trace-otel

d0d3438

quartzmo merged commit 7a46b54 into googleapis:main Nov 10, 2023
9 checks passed

quartzmo deleted the trace-otel branch November 10, 2023 19:01

release-please bot mentioned this pull request Nov 10, 2023

chore(main): release 0.111.0 #8960

Merged

quartzmo added a commit to quartzmo/google-cloud-go that referenced this pull request Dec 4, 2023

docs(main): add telemetry discussion to debug.md

855d631

refs: googleapis/google-api-go-client#2127 refs: googleapis#8655

quartzmo mentioned this pull request Dec 4, 2023

docs(main): add telemetry discussion to debug.md #9074

Merged

quartzmo added a commit that referenced this pull request Jan 11, 2024

docs(main): add telemetry discussion to debug.md (#9074)

90ed12e

refs: googleapis/google-api-go-client#2127 refs: #8655

release-please bot mentioned this pull request Jan 11, 2024

chore(main): release 0.112.0 #9243

Merged

quartzmo mentioned this pull request May 30, 2024

feat(internal/trace): deprecate OpenCensus support #10287

Merged

GusPrice mentioned this pull request May 30, 2024

pubsub: Many instances of "The StreamingPull stream closed for an expected reason and should be recreated ..." #9788

Closed

release-please bot mentioned this pull request May 31, 2024

chore(main): release 0.115.0 #10291

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(internal/trace): add OpenTelemetry support #8655

feat(internal/trace): add OpenTelemetry support #8655

quartzmo commented Oct 6, 2023 •

edited

Loading

codyoss Nov 6, 2023

quartzmo Nov 7, 2023

quartzmo Nov 8, 2023

codyoss Nov 9, 2023

quartzmo Nov 9, 2023

quartzmo Nov 9, 2023

codyoss Nov 10, 2023

bhshkh commented Nov 7, 2023

quartzmo commented Nov 10, 2023

feat(internal/trace): add OpenTelemetry support #8655

feat(internal/trace): add OpenTelemetry support #8655

Conversation

quartzmo commented Oct 6, 2023 • edited Loading

OpenCensus sunsetting and OpenTelemetry support

Testing support for library maintainers

OpenCensus

OpenTelemetry

codyoss Nov 6, 2023

Choose a reason for hiding this comment

quartzmo Nov 7, 2023

Choose a reason for hiding this comment

quartzmo Nov 8, 2023

Choose a reason for hiding this comment

codyoss Nov 9, 2023

Choose a reason for hiding this comment

quartzmo Nov 9, 2023

Choose a reason for hiding this comment

quartzmo Nov 9, 2023

Choose a reason for hiding this comment

codyoss Nov 10, 2023

Choose a reason for hiding this comment

bhshkh commented Nov 7, 2023

quartzmo commented Nov 10, 2023

quartzmo commented Oct 6, 2023 •

edited

Loading