Skip to content

[TT-17154] Bump opentelemetry to post-v0.0.25 doc-comment fixes#8240

Merged
mativm02 merged 1 commit into
masterfrom
TT-17154/bump-opentelemetry-doc-comments
May 26, 2026
Merged

[TT-17154] Bump opentelemetry to post-v0.0.25 doc-comment fixes#8240
mativm02 merged 1 commit into
masterfrom
TT-17154/bump-opentelemetry-doc-comments

Conversation

@mativm02

@mativm02 mativm02 commented May 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Bumps github.com/TykTechnologies/opentelemetry from v0.0.25 to v0.0.26-0.20260521112223-3b0d024e6090, pulling in opentelemetry#69 (merge commit 3b0d024e).
  • That PR is a documentation-only change: it clarifies the config struct comments that drive user-facing OpenTelemetry docs generation (ExporterConfig.Exporter, ResourceName, OpenTelemetry.Enabled, TLS.Enable, TLS.CAFile). No behavior, API, or default changes.
  • Pinned via Go pseudo-version because no new tag was cut after v0.0.25 for this commit.

Motivation

PR review feedback on the gateway-side OpenTelemetry config docs noted unclear/inconsistent wording and grammar issues. Since the docs are generated from the upstream library's struct comments, the fixes live in TykTechnologies/opentelemetry. This PR brings those fixes into the gateway.

Test plan

  • go build ./... — OTel-touching packages (./internal/otel/..., ./internal/graphql/..., ./gateway/...) compile clean. The only build noise (test/goplugins "main undeclared", linker duplicate -ldl warning) is pre-existing on master and unrelated.
  • go vet ./internal/otel/... — passes.
  • go mod tidy — clean, no unrelated module churn.
  • CI green on this branch.

Notes for reviewers

  • Since the upstream change is comment-only, the diff here is minimal (2 lines in go.mod, 4 in go.sum).
  • Once a v0.0.26 tag is cut on the opentelemetry repo, a follow-up can replace the pseudo-version with the clean tag — but functionally identical.

Ticket Details

TT-17154
Status In Code Review
Summary Gateway API + config 5.13.0

Generated at: 2026-05-21 11:53:06

Pull in TykTechnologies/opentelemetry PR #69 (merge commit 3b0d024e),
which clarifies the config struct comments that drive user-facing docs
generation (ExporterConfig.Exporter, ResourceName, OpenTelemetry.Enabled,
TLS.Enable, TLS.CAFile). No behavior or API changes.

A new tag was not cut for this commit, so this pins via a Go pseudo-version
(v0.0.26-0.20260521112223-3b0d024e6090).
@probelabs

probelabs Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

This pull request updates the github.com/TykTechnologies/opentelemetry dependency from v0.0.25 to a newer commit v0.0.26-0.20260521112223-3b0d024e6090. The update incorporates documentation-only changes that clarify configuration comments for OpenTelemetry, which will improve the user-facing generated documentation. There are no changes to code behavior, APIs, or default values.

Files Changed Analysis

  • go.mod: The version of github.com/TykTechnologies/opentelemetry is updated.
  • go.sum: The checksums for the updated dependency are refreshed.

The changes are confined to these two files, reflecting a standard dependency bump.

Architecture & Impact Assessment

  • Accomplishment: Improves the clarity of generated documentation for OpenTelemetry configuration by pulling in upstream doc-comment fixes.
  • Technical Changes: This PR consists solely of a Go module dependency version change. No gateway code has been modified.
  • Affected Components: The change affects the documentation generation process. The runtime behavior of the OpenTelemetry integration within the gateway remains unchanged.

Scope Discovery & Context Expansion

  • Scope: The scope is minimal and isolated to a single dependency update. The impact is limited to the generated documentation for the OpenTelemetry feature.
  • Context: The upstream change was motivated by feedback on the gateway's OpenTelemetry configuration documentation. By updating this library, the source of the documentation (struct field comments) is corrected, ensuring future generated docs are clearer for users.
Metadata
  • Review Effort: 1 / 5
  • Primary Label: chore

Powered by Visor from Probelabs

Last updated: 2026-05-21T11:54:00.941Z | Triggered by: pr_opened | Commit: 9664b22

💡 TIP: You can chat with Visor using /visor ask <your question>

@probelabs

probelabs Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

✅ Security Check Passed

No security issues found – changes LGTM.

✅ Architecture Check Passed

No architecture issues found – changes LGTM.

✅ Performance Check Passed

No performance issues found – changes LGTM.


Powered by Visor from Probelabs

Last updated: 2026-05-21T11:53:42.234Z | Triggered by: pr_opened | Commit: 9664b22

💡 TIP: You can chat with Visor using /visor ask <your question>

@mativm02 mativm02 added the deps-reviewed Dependency changes reviewed and approved for CI execution label May 21, 2026
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@mativm02
mativm02 enabled auto-merge (squash) May 21, 2026 12:55
@mativm02
mativm02 merged commit 8a9a180 into master May 26, 2026
132 of 145 checks passed
@mativm02
mativm02 deleted the TT-17154/bump-opentelemetry-doc-comments branch May 26, 2026 09:33
@mativm02

Copy link
Copy Markdown
Contributor Author

/release to release-5.13

@mativm02

Copy link
Copy Markdown
Contributor Author

/release to release-5.13.0

mativm02 added a commit that referenced this pull request May 28, 2026
…5 doc-comment fixes (#8240) (#8249)

## Summary

Cherry-pick of #8240 onto `release-5.13`.

Bumps `github.com/TykTechnologies/opentelemetry` from `v0.0.25` to
`v0.0.26-0.20260521112223-3b0d024e6090`, pulling in doc-comment fixes
(TykTechnologies/opentelemetry#69). Documentation-only upstream change —
no behavior, API, or default changes.

- Original PR: #8240
- Original commit: 8a9a180
- Files changed: `go.mod` (2 lines), `go.sum` (4 lines)

## Test plan

- [ ] CI green on this branch
mativm02 added a commit that referenced this pull request May 28, 2026
….25 doc-comment fixes (#8240) (#8250)

## Summary

Cherry-pick of #8240 onto `release-5.13.0`.

Bumps `github.com/TykTechnologies/opentelemetry` from `v0.0.25` to
`v0.0.26-0.20260521112223-3b0d024e6090`, pulling in doc-comment fixes
(TykTechnologies/opentelemetry#69). Documentation-only upstream change —
no behavior, API, or default changes.

Follow-up to #8235 (the docs update that already landed on
`release-5.13.0`), bringing the matching gateway-side library bump.

- Original PR: #8240
- Original commit: 8a9a180
- Files changed: `go.mod` (2 lines), `go.sum` (4 lines)

## Test plan

- [ ] CI green on this branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deps-reviewed Dependency changes reviewed and approved for CI execution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants