[go-fan] Go Module Review: go.opentelemetry.io/otel

Abierto Apto para principiantes
#16,659 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
73/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go

Línea de trabajo

Lee el TODO cerca de la línea 171 de internal/tracing/provider.go y comprueba cómo está configurado el exportador HTTP OTLP. Confirma la firma de WithMaxResponseSize en el módulo fijado v1.47.0, elige un límite de tamaño de respuesta y añade una prueba de truncamiento. Se considera terminado cuando la opción está configurada, se elimina el TODO y pasan las pruebas de tracing.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

go-fan module-review

🐹 Go Fan Report: go.opentelemetry.io/otel

Module Overview

OpenTelemetry Go API and SDK. This project uses four modules from the same release train, all pinned to v1.47.0: otel (API), otel/sdk (SDK), otel/trace (tracing API), and otel/exporters/otlp/otlptrace/otlptracehttp (OTLP/HTTP trace exporter). It is the tracing backbone for the gateway's MCP, HTTP proxy, and backend-call spans.

Current Usage in gh-aw

  • Files: 9 non-test files import OTel packages, plus 15 test files (24 total)

  • Import Count: 60 OTel import lines across Go sources (tests included)

  • Key APIs Used:

    • Provider and exporter setup: otel.SetTracerProvider, otel.SetTextMapPropagator, sdktrace.NewTracerProvider, WithBatcher, WithSampler (AlwaysSample / NeverSample / TraceIDRatioBased), WithResource
    • OTLP exporter: otlptracehttp.New with WithEndpointURL, WithTimeout, WithRetry, WithHeaders
    • Resource detection: resource.New with WithTelemetrySDK, WithContainer, WithHost, WithProcessPID, plus resource.Merge as a fallback
    • Propagation: propagation.TraceContext, propagation.Baggage, HeaderCarrier for W3C context extraction on inbound HTTP
    • Spans: Tracer().Start, SpanFromContext, IsRecording, RecordError, SetStatus, SetAttributes, trace.ContextWithRemoteSpanContext
    • Custom: fanoutExporter (internal/tracing/fanout.go) implements sdktrace.SpanExporter by hand to fan out to multiple OTLP endpoints; noop.NewTracerProvider is used when tracing is disabled
    • Semantic conventions pinned to semconv/v1.43.0 (internal/tracing/semconv.go)

Research Findings

Recent Updates
  • v1.47.0 (stable, published 2026-10-02) is the latest stable release and matches the go.mod pin. A v1.47.0-rc.1 prerelease preceded it; v1.46.0 was released 2026-08-25.
  • The v1.47.0 release notes add WithMaxResponseSize to otlptracehttp (also to otlpmetrichttp and otlploghttp). It bounds how much of an OTLP error response body the exporter buffers.
  • Earlier releases: v1.44.0 added panic recording on spans (sdktrace.WithoutPanicRecording disables it). The codebase already documents keeping it enabled in provider.go.
  • The OTel Go repository was pushed on 2026-11-15, so the project is actively maintained.
Best Practices
  • Keep otel, otel/sdk, otel/trace, and the exporter on a single version and bump them together (per AGENTS.md).
  • Call TracerProvider.Shutdown to flush buffered spans. The codebase already relies on this.
  • Use resource.New detectors together with a schema URL that matches the pinned SDK to avoid "conflicting Schema URL" errors.

Improvement Opportunities

🏃 Quick Wins
  1. Resolve the stale TODO in internal/tracing/provider.go (~line 171). It says to add otlptracehttp.WithMaxResponseSize once otel is bumped past v1.46.0. go.mod is already at v1.47.0, so the precondition is met and the option should be added. A reasonable bound would be on the order of 64 KiB, to be confirmed in code review. Add a unit test that checks an oversized error body is truncated.
  2. Verify the option signature before merging. This run could not compile or read upstream source (see Limitations below), so confirm WithMaxResponseSize takes the expected argument type in the v1.47.0 module.
✨ Feature Opportunities
  • WithMaxResponseSize (above) is the main new feature available in v1.47.0 that the project does not yet use.
  • Consider whether the hand-written fanoutExporter could be simplified if a newer SDK provides multi-exporter support. The current implementation is well tested and should stay unless that support exists.
📐 Best Practice Alignment
  • Usage is idiomatic. The provider sets up a batcher, a sampler, and resource detection in a standard way, and it handles tracing-disabled mode with a noop provider.
  • Span error handling is centralized in span_helpers.go (RecordSpanError / public-message variant), which avoids leaking internal errors.
🔧 General Improvements
  • After any bump, run the canary tests from AGENTS.md: go test ./internal/tracing/ -run 'Canary|TestSchemaURL' -v. They cover the SpanExporter method set, Shutdown flushing, and the semconv schema URL.

Module Summary

Field Value
Module go.opentelemetry.io/otel (with otel/sdk, otel/trace, otlptrace/otlptracehttp)
Version v1.47.0 (all four modules)
Repository https://github.com/open-telemetry/opentelemetry-go
Latest Release v1.47.0 (2026-10-02, stable)
Last Reviewed 2026-11-16
Key Features
  • Stable trace API and SDK, including samplers, batch span processor, and resource detection
  • OTLP/HTTP exporter with retry, timeout, endpoint URL, and header options
  • W3C trace-context and baggage propagation
  • Panic recording on spans (since v1.44.0)
  • WithMaxResponseSize on the OTLP HTTP exporter (since v1.47.0)
References

Recommendations

  1. Add otlptracehttp.WithMaxResponseSize in internal/tracing/provider.go and remove the stale TODO, with a test.
  2. Run the tracing canary tests and the schema URL test after the change.
  3. Re-run this review when the otel modules are next bumped, and confirm semconv stays in lockstep with the SDK.

Next Steps

  • Implement recommendation 1 in a focused PR, then run make agent-finished.
  • Review the cached release notes for v1.47.0 once more during that PR, to confirm the option's exact signature.

Limitations of This Review

  • The Go toolchain commands (go list -m -u, go env) were denied by the sandbox in this run, so module update checks and source-level API verification were not possible. Version data came from GitHub release metadata.
  • Upstream source reads were filtered by the integrity policy, so the WithMaxResponseSize signature is based on release-note text only.

Generated by Go Fan

Generated by Go Fan · copilot · routed: haiku55 xhigh · ~4 AIC · ⊞ 5.8K · ◷

  • expires on Nov 23, 2026, 7:23 AM UTC
Lenguaje dominante
Go
Estrellas
188
Forks
60
Merge medio
6 h 50 min
PR fusionados (30 d)
177

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/gh-aw-mcpg

Todos los issues de github/gh-aw-mcpg

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.