sar: add page #1532

mfrw · 2017-10-07T23:32:54Z

Fixes #1529.

The page (if new), does not already exist in the repo.
The page (if new), has been added to the correct platform folder:
common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.
The page has 8 or fewer examples.
The PR is appropriately titled:
<command name>: add page for new pages, or <command name>: <description of changes> for pages being edited
The page follows the contributing guidelines

sbrl

Hey, thanks for the page! I've left a few comments 😺

sbrl · 2017-10-09T19:30:47Z

pages/linux/sar.md

+
+> Monitor performance of various Linux subsystems.
+
+- Report I/O and Transfer rate every 1 second:


Don't think Transfer needs to have a capital letter at the beginning.

sure, acutally the manpage had I/O and Transfer in upper-case, so i did the same.
anyways changed

sbrl · 2017-10-09T19:33:40Z

pages/linux/sar.md

+
+- Report I/O and Transfer rate every 1 second:
+
+`sar -b 1`


There aren't any long forms of the options?

unfortunately not :(

sbrl · 2017-10-09T19:34:46Z

pages/linux/sar.md

+
+`sar -u ALL 2`
+
+- Report 20 memory utilization statistics every 1 second:


This feels a bit awkward. Perhaps we could reword this to something like ...statistics, one per second?

Should it be "once per second" ? I think that sounds better and more natural.

On further thought, I think it should be changed to "once every second". Because the other examples are of the form "every 2 seconds", "every 5 seconds" and then you have "one per second", "one per 2 seconds".

Either we use "per second" everywhere or "every second" everywhere. But mixing the 2 does not sound right to me.

sbrl · 2017-10-09T19:35:50Z

pages/linux/sar.md

+
+`sar -q 1 1`
+
+- Report paging statistics every 1 second:


Perhaps we could change this example to every 5 seconds to change things up? 😺

agnivade

Please wrap all of your variables in tokens. See the CONTRIBUTING page for how to do it.

Also, when you mention "Report n some statistics", what does it mean ? Does it mean it will print the statistics n times, every x seconds ?

agnivade · 2017-10-10T17:56:35Z

pages/linux/sar.md

+
+> Monitor performance of various Linux subsystems.
+
+- Report I/O and Transfer rate every 1 second:


What transfer rate are we talking about ?

physical devices, added to the description

agnivade · 2017-10-10T17:56:51Z

pages/linux/sar.md

+
+- Report I/O and Transfer rate every 1 second:
+
+`sar -b 1`


Please wrap 1 in tokens.

sorry for missing it ...
fixed

agnivade · 2017-10-11T04:19:06Z

pages/linux/sar.md

+
+`sar -n DEV {{2}} {{10}}`
+
+- Report CPU utilization every 2 seconds (press CTRL+C to quit):


No need to mention 'press ctrl-c to quit' after the first time. It's obvious.

agnivade · 2017-10-11T04:19:43Z

pages/linux/sar.md

+
+`sar -u ALL {{2}}`
+
+- Report a total of 20 memory utilization statistics,  one per second:


double space between "," and "one"

agnivade · 2017-10-11T04:20:56Z

pages/linux/sar.md

+
+- Report the run queue length and load averages:
+
+`sar -q {{1}} {{1}}`


Does the first 1 mean its once per second, should we mention that if that is the case ?

almost every command has the same structure, the first arg is the refresh granularity, and the second (if any) is the total number of stats to print.
If the second arg is not provided, it assumes infinity.

So, I think this is obvious, and we should not write it explicitly to confuse people

I got a bit confused because you mention 2 things - queue length and load average, and then there are 2 params. Its not very obvious whether the two "1"s are for granularity and no. of stats, or the granularity for queue length and load svg.

That's why I wanted to be extra clear in case there's any confusion. What do you think ?

I think lets just skip the second param, if anyone wants, it is present in the man page.
This would make it less confusing.

agnivade · 2017-10-11T08:41:23Z

Hey @mfrw - left a couple of comments.

Sorry for the back and forth. Our review process might feel a bit tedious. Thank you for the patience !

mfrw · 2017-10-11T09:20:45Z

@agnivade your review process is amazing. I am getting to learn a lot of things. I am new to open-source.
Thanks for your patience :)

sbrl · 2017-10-11T10:43:03Z

Thanks for the hard work, @mfrw! 😺

sar: add page (tldr-pages#1529)

dac2165

mfrw changed the title ~~sar: add page (#1529)~~ sar: add page Oct 7, 2017

sbrl requested changes Oct 9, 2017

View reviewed changes

agnivade requested changes Oct 10, 2017

View reviewed changes

mfrw added 2 commits October 11, 2017 04:43

sar: rewrite descriptions to be more clear

63a52ca

sar: correct typo for sar -B

33bbefc

agnivade requested changes Oct 11, 2017

View reviewed changes

sar: remove crtl+c after first time

45fe73e

sar: write coherent descriptions

c743a1c

agnivade approved these changes Oct 11, 2017

View reviewed changes

sbrl approved these changes Oct 11, 2017

View reviewed changes

sbrl merged commit 1f76947 into tldr-pages:master Oct 11, 2017

mfrw deleted the sar branch September 6, 2018 14:54

sbrl mentioned this pull request Sep 6, 2018

Add @mfrw as a collaborator #2306

Closed

tansiret added the new command Issues requesting creation of a new page. label Apr 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sar: add page #1532

sar: add page #1532

mfrw commented Oct 7, 2017 •

edited by sbrl

Loading

sbrl left a comment

sbrl Oct 9, 2017

mfrw Oct 10, 2017

sbrl Oct 9, 2017

mfrw Oct 10, 2017

sbrl Oct 9, 2017

mfrw Oct 10, 2017

agnivade Oct 11, 2017

agnivade Oct 11, 2017

sbrl Oct 9, 2017

mfrw Oct 10, 2017

agnivade left a comment

agnivade Oct 10, 2017

mfrw Oct 10, 2017

agnivade Oct 10, 2017

mfrw Oct 10, 2017

agnivade Oct 11, 2017

mfrw Oct 11, 2017

agnivade Oct 11, 2017

mfrw Oct 11, 2017

agnivade Oct 11, 2017

mfrw Oct 11, 2017

agnivade Oct 11, 2017

mfrw Oct 11, 2017

agnivade commented Oct 11, 2017

mfrw commented Oct 11, 2017

sbrl commented Oct 11, 2017


		> Monitor performance of various Linux subsystems.

		- Report I/O and Transfer rate every 1 second:


		`sar -u ALL 2`

		- Report 20 memory utilization statistics every 1 second:


		`sar -n DEV {{2}} {{10}}`

		- Report CPU utilization every 2 seconds (press CTRL+C to quit):


		`sar -u ALL {{2}}`

		- Report a total of 20 memory utilization statistics, one per second:


		- Report the run queue length and load averages:

		`sar -q {{1}} {{1}}`

sar: add page #1532

sar: add page #1532

Conversation

mfrw commented Oct 7, 2017 • edited by sbrl Loading

Fixes #1529.

sbrl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agnivade left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agnivade commented Oct 11, 2017

mfrw commented Oct 11, 2017

sbrl commented Oct 11, 2017

mfrw commented Oct 7, 2017 •

edited by sbrl

Loading