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

Jump to bottom

Enable gRPC reflection service on collector/query #3526

Merged
merged 10 commits into from
Feb 13, 2022
Merged

Enable gRPC reflection service on collector/query #3526

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d8a3bc1
Enable gRPC reflection service on collector/query
yurishkuro Feb 13, 2022
b47e7b8
fix
yurishkuro Feb 13, 2022
c9ff132
refactor
yurishkuro Feb 13, 2022
2880802
more validation
yurishkuro Feb 13, 2022
fd3dba6
coverage
yurishkuro Feb 13, 2022
910abee
simplify
yurishkuro Feb 13, 2022
a413374
use OOP
yurishkuro Feb 13, 2022
90035eb
rename
yurishkuro Feb 13, 2022
1fef34a
rename
yurishkuro Feb 13, 2022
398c2a7
Merge branch 'main' into grpc-reflection
yurishkuro Feb 13, 2022
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
19 changes: 12 additions & 7 deletions cmd/collector/app/server/grpc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/keepalive"
"google.golang.org/grpc/reflection"

"github.com/jaegertracing/jaeger/cmd/collector/app/handler"
"github.com/jaegertracing/jaeger/cmd/collector/app/sampling"
Expand All @@ -42,14 +43,19 @@ type GRPCServerParams struct {
MaxReceiveMessageLength int
MaxConnectionAge time.Duration
MaxConnectionAgeGrace time.Duration

// Set by the server to indicate the actual host:port of the server.
HostPortActual string
}

// StartGRPCServer based on the given parameters
func StartGRPCServer(params *GRPCServerParams) (*grpc.Server, error) {
var server *grpc.Server
var grpcOpts []grpc.ServerOption

grpcOpts = append(grpcOpts, grpc.MaxRecvMsgSize(params.MaxReceiveMessageLength))
if params.MaxReceiveMessageLength > 0 {
grpcOpts = append(grpcOpts, grpc.MaxRecvMsgSize(params.MaxReceiveMessageLength))
Copy link
Member Author

Choose a reason for hiding this comment

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

Adding a 0 value as option actually breaks gRPC message handling/ I guess it wasn't a problem in prod code since the default comes from a CLI flag, but in tests it was annoying having to keep setting this param.

}
grpcOpts = append(grpcOpts, grpc.KeepaliveParams(keepalive.ServerParameters{
MaxConnectionAge: params.MaxConnectionAge,
MaxConnectionAgeGrace: params.MaxConnectionAgeGrace,
Expand All @@ -64,17 +70,16 @@ func StartGRPCServer(params *GRPCServerParams) (*grpc.Server, error) {

creds := credentials.NewTLS(tlsCfg)
grpcOpts = append(grpcOpts, grpc.Creds(creds))

server = grpc.NewServer(grpcOpts...)
} else {
// server without TLS
server = grpc.NewServer(grpcOpts...)
}

server = grpc.NewServer(grpcOpts...)
reflection.Register(server)

listener, err := net.Listen("tcp", params.HostPort)
if err != nil {
return nil, fmt.Errorf("failed to listen on gRPC port: %w", err)
}
params.HostPortActual = listener.Addr().String()

if err := serveGRPC(server, listener, params); err != nil {
return nil, err
Expand All @@ -87,7 +92,7 @@ func serveGRPC(server *grpc.Server, listener net.Listener, params *GRPCServerPar
api_v2.RegisterCollectorServiceServer(server, params.Handler)
api_v2.RegisterSamplingManagerServer(server, sampling.NewGRPCHandler(params.SamplingStore))

params.Logger.Info("Starting jaeger-collector gRPC server", zap.String("grpc.host-port", params.HostPort))
params.Logger.Info("Starting jaeger-collector gRPC server", zap.String("grpc.host-port", params.HostPortActual))
go func() {
if err := server.Serve(listener); err != nil {
params.Logger.Error("Could not launch gRPC service", zap.Error(err))
Expand Down
65 changes: 49 additions & 16 deletions cmd/collector/app/server/grpc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ package server

import (
"context"
"net"
"sync"
"testing"

Expand All @@ -27,6 +26,7 @@ import (
"go.uber.org/zap/zaptest/observer"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/reflection/grpc_reflection_v1alpha"
"google.golang.org/grpc/test/bufconn"

"github.com/jaegertracing/jaeger/cmd/collector/app/handler"
Expand Down Expand Up @@ -71,21 +71,20 @@ func TestFailServe(t *testing.T) {
func TestSpanCollector(t *testing.T) {
logger, _ := zap.NewDevelopment()
params := &GRPCServerParams{
Handler: handler.NewGRPCHandler(logger, &mockSpanProcessor{}),
SamplingStore: &mockSamplingStore{},
Logger: logger,
HostPort: ":0",
yurishkuro marked this conversation as resolved.
Show resolved Hide resolved
Handler: handler.NewGRPCHandler(logger, &mockSpanProcessor{}),
SamplingStore: &mockSamplingStore{},
Logger: logger,
MaxReceiveMessageLength: 1024 * 1024,
Copy link
Member Author

Choose a reason for hiding this comment

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

made this the only place where param is initialized in tests, to have code coverage for the if statement

}

server := grpc.NewServer()
defer server.Stop()

listener, err := net.Listen("tcp", ":0")
Copy link
Member Author

@yurishkuro yurishkuro Feb 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

removed manual setup, using official StartGRPCServer

server, err := StartGRPCServer(params)
require.NoError(t, err)
defer listener.Close()

serveGRPC(server, listener, params)
defer server.Stop()

conn, err := grpc.Dial(listener.Addr().String(), grpc.WithTransportCredentials(insecure.NewCredentials()))
conn, err := grpc.Dial(
params.HostPortActual,
grpc.WithTransportCredentials(insecure.NewCredentials()))
require.NoError(t, err)
defer conn.Close()

Expand All @@ -98,10 +97,9 @@ func TestSpanCollector(t *testing.T) {
func TestCollectorStartWithTLS(t *testing.T) {
logger, _ := zap.NewDevelopment()
params := &GRPCServerParams{
Handler: handler.NewGRPCHandler(logger, &mockSpanProcessor{}),
SamplingStore: &mockSamplingStore{},
Logger: logger,
MaxReceiveMessageLength: 8 * 1024 * 1024,
Handler: handler.NewGRPCHandler(logger, &mockSpanProcessor{}),
SamplingStore: &mockSamplingStore{},
Logger: logger,
TLSConfig: tlscfg.Options{
Enabled: true,
CertPath: testCertKeyLocation + "/example-server-cert.pem",
Expand All @@ -114,3 +112,38 @@ func TestCollectorStartWithTLS(t *testing.T) {
require.NoError(t, err)
defer server.Stop()
}

func TestCollectorReflection(t *testing.T) {
logger, _ := zap.NewDevelopment()
params := &GRPCServerParams{
HostPort: ":0",
Handler: handler.NewGRPCHandler(logger, &mockSpanProcessor{}),
SamplingStore: &mockSamplingStore{},
Logger: logger,
}

server, err := StartGRPCServer(params)
require.NoError(t, err)
defer server.Stop()

conn, err := grpc.Dial(
params.HostPortActual,
grpc.WithTransportCredentials(insecure.NewCredentials()))
require.NoError(t, err)
defer conn.Close()

client := grpc_reflection_v1alpha.NewServerReflectionClient(conn)
r, err := client.ServerReflectionInfo(context.Background())
require.NoError(t, err)
require.NotNil(t, r)

err = r.Send(&grpc_reflection_v1alpha.ServerReflectionRequest{
MessageRequest: &grpc_reflection_v1alpha.ServerReflectionRequest_ListServices{},
})
require.NoError(t, err)
m, err := r.Recv()
require.NoError(t, err)
require.IsType(t,
new(grpc_reflection_v1alpha.ServerReflectionResponse_ListServicesResponse),
m.MessageResponse)
}
8 changes: 7 additions & 1 deletion cmd/query/app/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (
"go.uber.org/zap/zapcore"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/reflection"

"github.com/jaegertracing/jaeger/cmd/query/app/apiv3"
"github.com/jaegertracing/jaeger/cmd/query/app/querysvc"
Expand Down Expand Up @@ -119,6 +120,7 @@ func createGRPCServer(querySvc *querysvc.QueryService, metricsQuerySvc querysvc.
}

server := grpc.NewServer(grpcOpts...)
reflection.Register(server)

handler := &GRPCHandler{
queryService: querySvc,
Expand Down Expand Up @@ -195,7 +197,11 @@ func (s *Server) initListener() (cmux.CMux, error) {
if err != nil {
return nil, err
}
s.logger.Info("Query server started")
s.logger.Info(
"Query server started",
zap.String("http_addr", s.httpConn.Addr().String()),
zap.String("grpc_addr", s.grpcConn.Addr().String()),
)
return nil, nil
}

Expand Down
36 changes: 32 additions & 4 deletions cmd/query/app/server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/reflection/grpc_reflection_v1alpha"

"github.com/jaegertracing/jaeger/cmd/flags"
"github.com/jaegertracing/jaeger/cmd/query/app/querysvc"
Expand Down Expand Up @@ -688,15 +689,42 @@ func TestServerHandlesPortZero(t *testing.T) {

querySvc := &querysvc.QueryService{}
tracer := opentracing.NoopTracer{}
server, err := NewServer(flagsSvc.Logger, querySvc, nil, &QueryOptions{GRPCHostPort: ":0", HTTPHostPort: ":0"}, tracer)
server, err := NewServer(flagsSvc.Logger, querySvc, nil,
&QueryOptions{GRPCHostPort: ":0", HTTPHostPort: ":0"},
tracer)
assert.Nil(t, err)
assert.NoError(t, server.Start())
server.Close()
defer server.Close()

message := logs.FilterMessage("Query server started")
assert.Equal(t, 1, message.Len(), "Expected query started log message.")
assert.Equal(t, 1, message.Len(), "Expected 'Query server started' log message.")

onlyEntry := message.All()[0]
port := onlyEntry.ContextMap()["port"]
port := onlyEntry.ContextMap()["port"].(int64)
assert.Greater(t, port, int64(0))

verifyGRPCReflection(t, port)
}

func verifyGRPCReflection(t *testing.T, port int64) {
conn, err := grpc.Dial(
fmt.Sprintf(":%v", port),
grpc.WithTransportCredentials(insecure.NewCredentials()))
require.NoError(t, err)
defer conn.Close()

client := grpc_reflection_v1alpha.NewServerReflectionClient(conn)
r, err := client.ServerReflectionInfo(context.Background())
require.NoError(t, err)
require.NotNil(t, r)

err = r.Send(&grpc_reflection_v1alpha.ServerReflectionRequest{
MessageRequest: &grpc_reflection_v1alpha.ServerReflectionRequest_ListServices{},
})
require.NoError(t, err)
m, err := r.Recv()
require.NoError(t, err)
require.IsType(t,
new(grpc_reflection_v1alpha.ServerReflectionResponse_ListServicesResponse),
m.MessageResponse)
}