|
| 1 | +// Copyright 2026 The go-github Authors. All rights reserved. |
| 2 | +// Use of this source code is governed by a BSD-style |
| 3 | +// license that can be found in the LICENSE file. |
| 4 | + |
| 5 | +package otel |
| 6 | + |
| 7 | +import ( |
| 8 | + "fmt" |
| 9 | + "net/http" |
| 10 | + "strconv" |
| 11 | + |
| 12 | + "github.com/google/go-github/v82/github" |
| 13 | + "go.opentelemetry.io/otel" |
| 14 | + "go.opentelemetry.io/otel/attribute" |
| 15 | + "go.opentelemetry.io/otel/codes" |
| 16 | + "go.opentelemetry.io/otel/metric" |
| 17 | + "go.opentelemetry.io/otel/propagation" |
| 18 | + "go.opentelemetry.io/otel/trace" |
| 19 | +) |
| 20 | + |
| 21 | +const ( |
| 22 | + // instrumentationName is the name of this instrumentation package. |
| 23 | + // NOTE: This must be updated when the major version of go-github changes. |
| 24 | + instrumentationName = "github.com/google/go-github/v82/otel" |
| 25 | +) |
| 26 | + |
| 27 | +// Transport is an http.RoundTripper that instrument requests with OpenTelemetry. |
| 28 | +type Transport struct { |
| 29 | + Base http.RoundTripper |
| 30 | + Tracer trace.Tracer |
| 31 | + Meter metric.Meter |
| 32 | +} |
| 33 | + |
| 34 | +// NewTransport creates a new OpenTelemetry transport. |
| 35 | +func NewTransport(base http.RoundTripper, opts ...Option) *Transport { |
| 36 | + if base == nil { |
| 37 | + base = http.DefaultTransport |
| 38 | + } |
| 39 | + t := &Transport{Base: base} |
| 40 | + for _, opt := range opts { |
| 41 | + opt(t) |
| 42 | + } |
| 43 | + if t.Tracer == nil { |
| 44 | + t.Tracer = otel.Tracer(instrumentationName) |
| 45 | + } |
| 46 | + if t.Meter == nil { |
| 47 | + t.Meter = otel.Meter(instrumentationName) |
| 48 | + } |
| 49 | + return t |
| 50 | +} |
| 51 | + |
| 52 | +// RoundTrip implements http.RoundTripper. |
| 53 | +func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error) { |
| 54 | + ctx := req.Context() |
| 55 | + spanName := fmt.Sprintf("github/%s", req.Method) |
| 56 | + |
| 57 | + // Start Span |
| 58 | + ctx, span := t.Tracer.Start(ctx, spanName, trace.WithSpanKind(trace.SpanKindClient)) |
| 59 | + defer span.End() |
| 60 | + |
| 61 | + // Inject Attributes |
| 62 | + span.SetAttributes( |
| 63 | + attribute.String("http.method", req.Method), |
| 64 | + attribute.String("http.url", req.URL.String()), |
| 65 | + attribute.String("http.host", req.URL.Host), |
| 66 | + ) |
| 67 | + |
| 68 | + // Inject Propagation Headers |
| 69 | + otel.GetTextMapPropagator().Inject(ctx, propagation.HeaderCarrier(req.Header)) |
| 70 | + |
| 71 | + // Execute Request |
| 72 | + resp, err := t.Base.RoundTrip(req) |
| 73 | + if err != nil { |
| 74 | + span.RecordError(err) |
| 75 | + span.SetStatus(codes.Error, err.Error()) |
| 76 | + return nil, err |
| 77 | + } |
| 78 | + |
| 79 | + // Capture response attributes |
| 80 | + span.SetAttributes(attribute.Int("http.status_code", resp.StatusCode)) |
| 81 | + |
| 82 | + // Capture GitHub Specifics |
| 83 | + if limit := resp.Header.Get("X-Ratelimit-Limit"); limit != "" { |
| 84 | + if v, err := strconv.Atoi(limit); err == nil { |
| 85 | + span.SetAttributes(attribute.Int("github.rate_limit.limit", v)) |
| 86 | + } |
| 87 | + } |
| 88 | + if remaining := resp.Header.Get("X-Ratelimit-Remaining"); remaining != "" { |
| 89 | + if v, err := strconv.Atoi(remaining); err == nil { |
| 90 | + span.SetAttributes(attribute.Int("github.rate_limit.remaining", v)) |
| 91 | + } |
| 92 | + } |
| 93 | + if reset := resp.Header.Get(github.HeaderRateReset); reset != "" { |
| 94 | + span.SetAttributes(attribute.String("github.rate_limit.reset", reset)) |
| 95 | + } |
| 96 | + if reqID := resp.Header.Get("X-Github-Request-Id"); reqID != "" { |
| 97 | + span.SetAttributes(attribute.String("github.request_id", reqID)) |
| 98 | + } |
| 99 | + if resource := resp.Header.Get("X-Ratelimit-Resource"); resource != "" { |
| 100 | + span.SetAttributes(attribute.String("github.rate_limit.resource", resource)) |
| 101 | + } |
| 102 | + |
| 103 | + if resp.StatusCode >= 400 { |
| 104 | + span.SetStatus(codes.Error, fmt.Sprintf("HTTP %d", resp.StatusCode)) |
| 105 | + } else { |
| 106 | + span.SetStatus(codes.Ok, "OK") |
| 107 | + } |
| 108 | + |
| 109 | + return resp, nil |
| 110 | +} |
| 111 | + |
| 112 | +// Option applies configuration to Transport. |
| 113 | +type Option func(*Transport) |
| 114 | + |
| 115 | +// WithTracerProvider configures the TracerProvider. |
| 116 | +func WithTracerProvider(tp trace.TracerProvider) Option { |
| 117 | + return func(t *Transport) { |
| 118 | + t.Tracer = tp.Tracer(instrumentationName) |
| 119 | + } |
| 120 | +} |
| 121 | + |
| 122 | +// WithMeterProvider configures the MeterProvider. |
| 123 | +func WithMeterProvider(mp metric.MeterProvider) Option { |
| 124 | + return func(t *Transport) { |
| 125 | + t.Meter = mp.Meter(instrumentationName) |
| 126 | + } |
| 127 | +} |
0 commit comments