208 lines
7 KiB
Go
208 lines
7 KiB
Go
package observability
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
ptypes "github.com/traefik/paerser/types"
|
|
"github.com/traefik/traefik/v3/pkg/metrics"
|
|
"github.com/traefik/traefik/v3/pkg/middlewares/accesslog"
|
|
"github.com/traefik/traefik/v3/pkg/tracing"
|
|
"github.com/traefik/traefik/v3/pkg/types"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
sdkmetric "go.opentelemetry.io/otel/sdk/metric"
|
|
"go.opentelemetry.io/otel/sdk/metric/metricdata"
|
|
"go.opentelemetry.io/otel/sdk/metric/metricdata/metricdatatest"
|
|
)
|
|
|
|
func TestEntryPointMiddleware_tracing(t *testing.T) {
|
|
type expected struct {
|
|
name string
|
|
attributes []attribute.KeyValue
|
|
}
|
|
|
|
testCases := []struct {
|
|
desc string
|
|
entryPoint string
|
|
expected expected
|
|
}{
|
|
{
|
|
desc: "basic test",
|
|
entryPoint: "test",
|
|
expected: expected{
|
|
name: "EntryPoint",
|
|
attributes: []attribute.KeyValue{
|
|
attribute.String("span.kind", "server"),
|
|
attribute.String("entry_point", "test"),
|
|
attribute.String("http.request.method", "GET"),
|
|
attribute.String("network.protocol.version", "1.1"),
|
|
attribute.Int64("http.request.body.size", int64(0)),
|
|
attribute.String("url.path", "/search"),
|
|
attribute.String("url.query", "q=Opentelemetry&token=REDACTED"),
|
|
attribute.String("url.scheme", "http"),
|
|
attribute.String("user_agent.original", "entrypoint-test"),
|
|
attribute.String("server.address", "www.test.com"),
|
|
attribute.String("network.peer.address", "10.0.0.1"),
|
|
attribute.String("client.address", "10.0.0.1"),
|
|
attribute.Int64("client.port", int64(1234)),
|
|
attribute.Int64("network.peer.port", int64(1234)),
|
|
attribute.StringSlice("http.request.header.x-foo", []string{"foo", "bar"}),
|
|
attribute.Int64("http.response.status_code", int64(404)),
|
|
attribute.StringSlice("http.response.header.x-bar", []string{"foo", "bar"}),
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, test := range testCases {
|
|
t.Run(test.desc, func(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodGet, "http://www.test.com/search?q=Opentelemetry&token=123", nil)
|
|
rw := httptest.NewRecorder()
|
|
req.RemoteAddr = "10.0.0.1:1234"
|
|
req.Header.Set("User-Agent", "entrypoint-test")
|
|
req.Header.Set("X-Forwarded-Proto", "http")
|
|
req.Header.Set("X-Foo", "foo")
|
|
req.Header.Add("X-Foo", "bar")
|
|
|
|
next := http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
|
|
rw.Header().Set("X-Bar", "foo")
|
|
rw.Header().Add("X-Bar", "bar")
|
|
rw.WriteHeader(http.StatusNotFound)
|
|
})
|
|
|
|
tracer := &mockTracer{}
|
|
|
|
handler := newEntryPoint(context.Background(), tracing.NewTracer(tracer, []string{"X-Foo"}, []string{"X-Bar"}, []string{"q"}), nil, test.entryPoint, next)
|
|
handler.ServeHTTP(rw, req)
|
|
|
|
for _, span := range tracer.spans {
|
|
assert.Equal(t, test.expected.name, span.name)
|
|
assert.Equal(t, test.expected.attributes, span.attributes)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestEntryPointMiddleware_metrics(t *testing.T) {
|
|
tests := []struct {
|
|
desc string
|
|
statusCode int
|
|
wantAttributes attribute.Set
|
|
}{
|
|
{
|
|
desc: "not found status",
|
|
statusCode: http.StatusNotFound,
|
|
wantAttributes: attribute.NewSet(
|
|
attribute.Key("error.type").String("404"),
|
|
attribute.Key("http.request.method").String("GET"),
|
|
attribute.Key("http.response.status_code").Int(404),
|
|
attribute.Key("network.protocol.name").String("http/1.1"),
|
|
attribute.Key("network.protocol.version").String("1.1"),
|
|
attribute.Key("server.address").String("www.test.com"),
|
|
attribute.Key("url.scheme").String("http"),
|
|
),
|
|
},
|
|
{
|
|
desc: "created status",
|
|
statusCode: http.StatusCreated,
|
|
wantAttributes: attribute.NewSet(
|
|
attribute.Key("http.request.method").String("GET"),
|
|
attribute.Key("http.response.status_code").Int(201),
|
|
attribute.Key("network.protocol.name").String("http/1.1"),
|
|
attribute.Key("network.protocol.version").String("1.1"),
|
|
attribute.Key("server.address").String("www.test.com"),
|
|
attribute.Key("url.scheme").String("http"),
|
|
),
|
|
},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(test.desc, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var cfg types.OTLP
|
|
(&cfg).SetDefaults()
|
|
cfg.AddRoutersLabels = true
|
|
cfg.PushInterval = ptypes.Duration(10 * time.Millisecond)
|
|
rdr := sdkmetric.NewManualReader()
|
|
|
|
meterProvider := sdkmetric.NewMeterProvider(sdkmetric.WithReader(rdr))
|
|
// force the meter provider with manual reader to collect metrics for the test.
|
|
metrics.SetMeterProvider(meterProvider)
|
|
|
|
semConvMetricRegistry, err := metrics.NewSemConvMetricRegistry(context.Background(), &cfg)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, semConvMetricRegistry)
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "http://www.test.com/search?q=Opentelemetry", nil)
|
|
rw := httptest.NewRecorder()
|
|
req.RemoteAddr = "10.0.0.1:1234"
|
|
req.Header.Set("User-Agent", "entrypoint-test")
|
|
req.Header.Set("X-Forwarded-Proto", "http")
|
|
|
|
next := http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
|
|
rw.WriteHeader(test.statusCode)
|
|
})
|
|
|
|
handler := newEntryPoint(context.Background(), nil, semConvMetricRegistry, "test", next)
|
|
handler.ServeHTTP(rw, req)
|
|
|
|
got := metricdata.ResourceMetrics{}
|
|
err = rdr.Collect(context.Background(), &got)
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, got.ScopeMetrics, 1)
|
|
|
|
expected := metricdata.Metrics{
|
|
Name: "http.server.request.duration",
|
|
Description: "Duration of HTTP server requests.",
|
|
Unit: "s",
|
|
Data: metricdata.Histogram[float64]{
|
|
DataPoints: []metricdata.HistogramDataPoint[float64]{
|
|
{
|
|
Attributes: test.wantAttributes,
|
|
Count: 1,
|
|
Bounds: []float64{0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10},
|
|
BucketCounts: []uint64{0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0},
|
|
Min: metricdata.NewExtrema[float64](1),
|
|
Max: metricdata.NewExtrema[float64](1),
|
|
Sum: 1,
|
|
},
|
|
},
|
|
Temporality: metricdata.CumulativeTemporality,
|
|
},
|
|
}
|
|
|
|
metricdatatest.AssertEqual[metricdata.Metrics](t, expected, got.ScopeMetrics[0].Metrics[0], metricdatatest.IgnoreTimestamp(), metricdatatest.IgnoreValue())
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestEntryPointMiddleware_tracingInfoIntoLog(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodGet, "http://www.test.com/", http.NoBody)
|
|
req = req.WithContext(
|
|
context.WithValue(
|
|
req.Context(),
|
|
accesslog.DataTableKey,
|
|
&accesslog.LogData{Core: accesslog.CoreLogData{}},
|
|
),
|
|
)
|
|
|
|
next := http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {})
|
|
|
|
tracer := &mockTracer{}
|
|
|
|
handler := newEntryPoint(context.Background(), tracing.NewTracer(tracer, []string{}, []string{}, []string{}), nil, "test", next)
|
|
handler.ServeHTTP(httptest.NewRecorder(), req)
|
|
|
|
expectedSpanCtx := tracer.spans[0].SpanContext()
|
|
|
|
logData := accesslog.GetLogData(req)
|
|
assert.Equal(t, expectedSpanCtx.TraceID().String(), logData.Core[accesslog.TraceID])
|
|
assert.Equal(t, expectedSpanCtx.SpanID().String(), logData.Core[accesslog.SpanID])
|
|
}
|