-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…12788) * jaegerremotesampling: set transport in grpc default config Signed-off-by: Benedikt Bongartz <bongartz@klimlive.de> * jaegerremotesampling: first grpc server draft Signed-off-by: Benedikt Bongartz <bongartz@klimlive.de> * jaegerremotesampling: register grpc server Signed-off-by: Benedikt Bongartz <bongartz@klimlive.de> * unreleased: add changelog Signed-off-by: Benedikt Bongartz <bongartz@klimlive.de>
- Loading branch information
Showing
9 changed files
with
307 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| // 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 internal // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/jaegerremotesampling/internal" | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "net" | ||
|
|
||
| "github.com/jaegertracing/jaeger/cmd/collector/app/sampling" | ||
| "github.com/jaegertracing/jaeger/cmd/collector/app/sampling/strategystore" | ||
| "github.com/jaegertracing/jaeger/proto-gen/api_v2" | ||
| "go.uber.org/zap" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/health" | ||
| "google.golang.org/grpc/health/grpc_health_v1" | ||
| "google.golang.org/grpc/reflection" | ||
|
|
||
| "go.opentelemetry.io/collector/component" | ||
| "go.opentelemetry.io/collector/config/configgrpc" | ||
| ) | ||
|
|
||
| var _ component.Component = (*SamplingGRPCServer)(nil) | ||
|
|
||
| var errGRPCServerNotRunning = errors.New("gRPC server is not running") | ||
|
|
||
| type grpcServer interface { | ||
| Serve(lis net.Listener) error | ||
| GracefulStop() | ||
| Stop() | ||
| } | ||
|
|
||
| // NewGRPC returns a new sampling gRPC Server. | ||
| func NewGRPC( | ||
| telemetry component.TelemetrySettings, | ||
| settings configgrpc.GRPCServerSettings, | ||
| strategyStore strategystore.StrategyStore, | ||
| ) (*SamplingGRPCServer, error) { | ||
| if strategyStore == nil { | ||
| return nil, errMissingStrategyStore | ||
| } | ||
|
|
||
| return &SamplingGRPCServer{ | ||
| telemetry: telemetry, | ||
| settings: settings, | ||
| strategyStore: strategyStore, | ||
| }, nil | ||
| } | ||
|
|
||
| // SamplingGRPCServer implements component.Component to make the life cycle easy to manage. | ||
| type SamplingGRPCServer struct { | ||
| telemetry component.TelemetrySettings | ||
| settings configgrpc.GRPCServerSettings | ||
| strategyStore strategystore.StrategyStore | ||
|
|
||
| grpcServer grpcServer | ||
| } | ||
|
|
||
| func (s *SamplingGRPCServer) Start(_ context.Context, host component.Host) error { | ||
| opts, err := s.settings.ToServerOption(host, s.telemetry) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| server := grpc.NewServer(opts...) | ||
| reflection.Register(server) | ||
| s.grpcServer = server | ||
|
|
||
| api_v2.RegisterSamplingManagerServer(server, sampling.NewGRPCHandler(s.strategyStore)) | ||
|
|
||
| healthServer := health.NewServer() | ||
| healthServer.SetServingStatus("jaeger.api_v2.SamplingManager", grpc_health_v1.HealthCheckResponse_SERVING) | ||
| grpc_health_v1.RegisterHealthServer(server, healthServer) | ||
|
|
||
| listener, err := s.settings.ToListener() | ||
| if err != nil { | ||
| return fmt.Errorf("failed to listen on gRPC port: %w", err) | ||
| } | ||
|
|
||
| go func() { | ||
| if err := s.grpcServer.Serve(listener); err != nil { | ||
| s.telemetry.Logger.Error("could not launch gRPC service", zap.Error(err)) | ||
| } | ||
| }() | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // Shutdown tries to terminate connections gracefully as long as the passed context is valid. | ||
| func (s *SamplingGRPCServer) Shutdown(ctx context.Context) error { | ||
| if s.grpcServer == nil { | ||
| return errGRPCServerNotRunning | ||
| } | ||
|
|
||
| ch := make(chan struct{}) | ||
| go func() { | ||
| s.grpcServer.GracefulStop() | ||
| ch <- struct{}{} | ||
| }() | ||
|
|
||
| select { | ||
| case <-ctx.Done(): | ||
| s.grpcServer.Stop() | ||
| case <-ch: | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // 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 internal | ||
|
|
||
| import ( | ||
| "context" | ||
| "net" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "go.opentelemetry.io/collector/component/componenttest" | ||
| "go.opentelemetry.io/collector/config/configgrpc" | ||
| "go.opentelemetry.io/collector/config/confignet" | ||
| ) | ||
|
|
||
| func TestMissingClientConfigManagerGRPC(t *testing.T) { | ||
| s, err := NewGRPC(componenttest.NewNopTelemetrySettings(), configgrpc.GRPCServerSettings{}, nil) | ||
| assert.Equal(t, errMissingStrategyStore, err) | ||
| assert.Nil(t, s) | ||
| } | ||
|
|
||
| func TestStartAndStopGRPC(t *testing.T) { | ||
| // prepare | ||
| srvSettings := configgrpc.GRPCServerSettings{ | ||
| NetAddr: confignet.NetAddr{ | ||
| Endpoint: ":0", | ||
| Transport: "tcp", | ||
| }, | ||
| } | ||
| s, err := NewGRPC(componenttest.NewNopTelemetrySettings(), srvSettings, &mockCfgMgr{}) | ||
| require.NoError(t, err) | ||
| require.NotNil(t, s) | ||
|
|
||
| // test | ||
| assert.NoError(t, s.Start(context.Background(), componenttest.NewNopHost())) | ||
| assert.NoError(t, s.Shutdown(context.Background())) | ||
| } | ||
|
|
||
| func TestSamplingGRPCServer_Shutdown(t *testing.T) { | ||
| tt := []struct { | ||
| name string | ||
| grpcServer grpcServer | ||
| timeout time.Duration | ||
| expect error | ||
| }{ | ||
| { | ||
| name: "graceful stop is successful without delay", | ||
| grpcServer: &grpcServerMock{}, | ||
| timeout: time.Minute, | ||
| }, | ||
| { | ||
| name: "graceful stop is successful with delay", | ||
| grpcServer: &grpcServerMock{ | ||
| timeToGracefulStop: 5 * time.Second, | ||
| }, | ||
| timeout: time.Minute, | ||
| }, | ||
| { | ||
| name: "context timed out", | ||
| grpcServer: &grpcServerMock{ | ||
| timeToGracefulStop: time.Minute, | ||
| }, | ||
| timeout: 5 * time.Second, | ||
| }, | ||
| { | ||
| name: "grpc server not started", | ||
| timeout: time.Minute, | ||
| expect: errGRPCServerNotRunning, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range tt { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| srv := &SamplingGRPCServer{grpcServer: tc.grpcServer} | ||
| ctx, cancel := context.WithTimeout(context.Background(), tc.timeout) | ||
| defer cancel() | ||
| assert.Equal(t, tc.expect, srv.Shutdown(ctx)) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| type grpcServerMock struct { | ||
| timeToGracefulStop time.Duration | ||
| } | ||
|
|
||
| func (g *grpcServerMock) Serve(lis net.Listener) error { return nil } | ||
| func (g *grpcServerMock) Stop() {} | ||
| func (g *grpcServerMock) GracefulStop() { time.Sleep(g.timeToGracefulStop) } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| // 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 internal | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/jaegertracing/jaeger/thrift-gen/sampling" | ||
| ) | ||
|
|
||
| type mockCfgMgr struct { | ||
| getSamplingStrategyFunc func(ctx context.Context, serviceName string) (*sampling.SamplingStrategyResponse, error) | ||
| } | ||
|
|
||
| func (m *mockCfgMgr) GetSamplingStrategy(ctx context.Context, serviceName string) (*sampling.SamplingStrategyResponse, error) { | ||
| if m.getSamplingStrategyFunc != nil { | ||
| return m.getSamplingStrategyFunc(ctx, serviceName) | ||
| } | ||
| return sampling.NewSamplingStrategyResponse(), nil | ||
| } |
Oops, something went wrong.