Skip to content

Commit

Permalink
binarylog: Account for key in metadata truncation (#5851)
Browse files Browse the repository at this point in the history
  • Loading branch information
zasweq authored Dec 9, 2022
1 parent f54bba9 commit 3e27f89
Show file tree
Hide file tree
Showing 2 changed files with 129 additions and 1 deletion.
128 changes: 128 additions & 0 deletions gcp/observability/logging_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ func cmpLoggingEntryList(got []*grpcLogEntry, want []*grpcLogEntry) error {
if len(a) > len(b) {
a, b = b, a
}
if len(a) == 0 && len(a) != len(b) { // No metadata for one and the other comparator wants metadata.
return false
}
for k, v := range a {
if b[k] != v {
return false
Expand Down Expand Up @@ -1145,3 +1148,128 @@ func (s) TestMarshalJSON(t *testing.T) {
t.Fatalf("json.Marshal(%v) failed with error: %v", logEntry, err)
}
}

// TestMetadataTruncationAccountsKey tests that the metadata truncation takes
// into account both the key and value of metadata. It configures an
// observability system with a maximum byte length for metadata, which is
// greater than just the byte length of the metadata value but less than the
// byte length of the metadata key + metadata value. Thus, in the ClientHeader
// logging event, no metadata should be logged.
func (s) TestMetadataTruncationAccountsKey(t *testing.T) {
fle := &fakeLoggingExporter{
t: t,
}
defer func(ne func(ctx context.Context, config *config) (loggingExporter, error)) {
newLoggingExporter = ne
}(newLoggingExporter)

newLoggingExporter = func(ctx context.Context, config *config) (loggingExporter, error) {
return fle, nil
}

const mdValue = "value"
configMetadataLimit := &config{
ProjectID: "fake",
CloudLogging: &cloudLogging{
ClientRPCEvents: []clientRPCEvents{
{
Methods: []string{"*"},
MaxMetadataBytes: len(mdValue) + 1,
},
},
},
}

cleanup, err := setupObservabilitySystemWithConfig(configMetadataLimit)
if err != nil {
t.Fatalf("error setting up observability %v", err)
}
defer cleanup()

ss := &stubserver.StubServer{
UnaryCallF: func(ctx context.Context, in *grpc_testing.SimpleRequest) (*grpc_testing.SimpleResponse, error) {
return &grpc_testing.SimpleResponse{}, nil
},
}
if err := ss.Start(nil); err != nil {
t.Fatalf("Error starting endpoint server: %v", err)
}
defer ss.Stop()

ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
defer cancel()

// the set config MaxMetdataBytes is in between len(mdValue) and len("key")
// + len(mdValue), and thus shouldn't log this metadata entry.
md := metadata.MD{
"key": []string{mdValue},
}
ctx = metadata.NewOutgoingContext(ctx, md)
if _, err := ss.Client.UnaryCall(ctx, &grpc_testing.SimpleRequest{Payload: &grpc_testing.Payload{Body: []byte("00000")}}); err != nil {
t.Fatalf("Unexpected error from UnaryCall: %v", err)
}

grpcLogEntriesWant := []*grpcLogEntry{
{
Type: eventTypeClientHeader,
Logger: loggerClient,
ServiceName: "grpc.testing.TestService",
MethodName: "UnaryCall",
Authority: ss.Address,
SequenceID: 1,
Payload: payload{
Metadata: map[string]string{},
},
PayloadTruncated: true,
},
{
Type: eventTypeClientMessage,
Logger: loggerClient,
ServiceName: "grpc.testing.TestService",
MethodName: "UnaryCall",
SequenceID: 2,
Authority: ss.Address,
Payload: payload{
MessageLength: 9,
Message: []uint8{},
},
PayloadTruncated: true,
},
{
Type: eventTypeServerHeader,
Logger: loggerClient,
ServiceName: "grpc.testing.TestService",
MethodName: "UnaryCall",
SequenceID: 3,
Authority: ss.Address,
Payload: payload{
Metadata: map[string]string{},
},
},
{
Type: eventTypeServerMessage,
Logger: loggerClient,
ServiceName: "grpc.testing.TestService",
MethodName: "UnaryCall",
Authority: ss.Address,
SequenceID: 4,
},
{
Type: eventTypeServerTrailer,
Logger: loggerClient,
ServiceName: "grpc.testing.TestService",
MethodName: "UnaryCall",
SequenceID: 5,
Authority: ss.Address,
Payload: payload{
Metadata: map[string]string{},
},
},
}
fle.mu.Lock()
if err := cmpLoggingEntryList(fle.entries, grpcLogEntriesWant); err != nil {
fle.mu.Unlock()
t.Fatalf("error in logging entry list comparison %v", err)
}
fle.mu.Unlock()
}
2 changes: 1 addition & 1 deletion internal/binarylog/method_logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ func (ml *TruncatingMethodLogger) truncateMetadata(mdPb *pb.Metadata) (truncated
// but not counted towards the size limit.
continue
}
currentEntryLen := uint64(len(entry.Value))
currentEntryLen := uint64(len(entry.GetKey())) + uint64(len(entry.GetValue()))
if currentEntryLen > bytesLimit {
break
}
Expand Down

0 comments on commit 3e27f89

Please sign in to comment.