Skip to content

Commit

Permalink
Add support for :authority pseudo-header for grpc client (#8228)
Browse files Browse the repository at this point in the history
This adds support for configuring `authority` dial option for grpc
exporter
  • Loading branch information
enuret authored Aug 17, 2023
1 parent ebed8dd commit 2e4f1ef
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .chloggen/otlp_with_authority.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: configgrpc

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Add support for :authority pseudo-header in grpc client"

# One or more tracking issues or pull requests related to the change
issues: [8228]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
8 changes: 8 additions & 0 deletions config/configgrpc/configgrpc.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ type GRPCClientSettings struct {
// https://github.com/grpc/grpc-go/blob/master/examples/features/load_balancing/README.md
BalancerName string `mapstructure:"balancer_name"`

// WithAuthority parameter configures client to rewrite ":authority" header
// (godoc.org/google.golang.org/grpc#WithAuthority)
Authority string `mapstructure:"authority"`

// Auth configuration for outgoing RPCs.
Auth *configauth.Authentication `mapstructure:"auth"`
}
Expand Down Expand Up @@ -247,6 +251,10 @@ func (gcs *GRPCClientSettings) toDialOptions(host component.Host, settings compo
opts = append(opts, grpc.WithDefaultServiceConfig(fmt.Sprintf(`{"loadBalancingPolicy":"%s"}`, gcs.BalancerName)))
}

if gcs.Authority != "" {
opts = append(opts, grpc.WithAuthority(gcs.Authority))
}

otelOpts := []otelgrpc.Option{
otelgrpc.WithTracerProvider(settings.TracerProvider),
otelgrpc.WithMeterProvider(settings.MeterProvider),
Expand Down
5 changes: 4 additions & 1 deletion config/configgrpc/configgrpc_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
WriteBufferSize: 1024,
WaitForReady: true,
BalancerName: "round_robin",
Authority: "pseudo-authority",
Auth: &configauth.Authentication{AuthenticatorID: component.NewID("testauth")},
},
host: &mockHost{
Expand Down Expand Up @@ -108,6 +109,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
WriteBufferSize: 1024,
WaitForReady: true,
BalancerName: "round_robin",
Authority: "pseudo-authority",
Auth: &configauth.Authentication{AuthenticatorID: component.NewID("testauth")},
},
host: &mockHost{
Expand Down Expand Up @@ -136,6 +138,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
WriteBufferSize: 1024,
WaitForReady: true,
BalancerName: "round_robin",
Authority: "pseudo-authority",
Auth: &configauth.Authentication{AuthenticatorID: component.NewID("testauth")},
},
host: &mockHost{
Expand All @@ -149,7 +152,7 @@ func TestAllGrpcClientSettings(t *testing.T) {
t.Run(test.name, func(t *testing.T) {
opts, err := test.settings.toDialOptions(test.host, tt.TelemetrySettings)
assert.NoError(t, err)
assert.Len(t, opts, 9)
assert.Len(t, opts, 10)
})
}
}
Expand Down

0 comments on commit 2e4f1ef

Please sign in to comment.