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.

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

优化trace context value #377

Merged
merged 2 commits into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions client/egrpc/interceptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,6 @@
if value := tools.ContextValue(ctx, key); value != "" {
// 替换context
ctx = metadata.AppendToOutgoingContext(ctx, key, value)

// grpc metadata 存在同一个 key set 多次,客户端可通过日志排查这种错误使用。
if md, ok := metadata.FromOutgoingContext(ctx); ok {
fields = append(fields, elog.FieldCustomKeyValue(key, strings.Join(md[strings.ToLower(key)], ";")))
Expand Down Expand Up @@ -390,7 +389,10 @@
return func(ctx context.Context, method string, req, res interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
for _, key := range egoLogExtraKeys {
if value := tools.GrpcHeaderValue(ctx, key); value != "" {
ctx = transport.WithValue(ctx, key, value)
if ctx.Value(key) != nil {
ctx = context.WithValue(ctx, key, value)

Check failure on line 393 in client/egrpc/interceptor.go

View workflow job for this annotation

GitHub Actions / lint

SA1029: should not use built-in type string as key for value; define your own type to avoid collisions (staticcheck)
}
//ctx = transport.WithValue(ctx, key, value)
}
}
return invoker(ctx, method, req, res, cc, opts...)
Expand Down
7 changes: 4 additions & 3 deletions client/ehttp/interceptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ package ehttp

import (
"context"
"github.com/gotomicro/ego/core/transport"
"github.com/spf13/cast"
"log"
"net/http"
"net/url"
Expand All @@ -12,6 +10,9 @@ import (
"strings"
"time"

"github.com/gotomicro/ego/core/transport"
"github.com/spf13/cast"

"github.com/go-resty/resty/v2"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
Expand Down Expand Up @@ -58,7 +59,7 @@ func logAccess(name string, config *Config, logger *elog.Component, req *resty.R

// 支持自定义log
for _, key := range loggerKeys {
if value := transport.Value(req.Context(), key); value != nil {
if value := req.Context().Value(key); value != nil {
fields = append(fields, elog.FieldCustomKeyValue(key, cast.ToString(value)))
}
}
Expand Down
35 changes: 8 additions & 27 deletions core/transport/transport.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,22 @@

var customKeyStore = contextKeyStore{
keyArr: make([]string, 0),
keyMap: make(map[string]*contextKey),
}

type contextKeyStore struct {
keyArr []string
keyMap map[string]*contextKey
length int
}

func init() {
customKeyStore.keyArr = eapp.EgoLogExtraKeys()
for _, value := range eapp.EgoLogExtraKeys() {
customKeyStore.keyMap[value] = newContextKey(value)
}
customKeyStore.length = len(customKeyStore.keyArr)
}

// Set overrides custom keys with provided array.
func Set(arr []string) {
length := len(arr)
customKeyStore.keyArr = arr
customKeyStore.keyMap = make(map[string]*contextKey, length)
for _, value := range arr {
customKeyStore.keyMap[value] = newContextKey(value)
}
customKeyStore.length = length
}

Expand All @@ -48,26 +39,16 @@

// WithValue returns a new context with your key and value
func WithValue(ctx context.Context, key string, value interface{}) context.Context {
return context.WithValue(ctx, getContextKey(key), value)
info := ctx.Value(key)
if info != nil {
return ctx
}
return context.WithValue(ctx, key, value)

Check failure on line 46 in core/transport/transport.go

View workflow job for this annotation

GitHub Actions / lint

SA1029: should not use built-in type string as key for value; define your own type to avoid collisions (staticcheck)
}

// Value returns value of your key
// Deprecated
// Use ctx.Value()
func Value(ctx context.Context, key string) interface{} {
return ctx.Value(getContextKey(key))
}

func newContextKey(name string) *contextKey {
return &contextKey{name: name}
return ctx.Value(key)
}

func getContextKey(key string) *contextKey {
return customKeyStore.keyMap[key]
}

// contextKey is a value for use with context.WithValue. It's used as
// a pointer so it fits in an interface{} without allocation.
type contextKey struct {
name string
}

func (k *contextKey) String() string { return "ego context value " + k.name }
17 changes: 13 additions & 4 deletions core/transport/transport_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,20 @@ func TestValue(t *testing.T) {
Set([]string{"X-EGO-Test"})
ctx := context.Background()
ctx = WithValue(ctx, "X-EGO-Test", "hello")
val := Value(ctx, "X-EGO-Test")
val := ctx.Value("X-EGO-Test")
assert.Equal(t, "hello", val)
}

func Test_newContextKey(t *testing.T) {
key := newContextKey("hello")
assert.Equal(t, "ego context value hello", key.String())
//func Test_newContextKey(t *testing.T) {
// key := newContextKey("hello")
// assert.Equal(t, "ego context value hello", key.String())
//}

func TestWithValue(t *testing.T) {
Set([]string{"X-EGO-Test"})
ctx := context.Background()
ctx = WithValue(ctx, "X-EGO-Test", "hello1")
ctx = WithValue(ctx, "X-EGO-Test", "hello2")
val := ctx.Value("X-EGO-Test")
assert.Equal(t, "hello1", val)
}
4 changes: 2 additions & 2 deletions examples/grpc/header/client/main.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package main

import (
"context"
"net/http"

"github.com/davecgh/go-spew/spew"
"github.com/gotomicro/ego/core/transport"
"google.golang.org/grpc"
"google.golang.org/grpc/metadata"

Expand Down Expand Up @@ -33,7 +33,7 @@ func invokerGrpc() error {

func callGrpc() error {
req := http.Request{}
parentContext := transport.WithValue(req.Context(), "X-Ego-Uid", 9527)
parentContext := context.WithValue(req.Context(), "X-Ego-Uid", 9527)
var headers metadata.MD
var trailers metadata.MD
_, err := grpcComp.SayHello(parentContext, &helloworld.HelloRequest{
Expand Down
3 changes: 1 addition & 2 deletions examples/http/client/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package main
import (
"context"
"fmt"
"github.com/gotomicro/ego/core/transport"

"github.com/gotomicro/ego"
"github.com/gotomicro/ego/client/ehttp"
Expand Down Expand Up @@ -53,7 +52,7 @@ func callHTTPWithCustomTrace() error {

traceID := "123456"

ctx = transport.WithValue(ctx, "myTraceID", traceID)
ctx = context.WithValue(ctx, "myTraceID", traceID)

req := httpComp.R()

Expand Down
4 changes: 2 additions & 2 deletions examples/http/headeruid/main.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
package main

import (
"context"
"fmt"

"github.com/gin-gonic/gin"
"github.com/gotomicro/ego"
"github.com/gotomicro/ego/core/elog"
"github.com/gotomicro/ego/core/etrace"
"github.com/gotomicro/ego/core/transport"
"github.com/gotomicro/ego/server/egin"
"go.opentelemetry.io/otel/trace"
)
Expand All @@ -29,7 +29,7 @@ func main() {
})

server.GET("/hello", func(ctx *gin.Context) {
pCtx := transport.WithValue(ctx.Request.Context(), "X-Ego-Uid", 9527)
pCtx := context.WithValue(ctx.Request.Context(), "X-Ego-Uid", 9527)
ctx.Request = ctx.Request.WithContext(pCtx)
// Get traceId from Request's context
// span, _ := etrace.StartSpanFromContext(ctx.Request.Context(), "Handle: /Hello")
Expand Down
11 changes: 5 additions & 6 deletions internal/tools/tools.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@ import (
"go/format"
"log"
"reflect"
"strings"

"github.com/spf13/cast"
"google.golang.org/grpc/metadata"

"github.com/gotomicro/ego/core/transport"
)

// GrpcHeaderValue 获取context value
Expand All @@ -23,16 +20,18 @@ func GrpcHeaderValue(ctx context.Context, key string) string {
if !ok {
return ""
}
// 小写
return strings.Join(md.Get(key), ";")
if len(md.Get(key)) > 0 {
return md.Get(key)[0]
}
return ""
}

// ContextValue gRPC日志获取context value
func ContextValue(ctx context.Context, key string) string {
if key == "" {
return ""
}
return cast.ToString(transport.Value(ctx, key))
return cast.ToString(ctx.Value(key))
}

// ToSliceStringMap casts an empty interface to []map[string]interface{} ignoring error
Expand Down
8 changes: 7 additions & 1 deletion server/egin/interceptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,13 @@ func getHeaderValue(c *gin.Context, key string, enableTrustedCustomHeader bool)
value := c.GetHeader(key)
if value != "" {
// 如果信任该Header,将header数据赋值到context上
c.Request = c.Request.WithContext(transport.WithValue(c.Request.Context(), key, value))
for _, customContextKey := range transport.CustomContextKeys() {
// 如果header key和自定义key是一样的,写入到contet value中
if customContextKey == key {
c.Request = c.Request.WithContext(transport.WithValue(c.Request.Context(), key, value))
}
}

}
return value
}
Expand Down
9 changes: 4 additions & 5 deletions server/egin/interceptor_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ import (
"testing"

"github.com/gin-gonic/gin"
"github.com/gotomicro/ego/core/transport"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/stretchr/testify/assert"

"github.com/gotomicro/ego/core/transport"

"github.com/gotomicro/ego/core/elog"
)

Expand Down Expand Up @@ -174,7 +173,7 @@ func TestPrometheus(t *testing.T) {
if err != nil {
t.Fatal(err)
}
text, err := ioutil.ReadAll(res.Body)
text, err := io.ReadAll(res.Body)
if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -211,12 +210,12 @@ func Test_getHeaderValue(t *testing.T) {

func Test_getHeaderAssignValue(t *testing.T) {
c, _ := gin.CreateTestContext(httptest.NewRecorder())
transport.Set([]string{"X-Ego-Uid"})
c.Request, _ = http.NewRequest("GET", "/chat", nil)
c.Request.Header.Set("X-Ego-Uid", "9527")
value := getHeaderValue(c, "X-Ego-Uid", true)
assert.Equal(t, "9527", value)

value2 := transport.Value(c.Request.Context(), "X-Ego-Uid")
value2 := c.Request.Context().Value("X-Ego-Uid")
assert.Equal(t, "9527", value2)
}

Expand Down
9 changes: 8 additions & 1 deletion server/egrpc/interceptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,14 @@ func (c *Container) defaultUnaryServerInterceptor() grpc.UnaryServerInterceptor
// 必须在defer外层,因为要赋值,替换ctx
for _, key := range loggerKeys {
if value := tools.GrpcHeaderValue(ctx, key); value != "" {
ctx = transport.WithValue(ctx, key, value)
// 如果信任该Header,将header数据赋值到context上
for _, customContextKey := range transport.CustomContextKeys() {
// 如果header key和自定义key是一样的,写入到contet value中
if customContextKey == key {
ctx = transport.WithValue(ctx, key, value)
}
}

}
}

Expand Down
Loading