refactor(go/adbc): refactor logging instrumentation into OTel tracing - part 1/3 #4655
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,179 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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 flightsql | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/hex" | ||
| "fmt" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/apache/arrow-go/v18/arrow/flight" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/metadata" | ||
| ) | ||
|
|
||
| type responseMetadataKey struct{} | ||
|
|
||
| type responseMetadataCollector struct { | ||
| mutex sync.RWMutex | ||
| value metadata.MD | ||
| } | ||
|
|
||
| func withResponseMetadata(ctx context.Context) (context.Context, *responseMetadataCollector) { | ||
| collector := &responseMetadataCollector{} | ||
| return context.WithValue(ctx, responseMetadataKey{}, collector), collector | ||
| } | ||
|
|
||
| func captureResponseMetadata(ctx context.Context, value metadata.MD) { | ||
| collector, ok := responseMetadataFromContext(ctx) | ||
| if !ok { | ||
| return | ||
| } | ||
| collector.mutex.Lock() | ||
| collector.value = value.Copy() | ||
| collector.mutex.Unlock() | ||
| } | ||
|
|
||
| func responseMetadataFromContext(ctx context.Context) (*responseMetadataCollector, bool) { | ||
| collector, ok := ctx.Value(responseMetadataKey{}).(*responseMetadataCollector) | ||
| return collector, ok | ||
| } | ||
|
|
||
| func (c *responseMetadataCollector) snapshot() metadata.MD { | ||
| c.mutex.RLock() | ||
| defer c.mutex.RUnlock() | ||
| return c.value.Copy() | ||
| } | ||
|
|
||
| func responseMetadataStreamInterceptor(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) { | ||
| stream, err := streamer(ctx, desc, cc, method, opts...) | ||
| if err != nil { | ||
| return stream, err | ||
| } | ||
| if _, ok := responseMetadataFromContext(ctx); !ok { | ||
| return stream, nil | ||
| } | ||
| return &responseMetadataClientStream{ClientStream: stream, ctx: ctx}, nil | ||
| } | ||
|
|
||
| type responseMetadataClientStream struct { | ||
| grpc.ClientStream | ||
| ctx context.Context | ||
| } | ||
|
|
||
| func (s *responseMetadataClientStream) RecvMsg(message interface{}) error { | ||
| err := s.ClientStream.RecvMsg(message) | ||
| if err != nil { | ||
| header, _ := s.Header() | ||
| captureResponseMetadata(s.ctx, metadata.Join(header, s.Trailer())) | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| // endpointTraceKeyValues builds OpenTelemetry attributes describing a Flight | ||
| // endpoint. Ticket contents are intentionally never recorded. | ||
| func endpointTraceKeyValues(endpointIndex, numEndpoints int, endpoint *flight.FlightEndpoint) []attribute.KeyValue { | ||
| attrs := []attribute.KeyValue{ | ||
| attribute.Int("endpointIndex", endpointIndex), | ||
| attribute.Int("numEndpoints", numEndpoints), | ||
| } | ||
| if endpoint == nil { | ||
| return attrs | ||
| } | ||
| if endpoint.Ticket != nil { | ||
| attrs = append(attrs, attribute.Int("ticketBytes", len(endpoint.Ticket.Ticket))) | ||
| } | ||
| if len(endpoint.Location) == 0 { | ||
| attrs = append(attrs, attribute.String("locations", "<empty: using default client connection>")) | ||
| } else { | ||
| uris := make([]string, 0, len(endpoint.Location)) | ||
| for _, loc := range endpoint.Location { | ||
| uris = append(uris, loc.Uri) | ||
| } | ||
| attrs = append(attrs, attribute.StringSlice("locations", uris)) | ||
|
Member
There was a problem hiding this comment. (1) Is this actually useful to record?
Contributor
Author
There was a problem hiding this comment. This is a port of work that @davidhcoe did in |
||
| } | ||
| if endpoint.ExpirationTime != nil { | ||
| attrs = append(attrs, attribute.String("expirationTime", endpoint.ExpirationTime.AsTime().String())) | ||
| } | ||
| return attrs | ||
| } | ||
|
|
||
| // logKeyValues returns OpenTelemetry attributes summarizing stream progress. | ||
| func (p *streamProgress) logKeyValues() []attribute.KeyValue { | ||
| attrs := []attribute.KeyValue{ | ||
| attribute.Int64("batchesRead", p.batchesRead), | ||
| attribute.Int64("recordsRead", p.recordsRead), | ||
| attribute.Int64("approxBytesRead", p.bytesEstimate), | ||
| attribute.String("elapsed", time.Since(p.start).String()), | ||
| } | ||
| if !p.firstBatchAt.IsZero() { | ||
| attrs = append(attrs, attribute.String("timeToFirstBatch", p.firstBatchAt.Sub(p.start).String())) | ||
| } else { | ||
| attrs = append(attrs, attribute.String("timeToFirstBatch", "never")) | ||
| } | ||
| if !p.lastBatchAt.IsZero() { | ||
| attrs = append(attrs, attribute.String("timeSinceLastBatch", time.Since(p.lastBatchAt).String())) | ||
| } | ||
| return attrs | ||
| } | ||
|
|
||
| // flightInfoTracingKeyValues returns OpenTelemetry attributes describing a FlightInfo: | ||
| // descriptor type and command prefix, AppMetadata prefix (some backends | ||
| // embed a server-side query handle there), and advisory record/byte | ||
| // counts. Returns nil for a nil info. | ||
| func flightInfoTracingKeyValues(info *flight.FlightInfo) []attribute.KeyValue { | ||
| if info == nil { | ||
| return nil | ||
| } | ||
| attrs := []attribute.KeyValue{ | ||
| attribute.Int("numEndpoints", len(info.Endpoint)), | ||
| attribute.Int64("totalRecords", info.TotalRecords), | ||
| attribute.Int64("totalBytes", info.TotalBytes), | ||
| attribute.Bool("haveSchemaInFlightInfo", len(info.Schema) > 0), | ||
| } | ||
| if desc := info.FlightDescriptor; desc != nil { | ||
| attrs = append(attrs, attribute.String("descriptorType", desc.Type.String())) | ||
| if len(desc.Cmd) > 0 { | ||
| limit := len(desc.Cmd) | ||
| if limit > maxLoggedBlobBytes { | ||
| limit = maxLoggedBlobBytes | ||
| } | ||
| attrs = append(attrs, | ||
| attribute.Int("descriptorCmdBytes", len(desc.Cmd)), | ||
| attribute.String("descriptorCmdPrefixHex", hex.EncodeToString(desc.Cmd[:limit])), | ||
| ) | ||
| } | ||
| if len(desc.Path) > 0 { | ||
| attrs = append(attrs, attribute.String("descriptorPath", fmt.Sprint(desc.Path))) | ||
| } | ||
| } | ||
| if len(info.AppMetadata) > 0 { | ||
| limit := len(info.AppMetadata) | ||
| if limit > maxLoggedBlobBytes { | ||
| limit = maxLoggedBlobBytes | ||
| } | ||
| attrs = append(attrs, | ||
| attribute.Int("appMetadataBytes", len(info.AppMetadata)), | ||
| attribute.String("appMetadataPrefixHex", hex.EncodeToString(info.AppMetadata[:limit])), | ||
| ) | ||
| } | ||
| return attrs | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.