-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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.
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
Add query service with OTLP #3086
Merged
pavolloffay
merged 16 commits into
jaegertracing:master
from
pavolloffay:otel-query-api
Jul 13, 2021
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
e8083b9
Add query service with OTLP
pavolloffay eb20c77
Fix issues
pavolloffay cdcf987
use TLS
pavolloffay c370a27
Test TLS in grpc gateway
pavolloffay a1055c8
annoying
pavolloffay 49ca286
Fix
pavolloffay 720bcf7
return error
pavolloffay 5fd2b72
fix
pavolloffay b66da70
Fix
pavolloffay 2d25ea6
update idl
pavolloffay 627cd28
Fix
pavolloffay 2734142
Handle cancelation
pavolloffay 5ddba04
Fix vet
pavolloffay 0e983b8
Add test and remove swagger
pavolloffay 2e5f644
Change comment
pavolloffay 0b215b3
Fix review comments
pavolloffay File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't there a ticket in OTEL to export that package? It do we not want to use it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't see any open issue. It has been private from the get-go.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a similar process in Tempo which is here:
https://github.com/grafana/tempo/blob/main/Makefile#L129
We have also since forked the collector and written a script to just rename
internal=>externalso we can have access to more of the otel guts. We will probably move to using this soon instead of our current setup.https://github.com/grafana/opentelemetry-collector/tree/0.29-grafana
It used to be exposed b/c Tempo vendored it initially. They moved it internal and we asked about keeping it exposed. They opted to keep it internal to protect themselves from people forming a dependency on it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't see it being open, but good to know. Perhaps they have reasons to keep it intenal. They even spent a lot of time on the (ugly) pdata package to make that happen.