Skip to content

fix(ttstream): metrics missing caused by server-side rpcinfo not set correctly #1787

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

Merged
merged 1 commit into from
Jun 10, 2025
Merged

fix(ttstream): metrics missing caused by server-side rpcinfo not set correctly #1787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 35 additions & 18 deletions pkg/remote/trans/ttstream/server_handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,14 @@ import (
"runtime/debug"
"sync"

"github.com/bytedance/gopkg/cloud/metainfo"

"github.com/cloudwego/kitex/pkg/endpoint"
"github.com/cloudwego/kitex/pkg/gofunc"
"github.com/cloudwego/kitex/pkg/kerrors"
"github.com/cloudwego/kitex/pkg/klog"
"github.com/cloudwego/kitex/pkg/remote"
"github.com/cloudwego/kitex/pkg/remote/trans/ttstream/ktx"
"github.com/cloudwego/kitex/pkg/rpcinfo"
"github.com/cloudwego/kitex/pkg/streaming"
ktransport "github.com/cloudwego/kitex/transport"
Expand Down Expand Up @@ -118,7 +121,7 @@ func (t *svrTransHandler) OnRead(ctx context.Context, conn net.Conn) (err error)
}()
// connection level goroutine
for {
nctx, ss, nerr := t.provider.OnStream(ctx, conn)
nctx, st, nerr := t.provider.OnStream(ctx, conn)
if nerr != nil {
if errors.Is(nerr, io.EOF) {
return nil
Expand All @@ -130,7 +133,7 @@ func (t *svrTransHandler) OnRead(ctx context.Context, conn net.Conn) (err error)
// stream level goroutine
gofunc.GoFunc(nctx, func() {
defer wg.Done()
err := t.OnStream(nctx, conn, ss)
err := t.OnStream(nctx, conn, st)
if err != nil && !errors.Is(err, io.EOF) {
t.OnError(nctx, err, conn)
}
Expand All @@ -142,7 +145,7 @@ func (t *svrTransHandler) OnRead(ctx context.Context, conn net.Conn) (err error)
// - create server stream
// - process server stream
// - close server stream
func (t *svrTransHandler) OnStream(ctx context.Context, conn net.Conn, ss streaming.ServerStream) (err error) {
func (t *svrTransHandler) OnStream(ctx context.Context, conn net.Conn, st *stream) (err error) {
ri := t.opt.InitOrResetRPCInfoFunc(nil, conn.RemoteAddr())
ctx = rpcinfo.NewCtxWithRPCInfo(ctx, ri)
defer func() {
Expand All @@ -153,23 +156,37 @@ func (t *svrTransHandler) OnStream(ctx context.Context, conn net.Conn, ss stream
}()

ink := ri.Invocation().(rpcinfo.InvocationSetter)
if si, ok := ss.(StreamInfo); ok {
sinfo := t.opt.SvcSearcher.SearchService(si.Service(), si.Method(), false)
if sinfo == nil {
return remote.NewTransErrorWithMsg(remote.UnknownService, fmt.Sprintf("unknown service %s", si.Service()))
}
minfo := sinfo.MethodInfo(si.Method())
if minfo == nil {
return remote.NewTransErrorWithMsg(remote.UnknownMethod, fmt.Sprintf("unknown method %s", si.Method()))
}
ink.SetServiceName(sinfo.ServiceName)
ink.SetMethodName(si.Method())
ink.SetStreamingMode(minfo.StreamingMode())
if mutableTo := rpcinfo.AsMutableEndpointInfo(ri.To()); mutableTo != nil {
_ = mutableTo.SetMethod(si.Method())
sinfo := t.opt.SvcSearcher.SearchService(st.Service(), st.Method(), false)
if sinfo == nil {
return remote.NewTransErrorWithMsg(remote.UnknownService, fmt.Sprintf("unknown service %s", st.Service()))
}
minfo := sinfo.MethodInfo(st.Method())
if minfo == nil {
return remote.NewTransErrorWithMsg(remote.UnknownMethod, fmt.Sprintf("unknown method %s", st.Method()))
}
ink.SetServiceName(sinfo.ServiceName)
ink.SetMethodName(st.Method())
ink.SetStreamingMode(minfo.StreamingMode())
if mutableTo := rpcinfo.AsMutableEndpointInfo(ri.To()); mutableTo != nil {
_ = mutableTo.SetMethod(st.Method())
}
rpcinfo.AsMutableRPCConfig(ri.Config()).SetTransportProtocol(st.TransportProtocol())

// headerHandler return a new stream level ctx
// it contains rpcinfo modified by HeaderHandler
if t.provider.headerHandler != nil {
ctx, err = t.provider.headerHandler.OnReadStream(ctx, st.meta, st.header)
if err != nil {
return err
}
rpcinfo.AsMutableRPCConfig(ri.Config()).SetTransportProtocol(si.TransportProtocol())
}
// register metainfo into ctx
ctx = metainfo.SetMetaInfoFromMap(ctx, st.header)
ss := newServerStream(st)

// cancel ctx when OnStreamFinish
ctx, cancelFunc := ktx.WithCancel(ctx)
ctx = context.WithValue(ctx, serverStreamCancelCtxKey{}, cancelFunc)

ctx = t.startTracer(ctx, ri)
defer func() {
Expand Down
94 changes: 86 additions & 8 deletions pkg/remote/trans/ttstream/server_handler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ import (
"fmt"
"net"
"runtime/debug"
"strings"
"testing"
"time"

"github.com/cloudwego/gopkg/protocol/ttheader"
"github.com/cloudwego/netpoll"

"github.com/cloudwego/kitex/internal/mocks"
Expand Down Expand Up @@ -87,17 +89,54 @@ func (m *mockNetpollConn) SetOnDisconnect(onDisconnect netpoll.OnDisconnect) err
return nil
}

type mockTracer struct {
finishFunc func(ctx context.Context)
}

func (m *mockTracer) Start(ctx context.Context) context.Context {
return ctx
}

func (m *mockTracer) Finish(ctx context.Context) {
m.finishFunc(ctx)
}

type mockHeaderFrameReadHandler struct {
ripTag string
}

func (m *mockHeaderFrameReadHandler) OnReadStream(ctx context.Context, ihd IntHeader, shd StrHeader) (context.Context, error) {
ri := rpcinfo.GetRPCInfo(ctx)
fi := rpcinfo.AsMutableEndpointInfo(ri.From())
if rip, ok := shd[ttheader.HeaderTransRemoteAddr]; ok {
fi.SetTag(m.ripTag, rip)
}
return ctx, nil
}

func TestOnStream(t *testing.T) {
ripTag := "rip"
tracer := &mockTracer{}
traceCtl := &rpcinfo.TraceController{}
traceCtl.Append(tracer)
factory := NewSvrTransHandlerFactory()
rawTransHdl, err := factory.NewTransHandler(&remote.ServerOption{
SvcSearcher: mock_remote.NewDefaultSvcSearcher(),
InitOrResetRPCInfoFunc: func(info rpcinfo.RPCInfo, addr net.Addr) rpcinfo.RPCInfo {
return rpcinfo.NewRPCInfo(nil, nil,
return rpcinfo.NewRPCInfo(rpcinfo.NewEndpointInfo(
mocks.MockService2Name, mocks.Mock2Method, nil, make(map[string]string)), nil,
rpcinfo.NewInvocation(mocks.MockServiceName, mocks.MockStreamingMethod),
rpcinfo.NewRPCConfig(),
rpcinfo.NewRPCStats())
},
TracerCtl: &rpcinfo.TraceController{},
TracerCtl: traceCtl,
TTHeaderStreamingOptions: remote.TTHeaderStreamingOptions{
TransportOptions: []interface{}{
WithServerHeaderFrameHandler(&mockHeaderFrameReadHandler{
ripTag: ripTag,
}),
},
},
})
test.Assert(t, err == nil, err)
transHdl := rawTransHdl.(*svrTransHandler)
Expand All @@ -124,30 +163,53 @@ func TestOnStream(t *testing.T) {
}()

t.Run("invoking handler successfully", func(t *testing.T) {
tracer.finishFunc = func(ctx context.Context) {
ri := rpcinfo.GetRPCInfo(ctx)
test.Assert(t, ri != nil, ri)
rip, ok := ri.From().Tag(ripTag)
test.Assert(t, ok)
test.Assert(t, rip == "127.0.0.1:8888", rip)
}
transHdl.SetInvokeHandleFunc(func(ctx context.Context, req, resp interface{}) (err error) {
return nil
})
err = EncodeFrame(context.Background(), wbuf, &Frame{
streamFrame: streamFrame{
sid: 1,
method: mocks.MockStreamingMethod,
header: map[string]string{
ttheader.HeaderTransRemoteAddr: "127.0.0.1:8888",
},
},
typ: headerFrameType,
})
test.Assert(t, err == nil, err)
err = wbuf.Flush()
test.Assert(t, err == nil, err)
nctx, ss, err := transHdl.provider.OnStream(ctx, mockConn)
nctx, st, err := transHdl.provider.OnStream(ctx, mockConn)
test.Assert(t, err == nil, err)
err = transHdl.OnStream(nctx, mockConn, ss)
err = transHdl.OnStream(nctx, mockConn, st)
test.Assert(t, err == nil, err)
})

t.Run("invoking handler panic", func(t *testing.T) {
tracer.finishFunc = func(ctx context.Context) {
ri := rpcinfo.GetRPCInfo(ctx)
test.Assert(t, ri != nil, ri)
rip, ok := ri.From().Tag(ripTag)
test.Assert(t, ok)
test.Assert(t, rip == "127.0.0.1:8888", rip)
ok, pErr := ri.Stats().Panicked()
test.Assert(t, ok)
test.Assert(t, errors.Is(pErr.(error), kerrors.ErrPanic), pErr)
}
transHdl.SetInvokeHandleFunc(func(ctx context.Context, req, resp interface{}) (err error) {
defer func() {
if handlerErr := recover(); handlerErr != nil {
ri := rpcinfo.GetRPCInfo(ctx)
err = kerrors.ErrPanic.WithCauseAndStack(fmt.Errorf("[panic] %s", handlerErr), string(debug.Stack()))
rpcStats := rpcinfo.AsMutableRPCStats(ri.Stats())
rpcStats.SetPanicked(err)
}
}()
panic("test")
Expand All @@ -156,20 +218,33 @@ func TestOnStream(t *testing.T) {
streamFrame: streamFrame{
sid: 1,
method: mocks.MockStreamingMethod,
header: map[string]string{
ttheader.HeaderTransRemoteAddr: "127.0.0.1:8888",
},
},
typ: headerFrameType,
})
test.Assert(t, err == nil, err)
err = wbuf.Flush()
test.Assert(t, err == nil, err)
nctx, ss, err := transHdl.provider.OnStream(ctx, mockConn)
nctx, st, err := transHdl.provider.OnStream(ctx, mockConn)
test.Assert(t, err == nil, err)
err = transHdl.OnStream(nctx, mockConn, ss)
err = transHdl.OnStream(nctx, mockConn, st)
test.Assert(t, errors.Is(err, kerrors.ErrPanic), err)
transHdl.OnError(ctx, err, mockConn)
})

t.Run("invoking handler throws biz error", func(t *testing.T) {
tracer.finishFunc = func(ctx context.Context) {
ri := rpcinfo.GetRPCInfo(ctx)
test.Assert(t, ri != nil, ri)
rip, ok := ri.From().Tag(ripTag)
test.Assert(t, ok)
test.Assert(t, rip == "127.0.0.1:8888", rip)
bizErr := ri.Invocation().BizStatusErr()
test.Assert(t, bizErr.BizStatusCode() == 10000, bizErr)
test.Assert(t, strings.Contains(bizErr.BizMessage(), "biz-error test"), bizErr)
}
transHdl.SetInvokeHandleFunc(func(ctx context.Context, req, resp interface{}) (err error) {
ri := rpcinfo.GetRPCInfo(ctx)
defer func() {
Expand All @@ -186,15 +261,18 @@ func TestOnStream(t *testing.T) {
streamFrame: streamFrame{
sid: 1,
method: mocks.MockStreamingMethod,
header: map[string]string{
ttheader.HeaderTransRemoteAddr: "127.0.0.1:8888",
},
},
typ: headerFrameType,
})
test.Assert(t, err == nil, err)
err = wbuf.Flush()
test.Assert(t, err == nil, err)
nctx, ss, err := transHdl.provider.OnStream(ctx, mockConn)
nctx, st, err := transHdl.provider.OnStream(ctx, mockConn)
test.Assert(t, err == nil, err)
err = transHdl.OnStream(nctx, mockConn, ss)
err = transHdl.OnStream(nctx, mockConn, st)
test.Assert(t, err == nil, err)
})
}
21 changes: 2 additions & 19 deletions pkg/remote/trans/ttstream/server_provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,12 @@ import (
"net"
"strconv"

"github.com/bytedance/gopkg/cloud/metainfo"
"github.com/cloudwego/gopkg/protocol/thrift"
"github.com/cloudwego/gopkg/protocol/ttheader"
"github.com/cloudwego/netpoll"

"github.com/cloudwego/kitex/pkg/kerrors"
"github.com/cloudwego/kitex/pkg/remote"
"github.com/cloudwego/kitex/pkg/remote/trans/ttstream/ktx"
"github.com/cloudwego/kitex/pkg/streaming"
"github.com/cloudwego/kitex/pkg/utils"
)
Expand Down Expand Up @@ -86,7 +84,7 @@ func (s *serverProvider) OnInactive(ctx context.Context, conn net.Conn) (context
return ctx, nil
}

func (s *serverProvider) OnStream(ctx context.Context, conn net.Conn) (context.Context, streaming.ServerStream, error) {
func (s *serverProvider) OnStream(ctx context.Context, conn net.Conn) (context.Context, *stream, error) {
trans, _ := ctx.Value(serverTransCtxKey{}).(*transport)
if trans == nil {
return nil, nil, fmt.Errorf("server transport is nil")
Expand All @@ -98,22 +96,7 @@ func (s *serverProvider) OnStream(ctx context.Context, conn net.Conn) (context.C
return nil, nil, err
}
st.setMetaFrameHandler(s.metaHandler)

// headerHandler return a new stream level ctx
if s.headerHandler != nil {
ctx, err = s.headerHandler.OnReadStream(ctx, st.meta, st.header)
if err != nil {
return nil, nil, err
}
}
// register metainfo into ctx
ctx = metainfo.SetMetaInfoFromMap(ctx, st.header)
ss := newServerStream(st)

// cancel ctx when OnStreamFinish
ctx, cancelFunc := ktx.WithCancel(ctx)
ctx = context.WithValue(ctx, serverStreamCancelCtxKey{}, cancelFunc)
return ctx, ss, nil
return ctx, st, nil
}

func (s *serverProvider) OnStreamFinish(ctx context.Context, ss streaming.ServerStream, err error) (context.Context, error) {
Expand Down