feat(otel): Add native OpenTelemetry Transport module #3938

merchantmoh-debug · 2026-01-24T02:44:28Z

Adds a new optional module github.com/google/go-github/v81/otel which provides an http.RoundTripper instrumented with OpenTelemetry.

Features

Automatic Tracing: Every API call gets a semantic span (e.g., github/GET).
Rate Limit Observability: Parses GitHub headers (X-RateLimit-*) and records them as Span Attributes (github.rate_limit.remaining, github.rate_limit.reset).
Support Tracing: Records X-Github-Request-Id for easy debugging with GitHub Support.

Verification

Validated with otel/example app against the live API.
Dependencies are isolated in a nested module to avoid bloating core go-github.

merchantmoh-debug · 2026-01-24T02:45:37Z

@gmlewis - Surprise!

Haha. Please review.

gmlewis · 2026-01-24T02:51:47Z

@merchantmoh-debug - I'm starting to think I'm talking to a bot.
This is a duplicate of #3916 and the description and subject are wrong.

merchantmoh-debug · 2026-01-24T02:54:01Z

@gmlewis - Yeah. My bad. It's on my local disk set up. I use antigravity heavily. It likely made an error.

I'll fix it.

merchantmoh-debug · 2026-01-25T04:16:33Z

@merchantmoh-debug - I'm starting to think I'm talking to a bot. This is a duplicate of #3916 and the description and subject are wrong.

A bot that codes 3x performance boosts to stringify?

Can I get access to that bot please?

gmlewis · 2026-01-28T01:27:23Z

@merchantmoh-debug - are you planning on updating this PR as requested, or shall we close it since the PR title and description have nothing to do with the changes that have been made?

merchantmoh-debug · 2026-01-28T03:35:21Z

@gmlewis - Fixed.

merchantmoh-debug · 2026-01-28T04:13:15Z

@gmlewis - Branch scrubbed and clean. This completes the modernization trilogy (Perf #3914, Iterators #3916, OTEL #3938).

Let's go 3 for 3.

alexandear

Please fix lint issues: ./script/lint.sh.

otel/example/main.go

otel/transport.go

merchantmoh-debug · 2026-01-28T16:57:49Z

Thanks for the review @alexandear @gmlewis I've addressed all your feedback in the latest push:

Directory Structure: Moved otel/example to example/otel to align with repo conventions.

Standards: Added missing Copyright headers (2026) and updated the instrumentationName to v82.

Code Design: Exported HeaderRateReset in github/github.go

and updated transport.go to use this constant instead of the hardcoded string.

Maintenance: Added a sentinel // NOTE comment above instrumentationName to flag it for manual updates during release cycles.

Linting: Ran go mod tidy in both the root and example directories to resolve the go.sum validation errors.

Requesting review @gmlewis @alexandear

gmlewis

I think we can completely remove otel/example/* since the example now lives in example/otel.
Please fix the linting and test errors (see CONTRIBUTING.md) and push the changes before we can fully review this PR.

gmlewis · 2026-01-28T18:29:37Z

@merchantmoh-debug - you just force-pushed over 1000 files.

merchantmoh-debug · 2026-01-28T18:38:01Z

@gmlewis - Lmao. Antigravity is finicky. My bad. It's still a google labs product.... hahaha - I'm laughing my head off right now. "Over 1000" omg what did it push? my entire library? lmao.

I'll reverse it --- If the lint doesn't fix I might need your help figuring it out.

gmlewis

@merchantmoh-debug - please remove the "go" folder.

I really wish you would review your PRs using the GitHub user interface before requesting code reviews as this is truly a waste of my time and patience.

alexandear · 2026-01-28T18:46:18Z

@gmlewis - Lmao. Antigravity is finicky. My bad. It's still a google labs product.... hahaha.

Hey @merchantmoh-debug, could you manually edit and push changes by using git? (Here's a handly cheat sheet if you need it.) No pressure to use coding agents - totally up to you!

I'll reverse it --- If the lint doesn't fix I might need your help figuring it out.

No worries! You can fix lint issues easily by running ./lint/script.sh locally, checking the output, and applying any suggested changes. You can also refer to the Golangci-lint docs for more details.

merchantmoh-debug · 2026-01-28T18:48:03Z

@gmlewis - Well seeing as I'm both using my time & patience to give google free upgrades to its library - - We both lose time when things to go right now don't we?

Yeah - once more; I'm still learning the ropes. Ever taught at a school? You don't get far with impatience & frustration. You have to be patient. Don't be fooled by the competence of my coding and assume I know what I'm doing fully. I don't.

I'm a unicorn - you'll have to delete any patterns you have on what's "normal" when dealing with me. I'm High-IQ Autistic, Non-Automatic TOMS < (I bet you can tell) > ADHD > OCD > OCPD.

I see the world in systems and logic. It makes me amazingly good at learning extremely complex things extremely quickly. But it often leads me to learn something like "How to be a badass coder" before I ever learn "How to navigate Githubs user-interface"

And I like to trial & error my way through problems - try, review, try, review - I WOULD do this automatically but the tests are set to only happen when you review. Forcing a human-in-the-loop situation where you get frustrated when I make an oppsie which will NOT stop happening right away.

It's the trade off of the neurodivergent my friend - super-smart but super-hard to deal with.

And me? I'm actually pretty good to deal with in comparison. 🤷‍♂️

merchantmoh-debug · 2026-01-28T18:49:56Z

@gmlewis - Lmao. Antigravity is finicky. My bad. It's still a google labs product.... hahaha.

Hey @merchantmoh-debug, could you manually edit and push changes by using git? (Here's a handly cheat sheet if you need it.) No pressure to use coding agents - totally up to you!

I'll reverse it --- If the lint doesn't fix I might need your help figuring it out.

No worries! You can fix lint issues easily by running ./lint/script.sh locally, checking the output, and applying any suggested changes. You can also refer to the Golangci-lint docs for more details.

@alexandear - Thanks! I appreciate the guidance!

Yeah of course! No problem! I'll manually edit them! You're awesome.

merchantmoh-debug · 2026-01-28T19:47:07Z

@alexandear - Thanks for the cheat sheet & the other link.

Huge help. Saves a lot of your guys time now that I can do the testing myself.

I'll update soon.

merchantmoh-debug · 2026-01-31T19:18:33Z

@gmlewis @alexandear - I'm testing it extensively -- yet for some reason it keeps failing the github workflow even though it passes the local one.

Weird.

To decompress I made this song for us - https://www.youtube.com/watch?v=AL175r0MQ4E

Any ideas where we're going wrong?

otel/transport.go

gmlewis · 2026-01-31T20:49:16Z

Any ideas where we're going wrong?

Yes, the copyright message wasn't exactly identical to other files and go fmt was not run on one of the files.
I'm trying to correct those issues now. Please stand by.

gmlewis

OK, great... we are almost there.
Now we need a new file called "otel/transport_test.go" that will provide excellent code coverage over its corresponding "otel/transport.go" file and then we should hopefully be ready for a final review.

You will need to "git pull" the changes I made to your current branch to get the copyright and formatting changes locally so that you can continue.

alexandear · 2026-02-01T12:50:35Z

example/otel/main.go

+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// This example demonstrates ...


Unfinished sentence. What this package demonstrates? 🙃

Run `go mod tidy` in `example/otel` and `otel` to resolve linting and testing failures. This updates `go.opentelemetry.io/otel/sdk` from v1.24.0 to v1.27.0 in the example module, aligning it with the core `otel` module and resolving the "context loading failed" error in `script/lint.sh`. Co-authored-by: merchantmoh-debug <241568449+merchantmoh-debug@users.noreply.github.com>

…427587979539721511 fix(otel): synchronize dependencies in example/otel

merchantmoh-debug · 2026-02-02T04:09:02Z

@gmlewis - Give it a go bro. Should pass the lint now.

alexandear · 2026-02-02T11:32:45Z

example/otel/main.go

+		),
+	}
+
+	// Create GitHub client


This comment is not needed. It's clear that github.NewClient creates a GitHub client

alexandear · 2026-02-02T11:34:02Z

github/github.go

+	HeaderRateReset     = "X-Ratelimit-Reset"
+	HeaderRateResource  = "X-Ratelimit-Resource"


Exported constants should be moved above

Above, but below the Version.

alexandear · 2026-02-02T11:34:40Z

otel/transport.go

+			span.SetAttributes(attribute.Int("github.rate_limit.limit", v))
+		}
+	}
+	if remaining := resp.Header.Get("X-Ratelimit-Remaining"); remaining != "" {


This should use a constant from the github package.

merchantmoh-debug · 2026-02-02T17:15:35Z

@alexandear - On it.

- Export and group rate limit header constants in `github/github.go`. - Update `otel/transport.go` to use exported constants instead of string literals. - Remove redundant comment in `example/otel/main.go`. - Fix module version mismatch in `otel` and `example/otel` to match `v81` and align OpenTelemetry dependency versions. - Ensure all tests pass. Co-authored-by: merchantmoh-debug <241568449+merchantmoh-debug@users.noreply.github.com>

…back-15903149166570935690

…ack-15903149166570935690 Apply code review feedback for OpenTelemetry support

alexandear · 2026-02-02T17:50:39Z

otel/transport.go

+
+const (
+	// instrumentationName is the name of this instrumentation package.
+	// NOTE: This must be updated when the major version of go-github changes.


this is no longer needed?

alexandear · 2026-02-02T17:52:00Z

otel/transport.go

+	if reset := resp.Header.Get(github.HeaderRateReset); reset != "" {
+		span.SetAttributes(attribute.String("github.rate_limit.reset", reset))
+	}
+	if reqID := resp.Header.Get("X-Github-Request-Id"); reqID != "" {


We can create a constant for the "X-Github-Request-Id" string in the github package.

@gmlewis what do you think?

alexandear · 2026-02-02T17:53:55Z

github/github.go

+	HeaderRateReset     = "X-Ratelimit-Reset"
+	HeaderRateResource  = "X-Ratelimit-Resource"


Above, but below the Version.

alexandear · 2026-02-02T17:54:51Z

github/github.go

-	// Primary rate limit exceeded: GitHub returns 403 or 429 with X-RateLimit-Remaining: 0
-	// See: https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api
-	case (r.StatusCode == http.StatusForbidden || r.StatusCode == http.StatusTooManyRequests) &&


This should not be removed.

otel/go.mod

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

merchantmoh-debug · 2026-02-02T18:34:14Z

@gmlewis - I'll update in about 30 minutes. It'll pass the lint & ubuntu -- I'll ping you to request a review when it's done. Then we can knock this one out today as well (hopefully)

merchantmoh-debug and others added 2 commits January 23, 2026 19:29

perf: Optimize Stringify allocations (~2x faster)

79b16b0

Apply suggestions from code review

9e260bd

merchantmoh-debug force-pushed the feat/opentelemetry-support branch from 1d9b307 to 4536640 Compare January 24, 2026 03:00

gmlewis added the DO NOT MERGE Do not merge this PR. label Jan 26, 2026

merchantmoh-debug force-pushed the feat/opentelemetry-support branch from 42cbea7 to 0b0ca7c Compare January 28, 2026 03:33

merchantmoh-debug force-pushed the feat/opentelemetry-support branch from 0b0ca7c to 19330d6 Compare January 28, 2026 03:52

alexandear suggested changes Jan 28, 2026

View reviewed changes

otel/example/main.go Show resolved Hide resolved

otel/example/main.go Show resolved Hide resolved

otel/transport.go Outdated Show resolved Hide resolved

otel/transport.go Outdated Show resolved Hide resolved

gmlewis added NeedsReview PR is awaiting a review before merging. and removed DO NOT MERGE Do not merge this PR. labels Jan 28, 2026

merchantmoh-debug force-pushed the feat/opentelemetry-support branch from 19330d6 to c786a38 Compare January 28, 2026 16:49

merchantmoh-debug requested a review from alexandear January 28, 2026 16:57

gmlewis requested changes Jan 28, 2026

View reviewed changes

merchantmoh-debug force-pushed the feat/opentelemetry-support branch from c786a38 to 9ea671d Compare January 28, 2026 18:18

merchantmoh-debug requested a review from gmlewis January 28, 2026 18:35

gmlewis requested changes Jan 28, 2026

View reviewed changes

merchantmoh-debug force-pushed the feat/opentelemetry-support branch from 9ea671d to 03b05e6 Compare January 28, 2026 19:01

gmlewis reviewed Jan 31, 2026

View reviewed changes

otel/transport.go Show resolved Hide resolved

Apply suggestion from @gmlewis

73b6461

gmlewis reviewed Jan 31, 2026

View reviewed changes

otel/transport.go Outdated Show resolved Hide resolved

Apply suggestion from @gmlewis

ecc307c

gmlewis reviewed Jan 31, 2026

View reviewed changes

otel/transport.go Outdated Show resolved Hide resolved

Apply suggestion from @gmlewis

624e9ab

gmlewis requested changes Jan 31, 2026

View reviewed changes

merchantmoh-debug added 2 commits February 1, 2026 03:15

test(otel): add comprehensive unit tests for transport

1bb856e

style(otel): strict lint fixes (paralleltest, fmtpercentv, revive)

6f09c21

alexandear reviewed Feb 1, 2026

View reviewed changes

merchantmoh-debug and others added 4 commits February 1, 2026 16:00

Merge branch 'master' into feat/opentelemetry-support

5920d98

chore(otel): fix example documentation and downgrade deps to v1.27.0

d5eb870

Merge pull request #13 from merchantmoh-debug/feat-otel-tidy-fixes-17…

a7f6cfe

…427587979539721511 fix(otel): synchronize dependencies in example/otel

merchantmoh-debug requested review from alexandear and gmlewis February 2, 2026 04:06

alexandear reviewed Feb 2, 2026

View reviewed changes

google-labs-jules bot and others added 3 commits February 2, 2026 17:31

Merge branch 'feat/opentelemetry-support' into apply-otel-review-feed…

291e439

…back-15903149166570935690

Merge pull request #15 from merchantmoh-debug/apply-otel-review-feedb…

0fdc8b2

…ack-15903149166570935690 Apply code review feedback for OpenTelemetry support

merchantmoh-debug requested a review from alexandear February 2, 2026 17:44

Merge branch 'master' into feat/opentelemetry-support

ccb7a3e

alexandear reviewed Feb 2, 2026

View reviewed changes

merchantmoh-debug and others added 2 commits February 2, 2026 12:56

Update otel/go.mod

5e656ae

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Merge branch 'master' into feat/opentelemetry-support

8da9a45

		HeaderRateReset = "X-Ratelimit-Reset"
		HeaderRateResource = "X-Ratelimit-Resource"

feat(otel): Add native OpenTelemetry Transport module #3938

Are you sure you want to change the base?

feat(otel): Add native OpenTelemetry Transport module #3938

Uh oh!

Conversation

merchantmoh-debug commented Jan 24, 2026

Features

Verification

Uh oh!

merchantmoh-debug commented Jan 24, 2026

Uh oh!

gmlewis commented Jan 24, 2026

Uh oh!

merchantmoh-debug commented Jan 24, 2026

Uh oh!

merchantmoh-debug commented Jan 25, 2026

Uh oh!

gmlewis commented Jan 28, 2026

Uh oh!

merchantmoh-debug commented Jan 28, 2026

Uh oh!

merchantmoh-debug commented Jan 28, 2026

Uh oh!

alexandear left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

merchantmoh-debug commented Jan 28, 2026

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

gmlewis commented Jan 28, 2026

Uh oh!

merchantmoh-debug commented Jan 28, 2026

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

alexandear commented Jan 28, 2026

Uh oh!

merchantmoh-debug commented Jan 28, 2026

Uh oh!

merchantmoh-debug commented Jan 28, 2026

Uh oh!

merchantmoh-debug commented Jan 28, 2026

Uh oh!

merchantmoh-debug commented Jan 31, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gmlewis commented Jan 31, 2026

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

merchantmoh-debug commented Feb 2, 2026

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!

merchantmoh-debug commented Feb 2, 2026

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!