milvus/internal/proxy/trace_log_interceptor.go
2023-11-28 15:32:31 +08:00

113 lines
3.8 KiB
Go

/*
* Licensed to the LF AI & Data foundation 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 proxy
import (
"context"
"path"
"go.uber.org/zap"
"google.golang.org/grpc"
"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
"github.com/milvus-io/milvus/pkg/log"
"github.com/milvus-io/milvus/pkg/util/requestutil"
)
func TraceLogInterceptor(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
switch Params.CommonCfg.TraceLogMode.GetAsInt() {
case 0: // none
return handler(ctx, req)
case 1: // simple info
fields := GetRequestBaseInfo(ctx, req, info, false)
log.Ctx(ctx).Info("trace info: simple", fields...)
return handler(ctx, req)
case 2: // detail info
fields := GetRequestBaseInfo(ctx, req, info, true)
fields = append(fields, GetRequestFieldWithoutSensitiveInfo(req))
log.Ctx(ctx).Info("trace info: detail", fields...)
return handler(ctx, req)
case 3: // detail info with request and response
fields := GetRequestBaseInfo(ctx, req, info, true)
fields = append(fields, GetRequestFieldWithoutSensitiveInfo(req))
log.Ctx(ctx).Info("trace info: all request", fields...)
resp, err := handler(ctx, req)
if err != nil {
log.Ctx(ctx).Info("trace info: all, error", zap.Error(err))
return resp, err
}
if status, ok := requestutil.GetStatusFromResponse(resp); ok {
if status.Code != 0 {
log.Ctx(ctx).Info("trace info: all, fail", zap.Any("resp", resp))
}
} else {
log.Ctx(ctx).Info("trace info: all, unknown", zap.Any("resp", resp))
}
return resp, nil
default:
return handler(ctx, req)
}
}
func GetRequestBaseInfo(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, skipBaseRequestInfo bool) []zap.Field {
var fields []zap.Field
_, requestName := path.Split(info.FullMethod)
fields = append(fields, zap.String("request_name", requestName))
username, err := GetCurUserFromContext(ctx)
if err == nil && username != "" {
fields = append(fields, zap.String("username", username))
}
if !skipBaseRequestInfo {
for baseInfoName, f := range requestutil.TraceLogBaseInfoFuncMap {
baseInfo, ok := f(req)
if !ok {
continue
}
fields = append(fields, zap.Any(baseInfoName, baseInfo))
}
}
return fields
}
func GetRequestFieldWithoutSensitiveInfo(req interface{}) zap.Field {
createCredentialReq, ok := req.(*milvuspb.CreateCredentialRequest)
if ok {
return zap.Any("request", &milvuspb.CreateCredentialRequest{
Base: createCredentialReq.Base,
Username: createCredentialReq.Username,
CreatedUtcTimestamps: createCredentialReq.CreatedUtcTimestamps,
ModifiedUtcTimestamps: createCredentialReq.ModifiedUtcTimestamps,
})
}
updateCredentialReq, ok := req.(*milvuspb.UpdateCredentialRequest)
if ok {
return zap.Any("request", &milvuspb.UpdateCredentialRequest{
Base: updateCredentialReq.Base,
Username: updateCredentialReq.Username,
CreatedUtcTimestamps: updateCredentialReq.CreatedUtcTimestamps,
ModifiedUtcTimestamps: updateCredentialReq.ModifiedUtcTimestamps,
})
}
return zap.Any("request", req)
}