mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-22 20:06:07 +02:00
d5d4c87f6d
* add HTTP support for OTLP metrics exporter * add to changelog * fix unit test not covered before * add otlpmetrichttp module to .github/dependabot.yml * add test file for client.go * run make commit to clean repository * fix err occurs in TestCancelledContext * fix err in TestCancelledContext which is nil * fix err in TestCancelledContext which is nil, occurs occasionally * fix unittest err in TestCancelledContext which occurs occasionally * fix ineffectual assignment to err when running lint * Update CHANGELOG.md Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> * Update exporters/otlp/otlpmetric/otlpmetrichttp/doc.go Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> * Update exporters/otlp/otlpmetric/otlpmetrichttp/doc.go Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> * del options that not used in http exporter metrics Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
431 lines
11 KiB
Go
431 lines
11 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 otlpmetrichttp_test
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel/exporters/otlp/otlpmetric"
|
|
"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpmetrictest"
|
|
)
|
|
|
|
const (
|
|
relOtherMetricsPath = "post/metrics/here"
|
|
otherMetricsPath = "/post/metrics/here"
|
|
)
|
|
|
|
var (
|
|
oneRecord = otlpmetrictest.OneRecordCheckpointSet{}
|
|
)
|
|
|
|
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 []otlpmetrichttp.Option
|
|
mcCfg mockCollectorConfig
|
|
tls bool
|
|
}{
|
|
{
|
|
name: "no extra options",
|
|
opts: nil,
|
|
},
|
|
{
|
|
name: "with gzip compression",
|
|
opts: []otlpmetrichttp.Option{
|
|
otlpmetrichttp.WithCompression(otlpmetrichttp.GzipCompression),
|
|
},
|
|
},
|
|
{
|
|
name: "with empty paths (forced to defaults)",
|
|
opts: []otlpmetrichttp.Option{
|
|
otlpmetrichttp.WithURLPath(""),
|
|
},
|
|
},
|
|
{
|
|
name: "with relative paths",
|
|
opts: []otlpmetrichttp.Option{
|
|
otlpmetrichttp.WithURLPath(relOtherMetricsPath),
|
|
},
|
|
mcCfg: mockCollectorConfig{
|
|
MetricsURLPath: otherMetricsPath,
|
|
},
|
|
},
|
|
{
|
|
name: "with TLS",
|
|
opts: nil,
|
|
mcCfg: mockCollectorConfig{
|
|
WithTLS: true,
|
|
},
|
|
tls: true,
|
|
},
|
|
{
|
|
name: "with extra headers",
|
|
opts: []otlpmetrichttp.Option{
|
|
otlpmetrichttp.WithHeaders(testHeaders),
|
|
},
|
|
mcCfg: mockCollectorConfig{
|
|
ExpectedHeaders: testHeaders,
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
mc := runMockCollector(t, tc.mcCfg)
|
|
defer mc.MustStop(t)
|
|
allOpts := []otlpmetrichttp.Option{
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
}
|
|
if tc.tls {
|
|
tlsConfig := mc.ClientTLSConfig()
|
|
require.NotNil(t, tlsConfig)
|
|
allOpts = append(allOpts, otlpmetrichttp.WithTLSClientConfig(tlsConfig))
|
|
} else {
|
|
allOpts = append(allOpts, otlpmetrichttp.WithInsecure())
|
|
}
|
|
allOpts = append(allOpts, tc.opts...)
|
|
client := otlpmetrichttp.NewClient(allOpts...)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, client)
|
|
if assert.NoError(t, err) {
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
otlpmetrictest.RunEndToEndTest(ctx, t, exporter, mc)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestExporterShutdown(t *testing.T) {
|
|
mc := runMockCollector(t, mockCollectorConfig{})
|
|
defer func() {
|
|
_ = mc.Stop()
|
|
}()
|
|
|
|
<-time.After(5 * time.Millisecond)
|
|
|
|
otlpmetrictest.RunExporterShutdownTest(t, func() otlpmetric.Client {
|
|
return otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithEndpoint(mc.endpoint),
|
|
)
|
|
})
|
|
}
|
|
|
|
func TestRetry(t *testing.T) {
|
|
statuses := []int{
|
|
http.StatusTooManyRequests,
|
|
http.StatusServiceUnavailable,
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
client := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithMaxAttempts(len(statuses)+1),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, client)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.Export(ctx, oneRecord)
|
|
assert.NoError(t, err)
|
|
assert.Len(t, mc.GetMetrics(), 1)
|
|
}
|
|
|
|
func TestTimeout(t *testing.T) {
|
|
mcCfg := mockCollectorConfig{
|
|
InjectDelay: 100 * time.Millisecond,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
client := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithTimeout(50*time.Millisecond),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, client)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.Export(ctx, oneRecord)
|
|
assert.Equal(t, true, os.IsTimeout(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 := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithMaxAttempts(1),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.Export(ctx, oneRecord)
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetMetrics())
|
|
}
|
|
|
|
func TestNoRetry(t *testing.T) {
|
|
statuses := []int{
|
|
http.StatusBadRequest,
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithMaxAttempts(len(statuses)+1),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.Export(ctx, oneRecord)
|
|
assert.Error(t, err)
|
|
assert.Equal(t, fmt.Sprintf("failed to send metrics to http://%s/v1/metrics with HTTP status 400 Bad Request", mc.endpoint), err.Error())
|
|
assert.Empty(t, mc.GetMetrics())
|
|
}
|
|
|
|
func TestEmptyData(t *testing.T) {
|
|
mcCfg := mockCollectorConfig{}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
assert.NoError(t, err)
|
|
err = exporter.Export(ctx, oneRecord)
|
|
assert.NoError(t, err)
|
|
assert.NotEmpty(t, mc.GetMetrics())
|
|
}
|
|
|
|
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 := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithMaxAttempts(tc.maxAttempts),
|
|
otlpmetrichttp.WithBackoff(time.Millisecond),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
err = exporter.Export(ctx, oneRecord)
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetMetrics())
|
|
})
|
|
}
|
|
}
|
|
|
|
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 := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithBackoff(-time.Millisecond),
|
|
)
|
|
ctx, cancel := context.WithTimeout(context.Background(), 3*(300*time.Millisecond))
|
|
defer cancel()
|
|
exporter, err := otlpmetric.New(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(context.Background()))
|
|
}()
|
|
err = exporter.Export(ctx, oneRecord)
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetMetrics())
|
|
}
|
|
|
|
func TestCancelledContext(t *testing.T) {
|
|
statuses := []int{
|
|
http.StatusBadRequest,
|
|
}
|
|
mcCfg := mockCollectorConfig{
|
|
InjectHTTPStatus: statuses,
|
|
}
|
|
mc := runMockCollector(t, mcCfg)
|
|
defer mc.MustStop(t)
|
|
driver := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
)
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
exporter, err := otlpmetric.New(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(context.Background()))
|
|
}()
|
|
cancel()
|
|
_ = exporter.Export(ctx, oneRecord)
|
|
assert.Empty(t, mc.GetMetrics())
|
|
}
|
|
|
|
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 := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithBackoff(time.Minute),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(context.Background()))
|
|
}()
|
|
ctx, cancel := context.WithTimeout(ctx, time.Second)
|
|
defer cancel()
|
|
err = exporter.Export(ctx, oneRecord)
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetMetrics())
|
|
}
|
|
|
|
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 := otlpmetrichttp.NewClient(
|
|
otlpmetrichttp.WithEndpoint(mc.Endpoint()),
|
|
otlpmetrichttp.WithInsecure(),
|
|
otlpmetrichttp.WithBackoff(time.Minute),
|
|
)
|
|
ctx := context.Background()
|
|
exporter, err := otlpmetric.New(ctx, driver)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
assert.NoError(t, exporter.Shutdown(ctx))
|
|
}()
|
|
doneCh := make(chan struct{})
|
|
go func() {
|
|
err := exporter.Export(ctx, oneRecord)
|
|
assert.Error(t, err)
|
|
assert.Empty(t, mc.GetMetrics())
|
|
close(doneCh)
|
|
}()
|
|
<-time.After(time.Second)
|
|
err = exporter.Shutdown(ctx)
|
|
assert.NoError(t, err)
|
|
<-doneCh
|
|
}
|