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.

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

Jump to bottom

[docs] Added description of SRT perf statistics #897

Merged
merged 11 commits into from Oct 15, 2019
Merged

[docs] Added description of SRT perf statistics #897

merged 11 commits into from Oct 15, 2019

Conversation

maxsharabayko
Copy link
Collaborator

@maxsharabayko maxsharabayko commented Oct 8, 2019 •
edited

This PR adds description to the SRT performance statistics (CBytePerfMon).
Fixes #142

TODO:

  • Describe all performance stats values (members of CBytePerfMon)
  • Add reference to statistics.md in API-functions.md (from srt_bstats()).
  • Add backward reference to API-functions.md in statistics.md (srt_bstats()).
  • Fix SRTO_SNDDROPDELAY description.
  • Merge existing description of some of the performance stats from API-functions.md to statistics.md.

@maxsharabayko maxsharabayko added the [docs] Area: Improvements or additions to documentation label Oct 8, 2019
@maxsharabayko maxsharabayko added this to the v1.4.1 milestone Oct 8, 2019
@maxsharabayko maxsharabayko self-assigned this Oct 8, 2019
@maxsharabayko maxsharabayko added this to Needs review in Development via automation Oct 8, 2019
stevomatthews
stevomatthews reviewed Oct 8, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 8, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 8, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 8, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 8, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 8, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 8, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 8, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
@maxsharabayko maxsharabayko mentioned this pull request Oct 10, 2019
Closed
@maxsharabayko maxsharabayko marked this pull request as ready for review October 10, 2019 10:33
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 10, 2019
View reviewed changes
Copy link
Collaborator

@stevomatthews stevomatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor edits, line by line.

stevomatthews
stevomatthews reviewed Oct 15, 2019
View reviewed changes
docs/statistics.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Oct 15, 2019
View reviewed changes
docs/statistics.md Outdated

## pktSent

Same as `pktSentTotal`, but on the interval.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While the statements in this section are grammatically correct, it might be clearer to say "… but for a specified interval."

stevomatthews
stevomatthews reviewed Oct 15, 2019
View reviewed changes
Copy link
Collaborator

@stevomatthews stevomatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partial review (up to line 286) completed.

@stevomatthews
Minor edit in "Interval-based measurements"
40243b3 
"…but on the interval." > "…but for a specified interval."
@stevomatthews
Final review with minor edits
238f329
@rndi rndi merged commit 6bc7e6e into Haivision:master Oct 15, 2019
Development automation moved this from Needs review to Done Oct 15, 2019
@maxsharabayko maxsharabayko deleted the docs/perf-statistics branch October 25, 2019 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevomatthews stevomatthews stevomatthews left review comments

Assignees

@maxsharabayko maxsharabayko

Labels
[docs] Area: Improvements or additions to documentation
Projects
No open projects
Development
  
Done
Milestone
v1.4.1
Development

Successfully merging this pull request may close these issues.

More description is needed for stats' paparmeters
3 participants
@maxsharabayko @stevomatthews @rndi