Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor otlphttp exporter for upcoming API chnages #3289

Merged
merged 2 commits into from
May 25, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions exporter/otlphttpexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ func createTracesExporter(
cfg,
params.Logger,
oce.pushTraceData,
exporterhelper.WithStart(oce.start),
exporterhelper.WithCapabilities(consumer.Capabilities{MutatesData: false}),
// explicitly disable since we rely on http.Client timeout logic.
exporterhelper.WithTimeout(exporterhelper.TimeoutSettings{Timeout: 0}),
Expand Down Expand Up @@ -119,6 +120,7 @@ func createMetricsExporter(
cfg,
params.Logger,
oce.pushMetricsData,
exporterhelper.WithStart(oce.start),
exporterhelper.WithCapabilities(consumer.Capabilities{MutatesData: false}),
// explicitly disable since we rely on http.Client timeout logic.
exporterhelper.WithTimeout(exporterhelper.TimeoutSettings{Timeout: 0}),
Expand Down Expand Up @@ -146,6 +148,7 @@ func createLogsExporter(
cfg,
params.Logger,
oce.pushLogData,
exporterhelper.WithStart(oce.start),
exporterhelper.WithCapabilities(consumer.Capabilities{MutatesData: false}),
// explicitly disable since we rely on http.Client timeout logic.
exporterhelper.WithTimeout(exporterhelper.TimeoutSettings{Timeout: 0}),
Expand Down
15 changes: 11 additions & 4 deletions exporter/otlphttpexporter/factory_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"go.uber.org/zap"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/config"
"go.opentelemetry.io/collector/config/configcheck"
"go.opentelemetry.io/collector/config/confighttp"
Expand Down Expand Up @@ -62,9 +63,10 @@ func TestCreateTracesExporter(t *testing.T) {
endpoint := "http://" + testutil.GetAvailableLocalAddress(t)

tests := []struct {
name string
config Config
mustFail bool
name string
config Config
mustFail bool
pavankrish123 marked this conversation as resolved.
Show resolved Hide resolved
mustFailOnStart bool
}{
{
name: "NoEndpoint",
Expand Down Expand Up @@ -128,7 +130,8 @@ func TestCreateTracesExporter(t *testing.T) {
},
},
},
mustFail: true,
mustFail: false,
mustFailOnStart: true,
},
}

Expand All @@ -143,6 +146,10 @@ func TestCreateTracesExporter(t *testing.T) {
} else {
pavankrish123 marked this conversation as resolved.
Show resolved Hide resolved
assert.NoError(t, err)
assert.NotNil(t, consumer)
err = consumer.Start(context.Background(), componenttest.NewNopHost())
if tt.mustFailOnStart {
assert.Error(t, err)
}

err = consumer.Shutdown(context.Background())
if err != nil {
Expand Down
29 changes: 18 additions & 11 deletions exporter/otlphttpexporter/otlp.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import (
"google.golang.org/genproto/googleapis/rpc/status"
"google.golang.org/protobuf/proto"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/config"
"go.opentelemetry.io/collector/config/configgrpc"
"go.opentelemetry.io/collector/consumer/consumererror"
Expand Down Expand Up @@ -65,24 +66,30 @@ func newExporter(cfg config.Exporter, logger *zap.Logger) (*exporter, error) {
}
}

client, err := oCfg.HTTPClientSettings.ToClient()
// client construction is deferred to start
return &exporter{
config: oCfg,
logger: logger,
}, nil
}

// start actually creates the HTTP client. The client construction is deferred till this point as this
// is the only place we get hold of Extensions which are required to construct auth round tripper.
func (e *exporter) start(_ context.Context, _ component.Host) error {
client, err := e.config.HTTPClientSettings.ToClient()
if err != nil {
return nil, err
return err
}

if oCfg.Compression != "" {
if strings.ToLower(oCfg.Compression) == configgrpc.CompressionGzip {
if e.config.Compression != "" {
if strings.ToLower(e.config.Compression) == configgrpc.CompressionGzip {
client.Transport = middleware.NewCompressRoundTripper(client.Transport)
} else {
return nil, fmt.Errorf("unsupported compression type %q", oCfg.Compression)
return fmt.Errorf("unsupported compression type %q", e.config.Compression)
}
}

return &exporter{
config: oCfg,
client: client,
logger: logger,
}, nil
e.client = client
return nil
}

func (e *exporter) pushTraceData(ctx context.Context, traces pdata.Traces) error {
Expand Down
18 changes: 14 additions & 4 deletions exporter/otlphttpexporter/otlp_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -165,13 +165,15 @@ func TestCompressionOptions(t *testing.T) {
factory := NewFactory()
cfg := createExporterConfig(test.baseURL, factory.CreateDefaultConfig())
cfg.Compression = test.compression
exp, err := factory.CreateTracesExporter(context.Background(), component.ExporterCreateParams{Logger: zap.NewNop()}, cfg)
exp, _ := factory.CreateTracesExporter(context.Background(), component.ExporterCreateParams{Logger: zap.NewNop()}, cfg)
err := exp.Start(context.Background(), componenttest.NewNopHost())
t.Cleanup(func() {
require.NoError(t, exp.Shutdown(context.Background()))
})
if test.err {
assert.Error(t, err)
require.Error(t, err)
return
}
require.NoError(t, err)
startAndCleanup(t, exp)

td := testdata.GenerateTracesOneSpan()
assert.NoError(t, exp.ConsumeTraces(context.Background(), td))
Expand Down Expand Up @@ -451,6 +453,14 @@ func TestErrorResponses(t *testing.T) {
exp, err := createTracesExporter(context.Background(), component.ExporterCreateParams{Logger: zap.NewNop()}, cfg)
require.NoError(t, err)

// start the exporter
err = exp.Start(context.Background(), componenttest.NewNopHost())
require.NoError(t, err)
t.Cleanup(func() {
require.NoError(t, exp.Shutdown(context.Background()))
})

// generate traces
traces := pdata.NewTraces()
err = exp.ConsumeTraces(context.Background(), traces)
assert.Error(t, err)
Expand Down