mirrors/uquic
1
0
Fork 0
mirror of https://github.com/refraction-networking/uquic.git synced 2025-04-04 12:47:36 +03:00
Code Issues Projects Releases Packages Wiki Activity

add a multiplexer for the logging.Tracer

Browse source
This commit is contained in:
Marten Seemann 2020-07-09 14:47:02 +07:00
parent 2d4eca1dd6
commit c8d434305c
5 changed files with 283 additions and 125 deletions
Download patch file Download diff file Expand all files Collapse all files

4
logging/interface.go
View file

@ -79,7 +79,11 @@ const (
// A Tracer traces events. // A Tracer traces events.
type Tracer interface { type Tracer interface {
// TracerForServer requests a new tracer for a connection that was accepted by the server.
// If nil is returned, tracing will be disabled for this connection.
TracerForServer(odcid ConnectionID) ConnectionTracer TracerForServer(odcid ConnectionID) ConnectionTracer
// TracerForServer requests a new tracer for a connection that was dialed by the client.
// If nil is returned, tracing will be disabled for this connection.
TracerForClient(odcid ConnectionID) ConnectionTracer TracerForClient(odcid ConnectionID) ConnectionTracer
} }

62
logging/mock_tracer_test.go Normal file
View file

@ -0,0 +1,62 @@
// Code generated by MockGen. DO NOT EDIT.
// Source: github.com/lucas-clemente/quic-go/logging (interfaces: Tracer)
// Package logging is a generated GoMock package.
package logging
import (
gomock "github.com/golang/mock/gomock"
protocol "github.com/lucas-clemente/quic-go/internal/protocol"
reflect "reflect"
)
// MockTracer is a mock of Tracer interface
type MockTracer struct {
ctrl *gomock.Controller
recorder *MockTracerMockRecorder
}
// MockTracerMockRecorder is the mock recorder for MockTracer
type MockTracerMockRecorder struct {
mock *MockTracer
}
// NewMockTracer creates a new mock instance
func NewMockTracer(ctrl *gomock.Controller) *MockTracer {
mock := &MockTracer{ctrl: ctrl}
mock.recorder = &MockTracerMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use
func (m *MockTracer) EXPECT() *MockTracerMockRecorder {
return m.recorder
}
// TracerForClient mocks base method
func (m *MockTracer) TracerForClient(arg0 protocol.ConnectionID) ConnectionTracer {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "TracerForClient", arg0)
ret0, _ := ret[0].(ConnectionTracer)
return ret0
}
// TracerForClient indicates an expected call of TracerForClient
func (mr *MockTracerMockRecorder) TracerForClient(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "TracerForClient", reflect.TypeOf((*MockTracer)(nil).TracerForClient), arg0)
}
// TracerForServer mocks base method
func (m *MockTracer) TracerForServer(arg0 protocol.ConnectionID) ConnectionTracer {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "TracerForServer", arg0)
ret0, _ := ret[0].(ConnectionTracer)
return ret0
}
// TracerForServer indicates an expected call of TracerForServer
func (mr *MockTracerMockRecorder) TracerForServer(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "TracerForServer", reflect.TypeOf((*MockTracer)(nil).TracerForServer), arg0)
}

1
logging/mockgen.go
View file

@ -1,3 +1,4 @@
package logging package logging
//go:generate sh -c "mockgen -package logging -destination mock_connection_tracer_test.go github.com/lucas-clemente/quic-go/logging ConnectionTracer" //go:generate sh -c "mockgen -package logging -destination mock_connection_tracer_test.go github.com/lucas-clemente/quic-go/logging ConnectionTracer"
//go:generate sh -c "mockgen -package logging -destination mock_tracer_test.go github.com/lucas-clemente/quic-go/logging Tracer"

41
logging/multiplex.go
View file

@ -5,15 +5,52 @@ import (
"time" "time"
) )
type tracerMultiplexer struct {
tracers []Tracer
}
var _ Tracer = &tracerMultiplexer{}
// NewMultiplexedTracer creates a new tracer that multiplexes all events to multiple tracers.
func NewMultiplexedTracer(tracers ...Tracer) Tracer {
if len(tracers) == 0 {
return nil
}
if len(tracers) == 1 {
return tracers[1]
}
return &tracerMultiplexer{tracers}
}
func (m *tracerMultiplexer) TracerForServer(odcid ConnectionID) ConnectionTracer {
var connTracers []ConnectionTracer
for _, t := range m.tracers {
if ct := t.TracerForServer(odcid); ct != nil {
connTracers = append(connTracers, ct)
}
}
return newConnectionMultiplexer(connTracers...)
}
func (m *tracerMultiplexer) TracerForClient(odcid ConnectionID) ConnectionTracer {
var connTracers []ConnectionTracer
for _, t := range m.tracers {
if ct := t.TracerForClient(odcid); ct != nil {
connTracers = append(connTracers, ct)
}
}
return newConnectionMultiplexer(connTracers...)
}
type connTracerMultiplexer struct { type connTracerMultiplexer struct {
tracers []ConnectionTracer tracers []ConnectionTracer
} }
var _ ConnectionTracer = &connTracerMultiplexer{} var _ ConnectionTracer = &connTracerMultiplexer{}
func NewConnectionMultiplexer(tracers ...ConnectionTracer) ConnectionTracer { func newConnectionMultiplexer(tracers ...ConnectionTracer) ConnectionTracer {
if len(tracers) == 0 { if len(tracers) == 0 {
panic("no tracers") return nil
} }
if len(tracers) == 1 { if len(tracers) == 1 {
return tracers[0] return tracers[0]

300
logging/multiplex_test.go
View file

@ -7,153 +7,207 @@ import (
"github.com/lucas-clemente/quic-go/internal/wire" "github.com/lucas-clemente/quic-go/internal/wire"
. "github.com/onsi/ginkgo" . "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
) )
var _ = Describe("Tracing", func() { var _ = Describe("Tracing", func() {
var ( Context("Tracer", func() {
tracer ConnectionTracer var (
tr1 *MockConnectionTracer tracer Tracer
tr2 *MockConnectionTracer tr1, tr2 *MockTracer
) )
BeforeEach(func() { BeforeEach(func() {
tr1 = NewMockConnectionTracer(mockCtrl) tr1 = NewMockTracer(mockCtrl)
tr2 = NewMockConnectionTracer(mockCtrl) tr2 = NewMockTracer(mockCtrl)
tracer = NewConnectionMultiplexer(tr1, tr2) tracer = NewMultiplexedTracer(tr1, tr2)
})
It("multiplexes the TracerForServer call", func() {
tr1.EXPECT().TracerForServer(ConnectionID{1, 2, 3})
tr2.EXPECT().TracerForServer(ConnectionID{1, 2, 3})
tracer.TracerForServer(ConnectionID{1, 2, 3})
})
It("multiplexes the TracerForClient call", func() {
tr1.EXPECT().TracerForClient(ConnectionID{1, 2, 3})
tr2.EXPECT().TracerForClient(ConnectionID{1, 2, 3})
tracer.TracerForClient(ConnectionID{1, 2, 3})
})
It("uses multiple connection tracers", func() {
ctr1 := NewMockConnectionTracer(mockCtrl)
ctr2 := NewMockConnectionTracer(mockCtrl)
tr1.EXPECT().TracerForClient(ConnectionID{1, 2, 3}).Return(ctr1)
tr2.EXPECT().TracerForClient(ConnectionID{1, 2, 3}).Return(ctr2)
tr := tracer.TracerForClient(ConnectionID{1, 2, 3})
ctr1.EXPECT().LossTimerCanceled()
ctr2.EXPECT().LossTimerCanceled()
tr.LossTimerCanceled()
})
It("handles tracers that return a nil ConnectionTracer", func() {
ctr1 := NewMockConnectionTracer(mockCtrl)
tr1.EXPECT().TracerForClient(ConnectionID{1, 2, 3}).Return(ctr1)
tr2.EXPECT().TracerForClient(ConnectionID{1, 2, 3})
tr := tracer.TracerForClient(ConnectionID{1, 2, 3})
ctr1.EXPECT().LossTimerCanceled()
tr.LossTimerCanceled()
})
It("returns nil when all tracers return a nil ConnectionTracer", func() {
tr1.EXPECT().TracerForClient(ConnectionID{1, 2, 3})
tr2.EXPECT().TracerForClient(ConnectionID{1, 2, 3})
Expect(tracer.TracerForClient(ConnectionID{1, 2, 3})).To(BeNil())
})
}) })
It("trace the ConnectionStarted event", func() { Context("Connection Tracer", func() {
local := &net.UDPAddr{IP: net.IPv4(1, 2, 3, 4)} var (
remote := &net.UDPAddr{IP: net.IPv4(4, 3, 2, 1)} tracer ConnectionTracer
tr1.EXPECT().StartedConnection(local, remote, VersionNumber(1234), ConnectionID{1, 2, 3, 4}, ConnectionID{4, 3, 2, 1}) tr1 *MockConnectionTracer
tr2.EXPECT().StartedConnection(local, remote, VersionNumber(1234), ConnectionID{1, 2, 3, 4}, ConnectionID{4, 3, 2, 1}) tr2 *MockConnectionTracer
tracer.StartedConnection(local, remote, VersionNumber(1234), ConnectionID{1, 2, 3, 4}, ConnectionID{4, 3, 2, 1}) )
})
It("traces the ClosedConnection event", func() { BeforeEach(func() {
reason := NewTimeoutCloseReason(TimeoutReasonIdle) tr1 = NewMockConnectionTracer(mockCtrl)
tr1.EXPECT().ClosedConnection(reason) tr2 = NewMockConnectionTracer(mockCtrl)
tr2.EXPECT().ClosedConnection(reason) tracer = newConnectionMultiplexer(tr1, tr2)
tracer.ClosedConnection(reason) })
})
It("traces the SentTransportParameters event", func() { It("trace the ConnectionStarted event", func() {
tp := &wire.TransportParameters{InitialMaxData: 1337} local := &net.UDPAddr{IP: net.IPv4(1, 2, 3, 4)}
tr1.EXPECT().SentTransportParameters(tp) remote := &net.UDPAddr{IP: net.IPv4(4, 3, 2, 1)}
tr2.EXPECT().SentTransportParameters(tp) tr1.EXPECT().StartedConnection(local, remote, VersionNumber(1234), ConnectionID{1, 2, 3, 4}, ConnectionID{4, 3, 2, 1})
tracer.SentTransportParameters(tp) tr2.EXPECT().StartedConnection(local, remote, VersionNumber(1234), ConnectionID{1, 2, 3, 4}, ConnectionID{4, 3, 2, 1})
}) tracer.StartedConnection(local, remote, VersionNumber(1234), ConnectionID{1, 2, 3, 4}, ConnectionID{4, 3, 2, 1})
})
It("traces the ReceivedTransportParameters event", func() { It("traces the ClosedConnection event", func() {
tp := &wire.TransportParameters{InitialMaxData: 1337} reason := NewTimeoutCloseReason(TimeoutReasonIdle)
tr1.EXPECT().ReceivedTransportParameters(tp) tr1.EXPECT().ClosedConnection(reason)
tr2.EXPECT().ReceivedTransportParameters(tp) tr2.EXPECT().ClosedConnection(reason)
tracer.ReceivedTransportParameters(tp) tracer.ClosedConnection(reason)
}) })
It("traces the SentPacket event", func() { It("traces the SentTransportParameters event", func() {
hdr := &ExtendedHeader{Header: Header{DestConnectionID: ConnectionID{1, 2, 3}}} tp := &wire.TransportParameters{InitialMaxData: 1337}
ack := &AckFrame{AckRanges: []AckRange{{Smallest: 1, Largest: 10}}} tr1.EXPECT().SentTransportParameters(tp)
ping := &PingFrame{} tr2.EXPECT().SentTransportParameters(tp)
tr1.EXPECT().SentPacket(hdr, ByteCount(1337), ack, []Frame{ping}) tracer.SentTransportParameters(tp)
tr2.EXPECT().SentPacket(hdr, ByteCount(1337), ack, []Frame{ping}) })
tracer.SentPacket(hdr, 1337, ack, []Frame{ping})
})
It("traces the ReceivedVersionNegotiationPacket event", func() { It("traces the ReceivedTransportParameters event", func() {
hdr := &Header{DestConnectionID: ConnectionID{1, 2, 3}} tp := &wire.TransportParameters{InitialMaxData: 1337}
tr1.EXPECT().ReceivedVersionNegotiationPacket(hdr, []VersionNumber{1337}) tr1.EXPECT().ReceivedTransportParameters(tp)
tr2.EXPECT().ReceivedVersionNegotiationPacket(hdr, []VersionNumber{1337}) tr2.EXPECT().ReceivedTransportParameters(tp)
tracer.ReceivedVersionNegotiationPacket(hdr, []VersionNumber{1337}) tracer.ReceivedTransportParameters(tp)
}) })
It("traces the ReceivedRetry event", func() { It("traces the SentPacket event", func() {
hdr := &Header{DestConnectionID: ConnectionID{1, 2, 3}} hdr := &ExtendedHeader{Header: Header{DestConnectionID: ConnectionID{1, 2, 3}}}
tr1.EXPECT().ReceivedRetry(hdr) ack := &AckFrame{AckRanges: []AckRange{{Smallest: 1, Largest: 10}}}
tr2.EXPECT().ReceivedRetry(hdr) ping := &PingFrame{}
tracer.ReceivedRetry(hdr) tr1.EXPECT().SentPacket(hdr, ByteCount(1337), ack, []Frame{ping})
}) tr2.EXPECT().SentPacket(hdr, ByteCount(1337), ack, []Frame{ping})
tracer.SentPacket(hdr, 1337, ack, []Frame{ping})
})
It("traces the ReceivedPacket event", func() { It("traces the ReceivedVersionNegotiationPacket event", func() {
hdr := &ExtendedHeader{Header: Header{DestConnectionID: ConnectionID{1, 2, 3}}} hdr := &Header{DestConnectionID: ConnectionID{1, 2, 3}}
ping := &PingFrame{} tr1.EXPECT().ReceivedVersionNegotiationPacket(hdr, []VersionNumber{1337})
tr1.EXPECT().ReceivedPacket(hdr, ByteCount(1337), []Frame{ping}) tr2.EXPECT().ReceivedVersionNegotiationPacket(hdr, []VersionNumber{1337})
tr2.EXPECT().ReceivedPacket(hdr, ByteCount(1337), []Frame{ping}) tracer.ReceivedVersionNegotiationPacket(hdr, []VersionNumber{1337})
tracer.ReceivedPacket(hdr, 1337, []Frame{ping}) })
})
It("traces the BufferedPacket event", func() { It("traces the ReceivedRetry event", func() {
tr1.EXPECT().BufferedPacket(PacketTypeHandshake) hdr := &Header{DestConnectionID: ConnectionID{1, 2, 3}}
tr2.EXPECT().BufferedPacket(PacketTypeHandshake) tr1.EXPECT().ReceivedRetry(hdr)
tracer.BufferedPacket(PacketTypeHandshake) tr2.EXPECT().ReceivedRetry(hdr)
}) tracer.ReceivedRetry(hdr)
})
It("traces the DroppedPacket event", func() { It("traces the ReceivedPacket event", func() {
tr1.EXPECT().DroppedPacket(PacketTypeInitial, ByteCount(1337), PacketDropHeaderParseError) hdr := &ExtendedHeader{Header: Header{DestConnectionID: ConnectionID{1, 2, 3}}}
tr2.EXPECT().DroppedPacket(PacketTypeInitial, ByteCount(1337), PacketDropHeaderParseError) ping := &PingFrame{}
tracer.DroppedPacket(PacketTypeInitial, 1337, PacketDropHeaderParseError) tr1.EXPECT().ReceivedPacket(hdr, ByteCount(1337), []Frame{ping})
}) tr2.EXPECT().ReceivedPacket(hdr, ByteCount(1337), []Frame{ping})
tracer.ReceivedPacket(hdr, 1337, []Frame{ping})
})
It("traces the UpdatedMetrics event", func() { It("traces the BufferedPacket event", func() {
rttStats := &RTTStats{} tr1.EXPECT().BufferedPacket(PacketTypeHandshake)
rttStats.UpdateRTT(time.Second, 0, time.Now()) tr2.EXPECT().BufferedPacket(PacketTypeHandshake)
tr1.EXPECT().UpdatedMetrics(rttStats, ByteCount(1337), ByteCount(42), 13) tracer.BufferedPacket(PacketTypeHandshake)
tr2.EXPECT().UpdatedMetrics(rttStats, ByteCount(1337), ByteCount(42), 13) })
tracer.UpdatedMetrics(rttStats, 1337, 42, 13)
})
It("traces the LostPacket event", func() { It("traces the DroppedPacket event", func() {
tr1.EXPECT().LostPacket(EncryptionHandshake, PacketNumber(42), PacketLossReorderingThreshold) tr1.EXPECT().DroppedPacket(PacketTypeInitial, ByteCount(1337), PacketDropHeaderParseError)
tr2.EXPECT().LostPacket(EncryptionHandshake, PacketNumber(42), PacketLossReorderingThreshold) tr2.EXPECT().DroppedPacket(PacketTypeInitial, ByteCount(1337), PacketDropHeaderParseError)
tracer.LostPacket(EncryptionHandshake, 42, PacketLossReorderingThreshold) tracer.DroppedPacket(PacketTypeInitial, 1337, PacketDropHeaderParseError)
}) })
It("traces the UpdatedPTOCount event", func() { It("traces the UpdatedMetrics event", func() {
tr1.EXPECT().UpdatedPTOCount(uint32(88)) rttStats := &RTTStats{}
tr2.EXPECT().UpdatedPTOCount(uint32(88)) rttStats.UpdateRTT(time.Second, 0, time.Now())
tracer.UpdatedPTOCount(88) tr1.EXPECT().UpdatedMetrics(rttStats, ByteCount(1337), ByteCount(42), 13)
}) tr2.EXPECT().UpdatedMetrics(rttStats, ByteCount(1337), ByteCount(42), 13)
tracer.UpdatedMetrics(rttStats, 1337, 42, 13)
})
It("traces the UpdatedKeyFromTLS event", func() { It("traces the LostPacket event", func() {
tr1.EXPECT().UpdatedKeyFromTLS(EncryptionHandshake, PerspectiveClient) tr1.EXPECT().LostPacket(EncryptionHandshake, PacketNumber(42), PacketLossReorderingThreshold)
tr2.EXPECT().UpdatedKeyFromTLS(EncryptionHandshake, PerspectiveClient) tr2.EXPECT().LostPacket(EncryptionHandshake, PacketNumber(42), PacketLossReorderingThreshold)
tracer.UpdatedKeyFromTLS(EncryptionHandshake, PerspectiveClient) tracer.LostPacket(EncryptionHandshake, 42, PacketLossReorderingThreshold)
}) })
It("traces the UpdatedKey event", func() { It("traces the UpdatedPTOCount event", func() {
tr1.EXPECT().UpdatedKey(KeyPhase(42), true) tr1.EXPECT().UpdatedPTOCount(uint32(88))
tr2.EXPECT().UpdatedKey(KeyPhase(42), true) tr2.EXPECT().UpdatedPTOCount(uint32(88))
tracer.UpdatedKey(KeyPhase(42), true) tracer.UpdatedPTOCount(88)
}) })
It("traces the DroppedEncryptionLevel event", func() { It("traces the UpdatedKeyFromTLS event", func() {
tr1.EXPECT().DroppedEncryptionLevel(EncryptionHandshake) tr1.EXPECT().UpdatedKeyFromTLS(EncryptionHandshake, PerspectiveClient)
tr2.EXPECT().DroppedEncryptionLevel(EncryptionHandshake) tr2.EXPECT().UpdatedKeyFromTLS(EncryptionHandshake, PerspectiveClient)
tracer.DroppedEncryptionLevel(EncryptionHandshake) tracer.UpdatedKeyFromTLS(EncryptionHandshake, PerspectiveClient)
}) })
It("traces the SetLossTimer event", func() { It("traces the UpdatedKey event", func() {
now := time.Now() tr1.EXPECT().UpdatedKey(KeyPhase(42), true)
tr1.EXPECT().SetLossTimer(TimerTypePTO, EncryptionHandshake, now) tr2.EXPECT().UpdatedKey(KeyPhase(42), true)
tr2.EXPECT().SetLossTimer(TimerTypePTO, EncryptionHandshake, now) tracer.UpdatedKey(KeyPhase(42), true)
tracer.SetLossTimer(TimerTypePTO, EncryptionHandshake, now) })
})
It("traces the LossTimerExpired event", func() { It("traces the DroppedEncryptionLevel event", func() {
tr1.EXPECT().LossTimerExpired(TimerTypePTO, EncryptionHandshake) tr1.EXPECT().DroppedEncryptionLevel(EncryptionHandshake)
tr2.EXPECT().LossTimerExpired(TimerTypePTO, EncryptionHandshake) tr2.EXPECT().DroppedEncryptionLevel(EncryptionHandshake)
tracer.LossTimerExpired(TimerTypePTO, EncryptionHandshake) tracer.DroppedEncryptionLevel(EncryptionHandshake)
}) })
It("traces the LossTimerCanceled event", func() { It("traces the SetLossTimer event", func() {
tr1.EXPECT().LossTimerCanceled() now := time.Now()
tr2.EXPECT().LossTimerCanceled() tr1.EXPECT().SetLossTimer(TimerTypePTO, EncryptionHandshake, now)
tracer.LossTimerCanceled() tr2.EXPECT().SetLossTimer(TimerTypePTO, EncryptionHandshake, now)
}) tracer.SetLossTimer(TimerTypePTO, EncryptionHandshake, now)
})
It("traces the Close event", func() { It("traces the LossTimerExpired event", func() {
tr1.EXPECT().Close() tr1.EXPECT().LossTimerExpired(TimerTypePTO, EncryptionHandshake)
tr2.EXPECT().Close() tr2.EXPECT().LossTimerExpired(TimerTypePTO, EncryptionHandshake)
tracer.Close() tracer.LossTimerExpired(TimerTypePTO, EncryptionHandshake)
})
It("traces the LossTimerCanceled event", func() {
tr1.EXPECT().LossTimerCanceled()
tr2.EXPECT().LossTimerCanceled()
tracer.LossTimerCanceled()
})
It("traces the Close event", func() {
tr1.EXPECT().Close()
tr2.EXPECT().Close()
tracer.Close()
})
}) })
}) })