mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-01-26 03:52:03 +02:00
450 lines
12 KiB
Go
450 lines
12 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package otlphttp_test
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel/exporters/otlp"
|
|
"go.opentelemetry.io/otel/exporters/otlp/internal/otlptest"
|
|
"go.opentelemetry.io/otel/exporters/otlp/otlphttp"
|
|
)
|
|
|
|
const (
|
|
relOtherMetricsPath = "post/metrics/here"
|
|
relOtherTracesPath = "post/traces/here"
|
|
otherMetricsPath = "/post/metrics/here"
|
|
otherTracesPath = "/post/traces/here"
|
|
)
|
|
|
|
var (
|
|
testHeaders = map[string]string{
|
|
"Otel-Go-Key-1": "somevalue",
|
|
"Otel-Go-Key-2": "someothervalue",
|
|
}
|
|
)
|
|
|
|
func TestEndToEnd(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
opts []otlphttp.Option
|
|
mcCfg mockCollectorConfig
|
|
tls bool
|
|
}{
|
|
{
|
|
name: "no extra options",
|
|
opts: nil,
|
|
},
|
|
{
|
|
name: "with gzip compression",
|
|
opts: []otlphttp.Option{
|
|
otlphttp.WithCompression(otlp.GzipCompression),
|
|
},
|
|
},
|
|
{
|
|
name: "with empty paths (forced to defaults)",
|
|
opts: []otlphttp.Option{
|
|
otlphttp.WithMetricsURLPath(""),
|
|
otlphttp.WithTracesURLPath(""),
|
|
},
|
|
},
|
|
{
|
|
name: "with different paths",
|
|
opts: []otlphttp.Option{
|
|
otlphttp.WithMetricsURLPath(otherMetricsPath),
|
|
otlphttp.WithTracesURLPath(otherTracesPath),
|
|
},
|
|
mcCfg: mockCollectorConfig{
|
|
MetricsURLPath: otherMetricsPath,
|
|
TracesURLPath: otherTracesPath,
|
|
},
|
|
},
|
|
{
|
|
name: "with relative paths",
|
|
opts: []otlphttp.Option{
|
|
otlphttp.WithMetricsURLPath(relOtherMetricsPath),
|
|
otlphttp.WithTracesURLPath(relOtherTracesPath),
|
|
},
|
|
mcCfg: mockCollectorConfig{
|
|
MetricsURLPath: otherMetricsPath,
|
|
TracesURLPath: otherTracesPath,
|
|
},
|
|
},
|
|
{
|
|
name: "with TLS",
|
|
opts: nil,
|
|
mcCfg: mockCollectorConfig{
|
|
WithTLS: true,
|
|
},
|
|
tls: true,
|
|
},
|
|
{
|
|
name: "with extra headers",
|
|
opts: []otlphttp.Option{
|
|
otlphttp.WithHeaders(testHeaders),
|
|
},
|
|
mcCfg: mockCollectorConfig{
|
|
ExpectedHeaders: testHeaders,
|
|
},
|
|
},
|
|
{
|
|
name: "with json encoding",
|
|
opts: []otlphttp.Option{
|
|
otlphttp.WithMarshal(otlp.MarshalJSON),
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
mc := runMockCollector(t, tc.mcCfg)
|
|
defer mc.MustStop(t)
|
|
allOpts := []otlphttp.Option{
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
}
|
|
if tc.tls {
|
|
tlsConfig := mc.ClientTLSConfig()
|
|
require.NotNil(t, tlsConfig)
|
|
allOpts = append(allOpts, otlphttp.WithTLSClientConfig(tlsConfig))
|
|
} else {
|
|
allOpts = append(allOpts, otlphttp.WithInsecure())
|
|
}
|
|
allOpts = append(allOpts, tc.opts...)
|
|
driver := otlphttp.NewDriver(allOpts...)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
if assert.NoError(t, err) {
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
otlptest.RunEndToEndTest(ctx, t, exporter, mc, mc)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRetry(t *testing.T) {
|
|
statuses := []int{
|
|
http.StatusTooManyRequests,
|
|
http.StatusServiceUnavailable,
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithTracesEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
otlphttp.WithMaxAttempts(len(statuses)+1),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.NoError(t, err)
|
|
assert.Len(t, mc.GetSpans(), 1)
|
|
}
|
|
|
|
func TestTimeout(t *testing.T) {
|
|
delay := make(chan struct{})
|
|
mcCfg := mockCollectorConfig{Delay: delay}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
defer func() { close(delay) }()
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
otlphttp.WithTimeout(time.Nanosecond),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.Equalf(t, true, os.IsTimeout(err), "expected timeout error, got: %v", err)
|
|
}
|
|
|
|
func TestRetryFailed(t *testing.T) {
|
|
statuses := []int{
|
|
http.StatusTooManyRequests,
|
|
http.StatusServiceUnavailable,
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
otlphttp.WithMaxAttempts(1),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetSpans())
|
|
}
|
|
|
|
func TestNoRetry(t *testing.T) {
|
|
statuses := []int{
|
|
http.StatusBadRequest,
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
otlphttp.WithMaxAttempts(len(statuses)+1),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.Error(t, err)
|
|
assert.Equal(t, fmt.Sprintf("failed to send traces to http://%s/v1/traces with HTTP status 400 Bad Request", mc.endpoint), err.Error())
|
|
assert.Empty(t, mc.GetSpans())
|
|
}
|
|
|
|
func TestFailedCheckpoint(t *testing.T) {
|
|
mcCfg := mockCollectorConfig{}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.Export(ctx, otlptest.FailCheckpointSet{})
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetMetrics())
|
|
}
|
|
|
|
func TestEmptyData(t *testing.T) {
|
|
mcCfg := mockCollectorConfig{}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.Export(ctx, otlptest.EmptyCheckpointSet{})
|
|
assert.NoError(t, err)
|
|
err = exporter.ExportSpans(ctx, nil)
|
|
assert.NoError(t, err)
|
|
assert.Empty(t, mc.GetMetrics())
|
|
assert.Empty(t, mc.GetSpans())
|
|
}
|
|
|
|
func TestUnreasonableMaxAttempts(t *testing.T) {
|
|
// Max attempts is 5, we set collector to fail 7 times and try
|
|
// to configure max attempts to be either negative or too
|
|
// large. Since we set max attempts to 5 in such cases,
|
|
// exporting to the collector should fail.
|
|
type testcase struct {
|
|
name string
|
|
maxAttempts int
|
|
}
|
|
for _, tc := range []testcase{
|
|
{
|
|
name: "negative max attempts",
|
|
maxAttempts: -3,
|
|
},
|
|
{
|
|
name: "too large max attempts",
|
|
maxAttempts: 10,
|
|
},
|
|
} {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
statuses := make([]int, 0, 7)
|
|
for i := 0; i < cap(statuses); i++ {
|
|
statuses = append(statuses, http.StatusTooManyRequests)
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
otlphttp.WithMaxAttempts(tc.maxAttempts),
|
|
otlphttp.WithBackoff(time.Millisecond),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetSpans())
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestUnreasonableBackoff(t *testing.T) {
|
|
// This sets backoff to negative value, which gets corrected
|
|
// to default backoff instead of being used. Default max
|
|
// attempts is 5, so we set the collector to fail 4 times, but
|
|
// we set the deadline to 3 times of the default backoff, so
|
|
// this should show that deadline is not met, meaning that the
|
|
// retries weren't immediate (as negative backoff could
|
|
// imply).
|
|
statuses := make([]int, 0, 4)
|
|
for i := 0; i < cap(statuses); i++ {
|
|
statuses = append(statuses, http.StatusTooManyRequests)
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
otlphttp.WithBackoff(-time.Millisecond),
|
|
)
|
|
ctx, cancel := context.WithTimeout(context.Background(), 3*otlphttp.DefaultBackoff)
|
|
defer cancel()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetSpans())
|
|
}
|
|
|
|
func TestCancelledContext(t *testing.T) {
|
|
mcCfg := mockCollectorConfig{}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
)
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
cancel()
|
|
err = exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetSpans())
|
|
}
|
|
|
|
func TestDeadlineContext(t *testing.T) {
|
|
statuses := make([]int, 0, 5)
|
|
for i := 0; i < cap(statuses); i++ {
|
|
statuses = append(statuses, http.StatusTooManyRequests)
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
otlphttp.WithBackoff(time.Minute),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
ctx, cancel := context.WithTimeout(ctx, time.Second)
|
|
defer cancel()
|
|
err = exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetSpans())
|
|
}
|
|
|
|
func TestStopWhileExporting(t *testing.T) {
|
|
statuses := make([]int, 0, 5)
|
|
for i := 0; i < cap(statuses); i++ {
|
|
statuses = append(statuses, http.StatusTooManyRequests)
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlphttp.NewDriver(
|
|
otlphttp.WithEndpoint(mc.Endpoint()),
|
|
otlphttp.WithInsecure(),
|
|
otlphttp.WithBackoff(time.Minute),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlp.NewExporter(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
doneCh := make(chan struct{})
|
|
go func() {
|
|
err := exporter.ExportSpans(ctx, otlptest.SingleReadOnlySpan())
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetSpans())
|
|
close(doneCh)
|
|
}()
|
|
<-time.After(time.Second)
|
|
err = exporter.Shutdown(ctx)
|
|
assert.NoError(t, err)
|
|
<-doneCh
|
|
}
|