-
Notifications
You must be signed in to change notification settings - Fork 9.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14348 from VinozzZ/add-integration-test-for-tracing
embed: add integration test for distributed tracing
- Loading branch information
Showing
4 changed files
with
191 additions
and
25 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| // Copyright 2022 The etcd 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 integration | ||
|
|
||
| import ( | ||
| "context" | ||
| "net" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "go.etcd.io/etcd/client/pkg/v3/testutil" | ||
| clientv3 "go.etcd.io/etcd/client/v3" | ||
| "go.etcd.io/etcd/server/v3/embed" | ||
| "go.etcd.io/etcd/tests/v3/framework/integration" | ||
| "go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc" | ||
| "go.opentelemetry.io/otel/propagation" | ||
| sdktrace "go.opentelemetry.io/otel/sdk/trace" | ||
| "go.opentelemetry.io/otel/trace" | ||
| traceservice "go.opentelemetry.io/proto/otlp/collector/trace/v1" | ||
| "google.golang.org/grpc" | ||
| ) | ||
|
|
||
| // TestTracing ensures that distributed tracing is setup when the feature flag is enabled. | ||
| func TestTracing(t *testing.T) { | ||
| testutil.SkipTestIfShortMode(t, | ||
| "Wal creation tests are depending on embedded etcd server so are integration-level tests.") | ||
| // set up trace collector | ||
| listener, err := net.Listen("tcp", "localhost:") | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| traceFound := make(chan struct{}) | ||
| defer close(traceFound) | ||
|
|
||
| srv := grpc.NewServer() | ||
| traceservice.RegisterTraceServiceServer(srv, &traceServer{ | ||
| traceFound: traceFound, | ||
| filterFunc: containsNodeListSpan}) | ||
|
|
||
| go srv.Serve(listener) | ||
| defer srv.Stop() | ||
|
|
||
| cfg := integration.NewEmbedConfig(t, "default") | ||
| cfg.ExperimentalEnableDistributedTracing = true | ||
| cfg.ExperimentalDistributedTracingAddress = listener.Addr().String() | ||
| cfg.ExperimentalDistributedTracingServiceName = "integration-test-tracing" | ||
| cfg.ExperimentalDistributedTracingSamplingRatePerMillion = 100 | ||
|
|
||
| // start an etcd instance with tracing enabled | ||
| etcdSrv, err := embed.StartEtcd(cfg) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| defer etcdSrv.Close() | ||
|
|
||
| select { | ||
| case <-etcdSrv.Server.ReadyNotify(): | ||
| case <-time.After(1 * time.Second): | ||
| t.Fatalf("failed to start embed.Etcd for test") | ||
| } | ||
|
|
||
| // create a client that has tracing enabled | ||
| tracer := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample())) | ||
| defer tracer.Shutdown(context.TODO()) | ||
| tp := trace.TracerProvider(tracer) | ||
|
|
||
| tracingOpts := []otelgrpc.Option{ | ||
| otelgrpc.WithTracerProvider(tp), | ||
| otelgrpc.WithPropagators( | ||
| propagation.NewCompositeTextMapPropagator( | ||
| propagation.TraceContext{}, | ||
| propagation.Baggage{}, | ||
| )), | ||
| } | ||
|
|
||
| dialOptions := []grpc.DialOption{ | ||
| grpc.WithUnaryInterceptor(otelgrpc.UnaryClientInterceptor(tracingOpts...)), | ||
| grpc.WithStreamInterceptor(otelgrpc.StreamClientInterceptor(tracingOpts...))} | ||
| ccfg := clientv3.Config{DialOptions: dialOptions, Endpoints: []string{cfg.ACUrls[0].String()}} | ||
| cli, err := integration.NewClient(t, ccfg) | ||
| if err != nil { | ||
| etcdSrv.Close() | ||
| t.Fatal(err) | ||
| } | ||
| defer cli.Close() | ||
|
|
||
| // make a request with the instrumented client | ||
| resp, err := cli.Get(context.TODO(), "key") | ||
| require.NoError(t, err) | ||
| require.Empty(t, resp.Kvs) | ||
|
|
||
| // Wait for a span to be recorded from our request | ||
| select { | ||
| case <-traceFound: | ||
| return | ||
| case <-time.After(30 * time.Second): | ||
| t.Fatal("Timed out waiting for trace") | ||
| } | ||
| } | ||
|
|
||
| func containsNodeListSpan(req *traceservice.ExportTraceServiceRequest) bool { | ||
| for _, resourceSpans := range req.GetResourceSpans() { | ||
| for _, attr := range resourceSpans.GetResource().GetAttributes() { | ||
| if attr.GetKey() != "service.name" && attr.GetValue().GetStringValue() != "integration-test-tracing" { | ||
| continue | ||
| } | ||
| for _, scoped := range resourceSpans.GetScopeSpans() { | ||
| for _, span := range scoped.GetSpans() { | ||
| if span.GetName() == "etcdserverpb.KV/Range" { | ||
| return true | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // traceServer implements TracesServiceServer | ||
| type traceServer struct { | ||
| traceFound chan struct{} | ||
| filterFunc func(req *traceservice.ExportTraceServiceRequest) bool | ||
| traceservice.UnimplementedTraceServiceServer | ||
| } | ||
|
|
||
| func (t *traceServer) Export(ctx context.Context, req *traceservice.ExportTraceServiceRequest) (*traceservice.ExportTraceServiceResponse, error) { | ||
| var emptyValue = traceservice.ExportTraceServiceResponse{} | ||
| if t.filterFunc(req) { | ||
| t.traceFound <- struct{}{} | ||
| } | ||
| return &emptyValue, nil | ||
| } |