-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add query service with OTLP Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Fix issues Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * use TLS Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Test TLS in grpc gateway Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * annoying Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Fix Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * return error Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * fix Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Fix Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * update idl Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Fix Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Handle cancelation Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Fix vet Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Add test and remove swagger Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Change comment Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Fix review comments Signed-off-by: Pavol Loffay <p.loffay@gmail.com>
- Loading branch information
1 parent
e7d7eb7
commit 29b6016
Showing
19 changed files
with
4,236 additions
and
47 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,4 +34,6 @@ cmd/docs/*.1 | |
cmd/docs/*.yaml | ||
crossdock/crossdock-* | ||
run-crossdock.log | ||
proto-gen/.patched-otel-proto/ | ||
__pycache__ | ||
|
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,51 @@ | ||
// Copyright (c) 2021 The Jaeger 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 apiv3 | ||
|
||
import ( | ||
"context" | ||
"net/http" | ||
|
||
"github.com/gorilla/mux" | ||
"github.com/grpc-ecosystem/grpc-gateway/runtime" | ||
"go.uber.org/zap" | ||
"google.golang.org/grpc" | ||
"google.golang.org/grpc/credentials" | ||
|
||
"github.com/jaegertracing/jaeger/pkg/config/tlscfg" | ||
"github.com/jaegertracing/jaeger/proto-gen/api_v3" | ||
) | ||
|
||
// RegisterGRPCGateway registers api_v3 endpoints into provided mux. | ||
func RegisterGRPCGateway(ctx context.Context, logger *zap.Logger, r *mux.Router, basePath string, grpcEndpoint string, grpcTLS tlscfg.Options) error { | ||
jsonpb := &runtime.JSONPb{} | ||
grpcGatewayMux := runtime.NewServeMux( | ||
runtime.WithMarshalerOption(runtime.MIMEWildcard, jsonpb), | ||
) | ||
r.PathPrefix("/v3/").Handler(http.StripPrefix(basePath, grpcGatewayMux)) | ||
|
||
var dialOpts []grpc.DialOption | ||
if grpcTLS.Enabled { | ||
tlsCfg, err := grpcTLS.Config(logger) | ||
if err != nil { | ||
return err | ||
} | ||
creds := credentials.NewTLS(tlsCfg) | ||
dialOpts = append(dialOpts, grpc.WithTransportCredentials(creds)) | ||
} else { | ||
dialOpts = append(dialOpts, grpc.WithInsecure()) | ||
} | ||
return api_v3.RegisterQueryServiceHandlerFromEndpoint(ctx, grpcGatewayMux, grpcEndpoint, dialOpts) | ||
} |
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,143 @@ | ||
// Copyright (c) 2021 The Jaeger 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 apiv3 | ||
|
||
import ( | ||
"bytes" | ||
"context" | ||
"encoding/json" | ||
"fmt" | ||
"net" | ||
"net/http" | ||
"strings" | ||
"testing" | ||
|
||
"github.com/gorilla/mux" | ||
"github.com/grpc-ecosystem/grpc-gateway/runtime" | ||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/mock" | ||
"github.com/stretchr/testify/require" | ||
"go.uber.org/zap" | ||
"google.golang.org/grpc" | ||
"google.golang.org/grpc/credentials" | ||
|
||
"github.com/jaegertracing/jaeger/cmd/query/app/querysvc" | ||
"github.com/jaegertracing/jaeger/model" | ||
"github.com/jaegertracing/jaeger/pkg/config/tlscfg" | ||
_ "github.com/jaegertracing/jaeger/pkg/gogocodec" //force gogo codec registration | ||
"github.com/jaegertracing/jaeger/proto-gen/api_v3" | ||
dependencyStoreMocks "github.com/jaegertracing/jaeger/storage/dependencystore/mocks" | ||
spanstoremocks "github.com/jaegertracing/jaeger/storage/spanstore/mocks" | ||
) | ||
|
||
var testCertKeyLocation = "../../../../pkg/config/tlscfg/testdata/" | ||
|
||
func testGRPCGateway(t *testing.T, serverTLS tlscfg.Options, clientTLS tlscfg.Options) { | ||
defer serverTLS.Close() | ||
defer clientTLS.Close() | ||
|
||
r := &spanstoremocks.Reader{} | ||
traceID := model.NewTraceID(150, 160) | ||
r.On("GetTrace", mock.AnythingOfType("*context.valueCtx"), mock.AnythingOfType("model.TraceID")).Return( | ||
&model.Trace{ | ||
Spans: []*model.Span{ | ||
{ | ||
TraceID: traceID, | ||
SpanID: model.NewSpanID(180), | ||
OperationName: "foobar", | ||
}, | ||
}, | ||
}, nil).Once() | ||
|
||
q := querysvc.NewQueryService(r, &dependencyStoreMocks.Reader{}, querysvc.QueryServiceOptions{}) | ||
|
||
var serverGRPCOpts []grpc.ServerOption | ||
if serverTLS.Enabled { | ||
config, err := serverTLS.Config(zap.NewNop()) | ||
require.NoError(t, err) | ||
creds := credentials.NewTLS(config) | ||
serverGRPCOpts = append(serverGRPCOpts, grpc.Creds(creds)) | ||
} | ||
grpcServer := grpc.NewServer(serverGRPCOpts...) | ||
h := &Handler{ | ||
QueryService: q, | ||
} | ||
api_v3.RegisterQueryServiceServer(grpcServer, h) | ||
lis, _ := net.Listen("tcp", ":0") | ||
go func() { | ||
err := grpcServer.Serve(lis) | ||
require.NoError(t, err) | ||
}() | ||
defer grpcServer.Stop() | ||
|
||
router := &mux.Router{} | ||
ctx, cancel := context.WithCancel(context.Background()) | ||
defer cancel() | ||
err := RegisterGRPCGateway(ctx, zap.NewNop(), router, "", lis.Addr().String(), clientTLS) | ||
require.NoError(t, err) | ||
|
||
httpLis, err := net.Listen("tcp", ":0") | ||
require.NoError(t, err) | ||
httpServer := &http.Server{ | ||
Handler: router, | ||
} | ||
go func() { | ||
err = httpServer.Serve(httpLis) | ||
require.Equal(t, http.ErrServerClosed, err) | ||
}() | ||
defer httpServer.Shutdown(context.Background()) | ||
req, err := http.NewRequest("GET", fmt.Sprintf("http://localhost%s/v3/traces/123", strings.Replace(httpLis.Addr().String(), "[::]", "", 1)), nil) | ||
req.Header.Set("Content-Type", "application/json") | ||
response, err := http.DefaultClient.Do(req) | ||
buf := bytes.Buffer{} | ||
_, err = buf.ReadFrom(response.Body) | ||
require.NoError(t, err) | ||
|
||
jsonpb := &runtime.JSONPb{} | ||
var envelope envelope | ||
err = json.Unmarshal(buf.Bytes(), &envelope) | ||
require.NoError(t, err) | ||
var spansResponse api_v3.SpansResponseChunk | ||
err = jsonpb.Unmarshal(envelope.Result, &spansResponse) | ||
require.NoError(t, err) | ||
assert.Equal(t, 1, len(spansResponse.GetResourceSpans())) | ||
assert.Equal(t, uint64ToTraceID(traceID.High, traceID.Low), spansResponse.GetResourceSpans()[0].GetInstrumentationLibrarySpans()[0].GetSpans()[0].GetTraceId()) | ||
} | ||
|
||
func TestGRPCGateway(t *testing.T) { | ||
testGRPCGateway(t, tlscfg.Options{}, tlscfg.Options{}) | ||
} | ||
|
||
func TestGRPCGateway_TLS(t *testing.T) { | ||
serverTLS := tlscfg.Options{ | ||
Enabled: true, | ||
CAPath: testCertKeyLocation + "/example-CA-cert.pem", | ||
CertPath: testCertKeyLocation + "/example-server-cert.pem", | ||
KeyPath: testCertKeyLocation + "/example-server-key.pem", | ||
} | ||
clientTLS := tlscfg.Options{ | ||
Enabled: true, | ||
CAPath: testCertKeyLocation + "/example-CA-cert.pem", | ||
CertPath: testCertKeyLocation + "/example-client-cert.pem", | ||
KeyPath: testCertKeyLocation + "/example-client-key.pem", | ||
ServerName: "example.com", | ||
} | ||
testGRPCGateway(t, serverTLS, clientTLS) | ||
} | ||
|
||
// For more details why this is needed see https://github.com/grpc-ecosystem/grpc-gateway/issues/2189 | ||
type envelope struct { | ||
Result json.RawMessage `json:"result"` | ||
} |
Oops, something went wrong.