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

gcp/observability: Implement tracing/metrics via OpenCensus #5372

Merged
merged 4 commits into from Jun 7, 2022
Merged

gcp/observability: Implement tracing/metrics via OpenCensus #5372

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
88cccaa
o11y: Implement tracing/metrics via OpenCensus
lidizheng Jun 3, 2022
7e8d3a7
Update docstring of observability.Start
lidizheng Jun 3, 2022
8e534c6
Adopt reviewer's suggestions
lidizheng Jun 7, 2022
4ffd906
Use []error instead of several individual variables
lidizheng Jun 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion gcp/observability/observability.go
View file
Open in desktop
Expand Up @@ -65,7 +65,7 @@ func Start(ctx context.Context) error {

// Enabling tracing and metrics via OpenCensus
if err := startOpenCensus(config, nil); err != nil {
return err
return fmt.Errorf("failed to instrument OpenCensus: %v", err)
}

// Logging is controlled by the config at methods level.
Expand Down
61 changes: 22 additions & 39 deletions gcp/observability/observability_test.go
View file
Open in desktop
Expand Up @@ -464,14 +464,10 @@ func (s) TestLoggingForErrorCall(t *testing.T) {
te.startServer(&testServer{})
tc := testgrpc.NewTestServiceClient(te.clientConn())

var (
req *testpb.SimpleRequest
err error
)
req = &testpb.SimpleRequest{Payload: &testpb.Payload{Body: testErrorPayload}}
req := &testpb.SimpleRequest{Payload: &testpb.Payload{Body: testErrorPayload}}
tCtx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
defer cancel()
_, err = tc.UnaryCall(metadata.NewOutgoingContext(tCtx, testHeaderMetadata), req)
_, err := tc.UnaryCall(metadata.NewOutgoingContext(tCtx, testHeaderMetadata), req)
if err == nil {
t.Fatalf("unary call expected to fail, but passed")
}
Expand Down Expand Up @@ -528,15 +524,10 @@ func (s) TestEmptyConfig(t *testing.T) {
te.startServer(&testServer{})
tc := testgrpc.NewTestServiceClient(te.clientConn())

var (
resp *testpb.SimpleResponse
req *testpb.SimpleRequest
err error
)
req = &testpb.SimpleRequest{Payload: &testpb.Payload{Body: testOkPayload}}
req := &testpb.SimpleRequest{Payload: &testpb.Payload{Body: testOkPayload}}
tCtx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
defer cancel()
resp, err = tc.UnaryCall(metadata.NewOutgoingContext(tCtx, testHeaderMetadata), req)
resp, err := tc.UnaryCall(metadata.NewOutgoingContext(tCtx, testHeaderMetadata), req)
if err != nil {
t.Fatalf("unary call failed: %v", err)
}
Expand Down Expand Up @@ -706,17 +697,11 @@ func (s) TestOpenCensusIntegration(t *testing.T) {
te.startServer(&testServer{})
tc := testgrpc.NewTestServiceClient(te.clientConn())

var (
req *testpb.SimpleRequest
err error

validClientViews, validServerViews, validSpans bool
)
for i := 0; i < defaultRequestCount; i++ {
req = &testpb.SimpleRequest{Payload: &testpb.Payload{Body: testOkPayload}}
req := &testpb.SimpleRequest{Payload: &testpb.Payload{Body: testOkPayload}}
tCtx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
defer cancel()
_, err = tc.UnaryCall(metadata.NewOutgoingContext(tCtx, testHeaderMetadata), req)
_, err := tc.UnaryCall(metadata.NewOutgoingContext(tCtx, testHeaderMetadata), req)
if err != nil {
t.Fatalf("unary call failed: %v", err)
}
Expand All @@ -727,32 +712,30 @@ func (s) TestOpenCensusIntegration(t *testing.T) {
te.cc.Close()
te.srv.GracefulStop()

deadline := time.Now().Add(defaultTestTimeout)
for time.Now().Before(deadline) {
validClientViews = false
validServerViews = false
validSpans = false
var clientViewsError, serverViewsError, spansError error
Copy link
Member

Choose a reason for hiding this comment

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

How about var errs []error? It might be simpler. (Or []string would work for this, too.)

var errs []error
for ctx.Err() == nil {
	errs = nil
	if ...; value != TypeOpenCensusViewCount {
		errs = append(errs, fmt.Errorf("this error %v", value))
	}
	...
	if len(errs) == 0 {
		break
	}
}
if len(errs) > 0 {
	t.Fatalf("Invalid OpenCensus export data: %v", errs)
}

ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
defer cancel()
for ctx.Err() == nil {
clientViewsError = nil
serverViewsError = nil
spansError = nil
te.fe.mu.RLock()
if value, ok := te.fe.SeenViews["grpc.io/client/completed_rpcs"]; ok {
if value == TypeOpenCensusViewCount {
validClientViews = true
}
if value := te.fe.SeenViews["grpc.io/client/completed_rpcs"]; value != TypeOpenCensusViewCount {
clientViewsError = fmt.Errorf("unexpected type for grpc.io/client/completed_rpcs: %s != %s", value, TypeOpenCensusViewCount)
}
if value, ok := te.fe.SeenViews["grpc.io/server/completed_rpcs"]; ok {
if value == TypeOpenCensusViewCount {
validServerViews = true
}
if value := te.fe.SeenViews["grpc.io/server/completed_rpcs"]; value != TypeOpenCensusViewCount {
serverViewsError = fmt.Errorf("unexpected type for grpc.io/server/completed_rpcs: %s != %s", value, TypeOpenCensusViewCount)
}
if te.fe.SeenSpans > 0 {
validSpans = true
if te.fe.SeenSpans <= 0 {
spansError = fmt.Errorf("unexpected number of seen spans: %v <= 0", te.fe.SeenSpans)
}
te.fe.mu.RUnlock()
if validClientViews && validServerViews && validSpans {
if clientViewsError == nil && serverViewsError == nil && spansError == nil {
break
}
time.Sleep(100 * time.Millisecond)
}
if !validClientViews || !validServerViews || !validSpans {
t.Fatalf("Invalid OpenCensus export data: validClientViews=%v validServerViews=%v validSpans=%v", validClientViews, validServerViews, validSpans)
if clientViewsError != nil || serverViewsError != nil || spansError != nil {
t.Fatalf("Invalid OpenCensus export data: clientViewsError=%v; serverViewsError=%v; spansError=%v", clientViewsError, serverViewsError, spansError)
}
}
6 changes: 2 additions & 4 deletions gcp/observability/opencensus.go
View file
Open in desktop
Expand Up @@ -47,14 +47,11 @@ func startOpenCensus(config *configpb.ObservabilityConfig, exporter interface{})
return nil
}

var (
so trace.StartOptions
err error
)
if exporter == nil {
// Create the Stackdriver exporter, which is shared between tracing and stats
mr := monitoredresource.Autodetect()
logger.Infof("Detected MonitoredResource:: %+v", mr)
var err error
if exporter, err = stackdriver.NewExporter(stackdriver.Options{
ProjectID: config.DestinationProjectId,
MonitoredResource: mr,
Expand All @@ -63,6 +60,7 @@ func startOpenCensus(config *configpb.ObservabilityConfig, exporter interface{})
}
}

var so trace.StartOptions
if config.EnableCloudTrace {
so.Sampler = trace.ProbabilitySampler(config.GlobalTraceSamplingRate)
trace.RegisterExporter(exporter.(trace.Exporter))
Expand Down