[Statistics] Improve SRT core statistics documentation #1207
Labels
[docs]
Area: Improvements or additions to documentation
Type: Enhancement
Indicates new feature requests
Milestone
Improve SRT core statistics documentation.
Related Issues: #1215, #1213.
Related PRs: #1199, #1216.
First Priority
Summary table: Fill in the remain empty cells of the receiver.
Available for sender / Available for receiver: Check that detailed description of all the statistics contains either "Available for sender" or "Available for receiver"
Fix the links.
msRTT, mbpsBandwidth:
Not all the statistics have mentioning that it's data packets, e.g.,
pktRecvTotal
- correct this.Formulas for calculation of loss ratio, dropped packets ratio, the number of recovered/unrecovered packets, etc.
Improve the description of pktRcvLossTotal statistic.
Improve the description of pktSndDropTotal, pktRcvDropTotal statistics.
Instantaneous statistics: Check how moving average is calculated for all the instantaneous statistics. See issue [BUG] Statistics always return instantaneous value for send and recv buffers #1272.
Second Priority
pktRcvLossTotal: See issue [Statistics] Correct the way of pktRcvLossTotal statistic calculation #1212.
pktRetransTotal, byteRetransTotal: See issue [Statistics] Change the name of statistic "pktRetransTotal" to "pktSndRetransTotal" #1209. Check corresponding interval-based stats.
pktRcvRetransTotal, byteRcvRetransTotal (both not implemented): See issue [Statistics] Add the calculation of pktRcvRetransTotal and byteRcvRetransTotal statistics #1208. Check corresponding interval-based stats.
pktRcvBelatedTotal (not implemented): See issue [Statistics] Implement pktRcvBelatedTotal statistic #1214.
pktSndDropTotal:
Revise the following text: "The total delay before TLPKTDROP mechanism is triggered consists of the
SRTO_PEERLATENCY
, plusSRTO_SNDDROPDELAY
, plus 2 * the ACK interval (default ACK interval is 10 ms). The delay used is the timespan between the very first packet and the latest packet in the sender's buffer."Better to update the RFC with this information and from statistics documentation make a link to the RFC.
The text was updated successfully, but these errors were encountered: