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

[Statistics] Improve SRT core statistics documentation #1207

Open
5 of 15 tasks
mbakholdina opened this issue Mar 25, 2020 · 1 comment
Open
5 of 15 tasks

[Statistics] Improve SRT core statistics documentation #1207

mbakholdina opened this issue Mar 25, 2020 · 1 comment
Assignees
Labels
[docs] Area: Improvements or additions to documentation Type: Enhancement Indicates new feature requests
Milestone

Comments

@mbakholdina
Copy link
Collaborator

mbakholdina commented Mar 25, 2020

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:

  • Check how the statistics is calculated on both sides and add corresponding comments plus add a comment regarding estimations exchange between rcv and snd through ACK packets,
  • Statistics are calculated independently on each side (receiver and sender) and are not exchanged between peers unless explicitly stated. - Update this sentence from the very beginning to reflect the idea of "unless explicitly stated".
  • 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

  • Revise the following text: "The total delay before TLPKTDROP mechanism is triggered consists of the SRTO_PEERLATENCY, plus SRTO_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.

  • FEC related statistics:
  • Would be nice to revise how FEC statistics is calculated and whether it affects the regular SRT statistics.
  • Make a note (if does not exist) in FEC documentation: Packet filter control packets are SRT DATA packets. Why not make FEC packets SRT CONTROL?
  • Issue [BUG] Bandwidth Estimation with SRT 1.4.1 is always 0 #1021
@mbakholdina mbakholdina added Type: Enhancement Indicates new feature requests [docs] Area: Improvements or additions to documentation labels Mar 25, 2020
@mbakholdina mbakholdina self-assigned this Mar 25, 2020
@mbakholdina mbakholdina added this to the v1.5.0 milestone Mar 25, 2020
@mbakholdina mbakholdina changed the title Improve SRT core statistics documentation [Statistics] Improve SRT core statistics documentation Mar 25, 2020
@mbakholdina
Copy link
Collaborator Author

@ethouris Could you please help me with improving the current description for pktSndDropTotal, pktRcvDropTotal statistics of individual socket. I suggest to create a PR from the current master and correct only these 2 statistics. Please make me a reviewer.

@mbakholdina mbakholdina modified the milestones: v1.5.0, Parking Lot May 28, 2020
@mbakholdina mbakholdina modified the milestones: v1.5.0, v1.5.1 Aug 7, 2020
@mbakholdina mbakholdina modified the milestones: v1.5.1, Backlog May 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[docs] Area: Improvements or additions to documentation Type: Enhancement Indicates new feature requests
Projects
None yet
Development

No branches or pull requests

1 participant