Skip to content

Commit c964798

Browse files
authored
feat(trace): Updated otlp-grpc connection constructor to have default values (#188)
1 parent ccb88ee commit c964798

File tree

3 files changed

+12
-25
lines changed

3 files changed

+12
-25
lines changed

trace/otlp.go

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,19 @@ import (
99
)
1010

1111
// DefaultOtlpGrpcTimeout is the default timeout in seconds for the OTLP gRPC connection.
12-
const DefaultOtlpGrpcTimeout = 5
12+
const DefaultOtlpGrpcTimeout = 30
1313

14-
// NewOtlpGrpcClientConnection returns a gRPC connection, and accept a host and a list of [DialOption]
15-
//
16-
// [DialOption]: https://github.com/grpc/grpc-go
14+
// NewOtlpGrpcClientConnection returns a gRPC connection, and accept a host and a list of [grpc.DialOption].
1715
func NewOtlpGrpcClientConnection(ctx context.Context, host string, dialOptions ...grpc.DialOption) (*grpc.ClientConn, error) {
1816
dialCtx, cancel := context.WithTimeout(ctx, DefaultOtlpGrpcTimeout*time.Second)
1917
defer cancel()
2018

21-
if len(dialOptions) == 0 {
22-
dialOptions = []grpc.DialOption{
23-
grpc.WithTransportCredentials(insecure.NewCredentials()),
24-
grpc.WithBlock(),
25-
}
19+
dialContextOptions := []grpc.DialOption{
20+
grpc.WithTransportCredentials(insecure.NewCredentials()),
21+
grpc.WithBlock(),
2622
}
2723

28-
return grpc.DialContext(dialCtx, host, dialOptions...)
24+
dialContextOptions = append(dialContextOptions, dialOptions...)
25+
26+
return grpc.DialContext(dialCtx, host, dialContextOptions...)
2927
}

trace/otlp_test.go

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ import (
1010
"github.com/stretchr/testify/assert"
1111
"google.golang.org/grpc"
1212
"google.golang.org/grpc/connectivity"
13-
"google.golang.org/grpc/credentials/insecure"
1413
"google.golang.org/grpc/test/bufconn"
1514
)
1615

@@ -35,8 +34,6 @@ func TestNewOtlpGrpcInsecureConnectionSuccess(t *testing.T) {
3534
context.Background(),
3635
"bufnet",
3736
grpc.WithContextDialer(bufDialer),
38-
grpc.WithTransportCredentials(insecure.NewCredentials()),
39-
grpc.WithBlock(),
4037
)
4138
assert.NoError(t, err)
4239

trace/processor.go

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,32 +18,24 @@ const (
1818
Noop = "noop" // processor to void the trace spans
1919
)
2020

21-
// NewTestSpanProcessor returns a [OTEL SpanProcessor] using a sync [tracetest.TestTraceExporter].
22-
//
23-
// [OTEL SpanProcessor]: https://github.com/open-telemetry/opentelemetry-go
21+
// NewTestSpanProcessor returns a [trace.SpanProcessor] using a sync [tracetest.TestTraceExporter].
2422
func NewTestSpanProcessor(testTraceExporter tracetest.TestTraceExporter) trace.SpanProcessor {
2523
return trace.NewSimpleSpanProcessor(testTraceExporter)
2624
}
2725

28-
// NewNoopSpanProcessor returns a [OTEL SpanProcessor] that voids trace spans via an async [otelsdktracetest.NoopExporter].
29-
//
30-
// [OTEL SpanProcessor]: https://github.com/open-telemetry/opentelemetry-go
26+
// NewNoopSpanProcessor returns a [trace.SpanProcessor] that voids trace spans via an async [otelsdktracetest.NoopExporter].
3127
func NewNoopSpanProcessor() trace.SpanProcessor {
3228
return trace.NewBatchSpanProcessor(otelsdktracetest.NewNoopExporter())
3329
}
3430

35-
// NewTestSpanProcessor returns a [OTEL SpanProcessor] using an async [stdouttrace.Exporter].
36-
//
37-
// [OTEL SpanProcessor]: https://github.com/open-telemetry/opentelemetry-go
31+
// NewStdoutSpanProcessor returns a [trace.SpanProcessor] using an async [stdouttrace.Exporter].
3832
func NewStdoutSpanProcessor(options ...stdouttrace.Option) trace.SpanProcessor {
3933
exporter, _ := stdouttrace.New(options...)
4034

4135
return trace.NewBatchSpanProcessor(exporter)
4236
}
4337

44-
// NewOtlpGrpcSpanProcessor returns a [OTEL SpanProcessor] using an async [otlptracegrpc.Exporter].
45-
//
46-
// [OTEL SpanProcessor]: https://github.com/open-telemetry/opentelemetry-go
38+
// NewOtlpGrpcSpanProcessor returns a [trace.SpanProcessor] using an async [otlptracegrpc.Exporter].
4739
func NewOtlpGrpcSpanProcessor(ctx context.Context, conn *grpc.ClientConn) (trace.SpanProcessor, error) {
4840
exporter, err := otlptracegrpc.New(ctx, otlptracegrpc.WithGRPCConn(conn))
4941
if err != nil {

0 commit comments

Comments
 (0)