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.

Sign up for GitHub

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

feat: informative user-agent for otlp exporters #3970

Merged
merged 18 commits into from
Dec 3, 2021
Merged

feat: informative user-agent for otlp exporters #3970

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
3d72c7b
feat: collector-aware user-agent header
vreynolds Sep 3, 2021
fa5942c
Address PR comments
vreynolds Sep 8, 2021
13ad211
Merge remote-tracking branch 'upstream/main' into collector-user-agent
vreynolds Sep 21, 2021
8fd2bd7
encase user-agent os/arch in parenthesis
vreynolds Sep 21, 2021
c945d07
add doc comment
vreynolds Sep 21, 2021
efd1fc1
move otlp-http user-agent to exporter
vreynolds Oct 6, 2021
672b7f6
formatting
vreynolds Oct 6, 2021
0a86588
revert unnecessary diff
vreynolds Oct 6, 2021
33bc09f
formatting
vreynolds Oct 6, 2021
386a70b
Merge remote-tracking branch 'upstream/main' into collector-user-agent
vreynolds Oct 6, 2021
ab6adb1
Merge remote-tracking branch 'upstream/main' into collector-user-agent
vreynolds Nov 3, 2021
0b44ddf
http exporter: use a custom round tripper, clone request
vreynolds Nov 3, 2021
511b636
RoundTrip must always close the body
vreynolds Nov 3, 2021
f5bddaf
remove custom roundtripper
vreynolds Nov 10, 2021
b201e25
fix lint issue
vreynolds Nov 10, 2021
e232439
Merge remote-tracking branch 'upstream/main' into collector-user-agent
vreynolds Nov 23, 2021
0ac32d6
update changelog
Nov 24, 2021
a8bd4ee
Merge remote-tracking branch 'upstream/main' into collector-user-agent
vreynolds Nov 30, 2021
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
7 changes: 7 additions & 0 deletions exporter/exporterhelper/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ package exporterhelper

import (
"context"
"fmt"
"runtime"
"time"

"go.opentelemetry.io/collector/component"
Expand Down Expand Up @@ -232,3 +234,8 @@ func (ts *timeoutSender) send(req request) error {
}
return req.export(ctx)
}

// DefaultUserAgent User-Agent value used by exporters
func DefaultUserAgent(info component.BuildInfo) string {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's move this to otlpexporter for the moment or an internal package. Prefer to limit the public API.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Moved to each exporter f5bddaf

return fmt.Sprintf("%s/%s (%s/%s)", info.Description, info.Version, runtime.GOOS, runtime.GOARCH)
}
6 changes: 3 additions & 3 deletions exporter/otlpexporter/factory.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func createTracesExporter(
set component.ExporterCreateSettings,
cfg config.Exporter,
) (component.TracesExporter, error) {
oce, err := newExporter(cfg)
oce, err := newExporter(cfg, set.BuildInfo)
if err != nil {
return nil, err
}
Expand All @@ -80,7 +80,7 @@ func createMetricsExporter(
set component.ExporterCreateSettings,
cfg config.Exporter,
) (component.MetricsExporter, error) {
oce, err := newExporter(cfg)
oce, err := newExporter(cfg, set.BuildInfo)
if err != nil {
return nil, err
}
Expand All @@ -103,7 +103,7 @@ func createLogsExporter(
set component.ExporterCreateSettings,
cfg config.Exporter,
) (component.LogsExporter, error) {
oce, err := newExporter(cfg)
oce, err := newExporter(cfg, set.BuildInfo)
if err != nil {
return nil, err
}
Expand Down
14 changes: 8 additions & 6 deletions exporter/otlpexporter/otlp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,27 @@ import (

type exporter struct {
// Input configuration.
config *Config
w *grpcSender
config *Config
w *grpcSender
buildInfo component.BuildInfo
codeboten marked this conversation as resolved.
Show resolved Hide resolved
}

// Crete new exporter and start it. The exporter will begin connecting but
// this function may return before the connection is established.
func newExporter(cfg config.Exporter) (*exporter, error) {
func newExporter(cfg config.Exporter, buildInfo component.BuildInfo) (*exporter, error) {
oCfg := cfg.(*Config)

if oCfg.Endpoint == "" {
return nil, errors.New("OTLP exporter config requires an Endpoint")
}

return &exporter{config: oCfg}, nil
return &exporter{config: oCfg, buildInfo: buildInfo}, nil
}

// start actually creates the gRPC connection. 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, host component.Host) (err error) {
e.w, err = newGrpcSender(e.config, host)
e.w, err = newGrpcSender(e.config, host, e.buildInfo)
return
}

Expand Down Expand Up @@ -94,11 +95,12 @@ type grpcSender struct {
callOptions []grpc.CallOption
}

func newGrpcSender(config *Config, host component.Host) (*grpcSender, error) {
func newGrpcSender(config *Config, host component.Host, info component.BuildInfo) (*grpcSender, error) {
dialOpts, err := config.GRPCClientSettings.ToDialOptions(host)
if err != nil {
return nil, err
}
dialOpts = append(dialOpts, grpc.WithUserAgent(exporterhelper.DefaultUserAgent(info)))
jpkrohling marked this conversation as resolved.
Show resolved Hide resolved

var clientConn *grpc.ClientConn
if clientConn, err = grpc.Dial(config.GRPCClientSettings.SanitizedEndpoint(), dialOpts...); err != nil {
Expand Down
20 changes: 18 additions & 2 deletions exporter/otlpexporter/otlp_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,8 @@ func TestSendTraces(t *testing.T) {
},
}
set := componenttest.NewNopExporterCreateSettings()
set.BuildInfo.Description = "Collector"
set.BuildInfo.Version = "1.2.3test"
exp, err := factory.CreateTracesExporter(context.Background(), set, cfg)
require.NoError(t, err)
require.NotNil(t, exp)
Expand Down Expand Up @@ -247,7 +249,10 @@ func TestSendTraces(t *testing.T) {
assert.EqualValues(t, 2, atomic.LoadInt32(&rcv.requestCount))
assert.EqualValues(t, td, rcv.GetLastRequest())

require.EqualValues(t, rcv.GetMetadata().Get("header"), expectedHeader)
md := rcv.GetMetadata()
require.EqualValues(t, md.Get("header"), expectedHeader)
require.Equal(t, len(md.Get("User-Agent")), 1)
require.Contains(t, md.Get("User-Agent")[0], "Collector/1.2.3test")
}

func TestSendTracesWhenEndpointHasHttpScheme(t *testing.T) {
Expand Down Expand Up @@ -346,6 +351,8 @@ func TestSendMetrics(t *testing.T) {
},
}
set := componenttest.NewNopExporterCreateSettings()
set.BuildInfo.Description = "Collector"
set.BuildInfo.Version = "1.2.3test"
exp, err := factory.CreateMetricsExporter(context.Background(), set, cfg)
require.NoError(t, err)
require.NotNil(t, exp)
Expand Down Expand Up @@ -390,7 +397,10 @@ func TestSendMetrics(t *testing.T) {
assert.EqualValues(t, 4, atomic.LoadInt32(&rcv.totalItems))
assert.EqualValues(t, md, rcv.GetLastRequest())

require.EqualValues(t, rcv.GetMetadata().Get("header"), expectedHeader)
mdata := rcv.GetMetadata()
require.EqualValues(t, mdata.Get("header"), expectedHeader)
require.Equal(t, len(mdata.Get("User-Agent")), 1)
require.Contains(t, mdata.Get("User-Agent")[0], "Collector/1.2.3test")
}

func TestSendTraceDataServerDownAndUp(t *testing.T) {
Expand Down Expand Up @@ -547,6 +557,8 @@ func TestSendLogData(t *testing.T) {
},
}
set := componenttest.NewNopExporterCreateSettings()
set.BuildInfo.Description = "Collector"
set.BuildInfo.Version = "1.2.3test"
exp, err := factory.CreateLogsExporter(context.Background(), set, cfg)
require.NoError(t, err)
require.NotNil(t, exp)
Expand Down Expand Up @@ -588,4 +600,8 @@ func TestSendLogData(t *testing.T) {
assert.EqualValues(t, 2, atomic.LoadInt32(&rcv.requestCount))
assert.EqualValues(t, 2, atomic.LoadInt32(&rcv.totalItems))
assert.EqualValues(t, ld, rcv.GetLastRequest())

md := rcv.GetMetadata()
require.Equal(t, len(md.Get("User-Agent")), 1)
require.Contains(t, md.Get("User-Agent")[0], "Collector/1.2.3test")
}
6 changes: 3 additions & 3 deletions exporter/otlphttpexporter/factory.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func createTracesExporter(
set component.ExporterCreateSettings,
cfg config.Exporter,
) (component.TracesExporter, error) {
oce, err := newExporter(cfg, set.Logger)
oce, err := newExporter(cfg, set.Logger, set.BuildInfo)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -105,7 +105,7 @@ func createMetricsExporter(
set component.ExporterCreateSettings,
cfg config.Exporter,
) (component.MetricsExporter, error) {
oce, err := newExporter(cfg, set.Logger)
oce, err := newExporter(cfg, set.Logger, set.BuildInfo)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -133,7 +133,7 @@ func createLogsExporter(
set component.ExporterCreateSettings,
cfg config.Exporter,
) (component.LogsExporter, error) {
oce, err := newExporter(cfg, set.Logger)
oce, err := newExporter(cfg, set.Logger, set.BuildInfo)
if err != nil {
return nil, err
}
Expand Down
27 changes: 24 additions & 3 deletions exporter/otlphttpexporter/otlp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ type exporter struct {
metricsURL string
logsURL string
logger *zap.Logger
buildInfo component.BuildInfo
}

const (
Expand All @@ -57,7 +58,7 @@ const (
)

// Crete new exporter.
func newExporter(cfg config.Exporter, logger *zap.Logger) (*exporter, error) {
func newExporter(cfg config.Exporter, logger *zap.Logger, buildInfo component.BuildInfo) (*exporter, error) {
oCfg := cfg.(*Config)

if oCfg.Endpoint != "" {
Expand All @@ -69,8 +70,9 @@ func newExporter(cfg config.Exporter, logger *zap.Logger) (*exporter, error) {

// client construction is deferred to start
return &exporter{
config: oCfg,
logger: logger,
config: oCfg,
logger: logger,
buildInfo: buildInfo,
}, nil
}

Expand All @@ -82,6 +84,8 @@ func (e *exporter) start(_ context.Context, host component.Host) error {
return err
}

client.Transport = NewUserAgentRoundTripper(client.Transport, exporterhelper.DefaultUserAgent(e.buildInfo))
jpkrohling marked this conversation as resolved.
Show resolved Hide resolved

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can configure "CustomRoundTripper" which is not a user config.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted, that sounds like exactly what I want here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0b44ddf

if e.config.Compression != "" {
if strings.ToLower(e.config.Compression) == configgrpc.CompressionGzip {
client.Transport = middleware.NewCompressRoundTripper(client.Transport)
Expand Down Expand Up @@ -213,3 +217,20 @@ func readResponse(resp *http.Response) *status.Status {

return respStatus
}

type UserAgentRoundTripper struct {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why public?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This type will be removed in favor of CustomRoundTripper

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out I did need this as a receiver still -- but it is private now
0b44ddf

next http.RoundTripper
userAgent string
}

func NewUserAgentRoundTripper(next http.RoundTripper, userAgent string) *UserAgentRoundTripper {
return &UserAgentRoundTripper{
next,
userAgent,
}
}

func (r *UserAgentRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
req.Header.Set("User-Agent", r.userAgent)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You cannot do this, https://pkg.go.dev/net/http#RoundTripper

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you referring to the request modification? This is exactly what the HTTP client is doing currently: https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/confighttp/confighttp.go#L124 (not to say that it makes it valid)

The compression roundtripper (same method, below) makes a copy of the request, then modifies the body and headers. Would that be acceptable here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0b44ddf

return r.next.RoundTrip(req)
}
Loading