Skip to content

Commit

Permalink
Add ice transport api to get selected pair stats
Browse files Browse the repository at this point in the history
In use cases like SFU, it is useful to get just the selected candidate
pair stats to have access to current RTT on the peer connection. The
standard has a way to do `GetSelectedCandidatePair` on `ICETransport`,
but does not have a way to get stats of that pair.

Although not in standard, adding a method to `ICETransport` to get
selected candidate pair along similar lines of above method.
  • Loading branch information
boks1971 committed Oct 7, 2024
1 parent d6141bd commit 3851bc2
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 3 deletions.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ go 1.20
require (
github.com/pion/datachannel v1.5.9
github.com/pion/dtls/v3 v3.0.3
github.com/pion/ice/v4 v4.0.1
github.com/pion/ice/v4 v4.0.2
github.com/pion/interceptor v0.1.37
github.com/pion/logging v0.2.2
github.com/pion/randutil v0.1.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ github.com/pion/datachannel v1.5.9 h1:LpIWAOYPyDrXtU+BW7X0Yt/vGtYxtXQ8ql7dFfYUVZ
github.com/pion/datachannel v1.5.9/go.mod h1:kDUuk4CU4Uxp82NH4LQZbISULkX/HtzKa4P7ldf9izE=
github.com/pion/dtls/v3 v3.0.3 h1:j5ajZbQwff7Z8k3pE3S+rQ4STvKvXUdKsi/07ka+OWM=
github.com/pion/dtls/v3 v3.0.3/go.mod h1:weOTUyIV4z0bQaVzKe8kpaP17+us3yAuiQsEAG1STMU=
github.com/pion/ice/v4 v4.0.1 h1:2d3tPoTR90F3TcGYeXUwucGlXI3hds96cwv4kjZmb9s=
github.com/pion/ice/v4 v4.0.1/go.mod h1:2dpakjpd7+74L5j3TAe6gvkbI5UIzOgAnkimm9SuHvA=
github.com/pion/ice/v4 v4.0.2 h1:1JhBRX8iQLi0+TfcavTjPjI6GO41MFn4CeTBX+Y9h5s=
github.com/pion/ice/v4 v4.0.2/go.mod h1:DCdqyzgtsDNYN6/3U8044j3U7qsJ9KFJC92VnOWHvXg=
github.com/pion/interceptor v0.1.37 h1:aRA8Zpab/wE7/c0O3fh1PqY0AJI3fCSEM5lRWJVorwI=
github.com/pion/interceptor v0.1.37/go.mod h1:JzxbJ4umVTlZAf+/utHzNesY8tmRkM2lVmkS82TTj8Y=
github.com/pion/logging v0.2.2 h1:M9+AIj/+pxNsDfAT64+MAVgJO0rsyLnoJKCqf//DoeY=
Expand Down
51 changes: 51 additions & 0 deletions icegatherer.go
Original file line number Diff line number Diff line change
Expand Up @@ -409,3 +409,54 @@ func (g *ICEGatherer) collectStats(collector *statsReportCollector) {
collector.Done()
}(collector, agent)
}

func (g *ICEGatherer) getSelectedCandidatePairStats() (ICECandidatePairStats, bool) {
agent := g.getAgent()
if agent == nil {
return ICECandidatePairStats{}, false
}

selectedCandidatePairStats, isAvailable := agent.GetSelectedCandidatePairStats()
if !isAvailable {
return ICECandidatePairStats{}, false
}

state, err := toStatsICECandidatePairState(selectedCandidatePairStats.State)
if err != nil {
g.log.Error(err.Error())
}

pairID := newICECandidatePairStatsID(selectedCandidatePairStats.LocalCandidateID, selectedCandidatePairStats.RemoteCandidateID)
return ICECandidatePairStats{
Timestamp: statsTimestampFrom(selectedCandidatePairStats.Timestamp),
Type: StatsTypeCandidatePair,
ID: pairID,
// TransportID:
LocalCandidateID: selectedCandidatePairStats.LocalCandidateID,
RemoteCandidateID: selectedCandidatePairStats.RemoteCandidateID,
State: state,
Nominated: selectedCandidatePairStats.Nominated,
PacketsSent: selectedCandidatePairStats.PacketsSent,
PacketsReceived: selectedCandidatePairStats.PacketsReceived,
BytesSent: selectedCandidatePairStats.BytesSent,
BytesReceived: selectedCandidatePairStats.BytesReceived,
LastPacketSentTimestamp: statsTimestampFrom(selectedCandidatePairStats.LastPacketSentTimestamp),
LastPacketReceivedTimestamp: statsTimestampFrom(selectedCandidatePairStats.LastPacketReceivedTimestamp),
FirstRequestTimestamp: statsTimestampFrom(selectedCandidatePairStats.FirstRequestTimestamp),
LastRequestTimestamp: statsTimestampFrom(selectedCandidatePairStats.LastRequestTimestamp),
LastResponseTimestamp: statsTimestampFrom(selectedCandidatePairStats.LastResponseTimestamp),
TotalRoundTripTime: selectedCandidatePairStats.TotalRoundTripTime,
CurrentRoundTripTime: selectedCandidatePairStats.CurrentRoundTripTime,
AvailableOutgoingBitrate: selectedCandidatePairStats.AvailableOutgoingBitrate,
AvailableIncomingBitrate: selectedCandidatePairStats.AvailableIncomingBitrate,
CircuitBreakerTriggerCount: selectedCandidatePairStats.CircuitBreakerTriggerCount,
RequestsReceived: selectedCandidatePairStats.RequestsReceived,
RequestsSent: selectedCandidatePairStats.RequestsSent,
ResponsesReceived: selectedCandidatePairStats.ResponsesReceived,
ResponsesSent: selectedCandidatePairStats.ResponsesSent,
RetransmissionsReceived: selectedCandidatePairStats.RetransmissionsReceived,
RetransmissionsSent: selectedCandidatePairStats.RetransmissionsSent,
ConsentRequestsSent: selectedCandidatePairStats.ConsentRequestsSent,
ConsentExpiredTimestamp: statsTimestampFrom(selectedCandidatePairStats.ConsentExpiredTimestamp),
}, true
}
6 changes: 6 additions & 0 deletions icetransport.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ func (t *ICETransport) GetSelectedCandidatePair() (*ICECandidatePair, error) {
return NewICECandidatePair(&local, &remote), nil
}

// GetSelectedCandidatePairStats returns the selected candidate pair stats on which packets are sent
// if there is no selected pair empty stats, false is returned to indicate stats not avaiable

Check failure on line 74 in icetransport.go

View workflow job for this annotation

GitHub Actions / lint / Go

`avaiable` is a misspelling of `available` (misspell)
func (t *ICETransport) GetSelectedCandidatePairStats() (ICECandidatePairStats, bool) {
return t.gatherer.getSelectedCandidatePairStats()
}

// NewICETransport creates a new NewICETransport.
func NewICETransport(gatherer *ICEGatherer, loggerFactory logging.LoggerFactory) *ICETransport {
iceTransport := &ICETransport{
Expand Down
8 changes: 8 additions & 0 deletions icetransport_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -98,21 +98,29 @@ func TestICETransport_GetSelectedCandidatePair(t *testing.T) {
offererSelectedPair, err := offerer.SCTP().Transport().ICETransport().GetSelectedCandidatePair()
assert.NoError(t, err)
assert.Nil(t, offererSelectedPair)
_, statsAvailable := offerer.SCTP().Transport().ICETransport().GetSelectedCandidatePairStats()
assert.False(t, statsAvailable)

answererSelectedPair, err := answerer.SCTP().Transport().ICETransport().GetSelectedCandidatePair()
assert.NoError(t, err)
assert.Nil(t, answererSelectedPair)
_, statsAvailable = answerer.SCTP().Transport().ICETransport().GetSelectedCandidatePairStats()
assert.False(t, statsAvailable)

assert.NoError(t, signalPair(offerer, answerer))
peerConnectionConnected.Wait()

offererSelectedPair, err = offerer.SCTP().Transport().ICETransport().GetSelectedCandidatePair()
assert.NoError(t, err)
assert.NotNil(t, offererSelectedPair)
_, statsAvailable = offerer.SCTP().Transport().ICETransport().GetSelectedCandidatePairStats()
assert.True(t, statsAvailable)

answererSelectedPair, err = answerer.SCTP().Transport().ICETransport().GetSelectedCandidatePair()
assert.NoError(t, err)
assert.NotNil(t, answererSelectedPair)
_, statsAvailable = answerer.SCTP().Transport().ICETransport().GetSelectedCandidatePairStats()
assert.True(t, statsAvailable)

closePairNow(t, offerer, answerer)
}
Expand Down

0 comments on commit 3851bc2

Please sign in to comment.