Skip to content

Commit

Permalink
add internal manpage
Browse files Browse the repository at this point in the history 
Summary:
add internal manpage for below.
Since it contains internal scuba commands, this must be merged after D67724204

Reviewed By: davide125, lnyng

Differential Revision: D67724454

fbshipit-source-id: deaacf9bf682b81408f9e5e5245c6e52862b2d53
  • Loading branch information
@teknoraver @facebook-github-bot
teknoraver authored and facebook-github-bot committed Jan 8, 2025
1 parent 91e20cd commit 73ae75e
Show file tree
Hide file tree
Showing 2 changed files with 1,788 additions and 67 deletions.
134 changes: 67 additions & 67 deletions below/below.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH BELOW 1 "December 2024" "Version 1.0" "System Monitoring Tools"
.TH BELOW 1 "January 2025" "Version 0.8.1" "System Monitoring Tools"
.SH NAME
below \- interactive tool to view and record historical system data

Expand All @@ -8,11 +8,11 @@ below \- interactive tool to view and record historical system data

.SH DESCRIPTION
.B below
is an interactive tool designed to view, record, and analyze historical system data.
It provides a set of subcommands to interact with live or recorded system performance metrics
is an interactive tool designed to view, record, and analyze historical system data.
It provides a set of subcommands to interact with live or recorded system performance metrics
and supports operations like recording, replaying, and exporting data.

If no subcommand is specified, the tool defaults to the \fBlive\fR mode, which displays live
If no subcommand is specified, the tool defaults to the \fBlive\fR mode, which displays live
system data interactively.

.SH GLOBAL OPTIONS
Expand Down Expand Up @@ -86,7 +86,7 @@ Note: If \fB--store-size-limit\fR is set, data may be discarded earlier.

.TP
.B --store-size-limit <STORE_SIZE_LIMIT>
Set the maximum storage size in bytes. Data is stored in 24-hour shards, and the oldest shards are deleted first.
Set the maximum storage size in bytes. Data is stored in 24-hour shards, and the oldest shards are deleted first.
.RS
.IP
Note: The size limit may be exceeded by the active shard.
Expand Down Expand Up @@ -257,7 +257,7 @@ Dump the transport layer stats including tcp and udp
Dump network interface queue stats

.TP
.B tc
.B tc
Dump the tc related stats with qdiscs

.SS dump system
Expand Down Expand Up @@ -397,83 +397,83 @@ write, discard, fs_info, timestamp].

.SS OPTIONS
.TP
\fB-f, --fields <FIELDS>...\fR
\fB-f, --fields <FIELDS>...\fR
Select which fields to display and in what order.

.TP
\fB--default\fR
\fB--default\fR
Show all top-layer fields. Overrides fields specified via \fB--fields\fR.

.TP
\fB--everything\fR
\fB--everything\fR
Show all fields. Overrides \fB--fields\fR and \fB--default\fR.

.TP
\fB-d, --detail\fR
\fB-d, --detail\fR
Show more information beyond the default fields.

.TP
\fB-b, --begin <BEGIN>\fR
\fB-b, --begin <BEGIN>\fR
Specify the start time, in the same format as the replay command.

.TP
\fB-e, --end <END>\fR
\fB-e, --end <END>\fR
Specify the end time, in the same format as the replay command.

.TP
\fB--duration <DURATION>\fR
\fB--duration <DURATION>\fR
Specify a duration using time strings (e.g., "10 min"). Supports keywords like "days", "min", "h", "sec" and relative times (e.g., "2 days 3 hr 15m 10sec").

.TP
\fB-F, --filter <FILTER>\fR
\fB-F, --filter <FILTER>\fR
Apply a regex filter to the field specified by \fB--select\fR.

.TP
\fB--sort\fR
\fB--sort\fR
Sort in ascending order by the field specified with \fB--select\fR.

.TP
\fB--rsort\fR
\fB--rsort\fR
Sort in descending order by the field specified with \fB--select\fR.

.TP
\fB--top <TOP>\fR
\fB--top <TOP>\fR
Display the top N results for each time slice. Default is 0 (show all).

.TP
\fB--repeat-title <REPEAT_TITLE>\fR
\fB--repeat-title <REPEAT_TITLE>\fR
Repeat the title line every N lines in raw output format.

.TP
\fB-O, --output-format <OUTPUT_FORMAT>\fR
\fB-O, --output-format <OUTPUT_FORMAT>\fR
Specify the output format. Options are \fBraw\fR, \fBcsv\fR, \fBtsv\fR, \fBkv\fR, \fBjson\fR, and \fBopenmetrics\fR. Defaults to \fBraw\fR.

.TP
\fB-o, --output <OUTPUT>\fR
\fB-o, --output <OUTPUT>\fR
Specify the output destination. Defaults to stdout.

.TP
\fB--disable-title\fR
\fB--disable-title\fR
Disable the title in raw, csv, or tsv format output.

.TP
\fB-r <YESTERDAYS>\fR
\fB-r <YESTERDAYS>\fR
Adjust the day offset, similar to the \fB-r\fR option in the replay command.

.TP
\fB--br <BR>\fR
\fB--br <BR>\fR
Specify the line break symbol between samples.

.TP
\fB--raw\fR
\fB--raw\fR
Dump raw data without units or conversions.

.TP
\fB-s, --select <SELECT>\fR
\fB-s, --select <SELECT>\fR
Specify a field for operations (used with \fB--sort\fR, \fB--rsort\fR, \fB--filter\fR, \fB--top\fR).

.TP
\fB-p, --pattern <PATTERN>\fR
\fB-p, --pattern <PATTERN>\fR
Use a saved pattern from the \fBdumprc\fR file under the \fB[disk]\fR section.

.SS Examples
Expand Down Expand Up @@ -517,83 +517,83 @@ Dump Btrfs filesystem statistics.

.SS OPTIONS
.TP
\fB-f, --fields <FIELDS>\fR
\fB-f, --fields <FIELDS>\fR
Select which fields to display and in what order.

.TP
\fB--default\fR
\fB--default\fR
Show all top-layer fields. Overrides fields specified via \fB--fields\fR.

.TP
\fB--everything\fR
\fB--everything\fR
Show all fields. Overrides \fB--fields\fR and \fB--default\fR.

.TP
\fB-d, --detail\fR
\fB-d, --detail\fR
Show more information beyond the default fields.

.TP
\fB-b, --begin <BEGIN>\fR
\fB-b, --begin <BEGIN>\fR
Specify the start time, in the same format as the replay command.

.TP
\fB-e, --end <END>\fR
\fB-e, --end <END>\fR
Specify the end time, in the same format as the replay command.

.TP
\fB--duration <DURATION>\fR
\fB--duration <DURATION>\fR
Specify a duration using time strings (e.g., "10 min"). Supports keywords like "days", "min", "h", "sec" and relative times (e.g., "2 days 3 hr 15m 10sec").

.TP
\fB-F, --filter <FILTER>\fR
\fB-F, --filter <FILTER>\fR
Apply a regex filter to the field specified by \fB--select\fR.

.TP
\fB--sort\fR
\fB--sort\fR
Sort in ascending order by the field specified with \fB--select\fR.

.TP
\fB--rsort\fR
\fB--rsort\fR
Sort in descending order by the field specified with \fB--select\fR.

.TP
\fB--top <TOP>\fR
\fB--top <TOP>\fR
Display the top N results for each time slice. Default is 0 (show all).

.TP
\fB--repeat-title <REPEAT_TITLE>\fR
\fB--repeat-title <REPEAT_TITLE>\fR
Repeat the title line every N lines in raw output format.

.TP
\fB-O, --output-format <OUTPUT_FORMAT>\fR
\fB-O, --output-format <OUTPUT_FORMAT>\fR
Specify the output format. Options are \fBraw\fR, \fBcsv\fR, \fBtsv\fR, \fBkv\fR, \fBjson\fR, and \fBopenmetrics\fR. Defaults to \fBraw\fR.

.TP
\fB-o, --output <OUTPUT>\fR
\fB-o, --output <OUTPUT>\fR
Specify the output destination. Defaults to stdout.

.TP
\fB--disable-title\fR
\fB--disable-title\fR
Disable the title in raw, csv, or tsv format output.

.TP
\fB-r <YESTERDAYS>\fR
\fB-r <YESTERDAYS>\fR
Adjust the day offset, similar to the \fB-r\fR option in the replay command.

.TP
\fB--br <BR>\fR
\fB--br <BR>\fR
Specify the line break symbol between samples.

.TP
\fB--raw\fR
\fB--raw\fR
Dump raw data without units or conversions.

.TP
\fB-s, --select <SELECT>\fR
\fB-s, --select <SELECT>\fR
Specify a field for operations (used with \fB--sort\fR, \fB--rsort\fR, \fB--filter\fR, \fB--top\fR).

.TP
\fB-p, --pattern <PATTERN>\fR
\fB-p, --pattern <PATTERN>\fR
Use a saved pattern from the \fBdumprc\fR file under the \fB[btrfs]\fR section.

.SS Examples
Expand Down Expand Up @@ -640,83 +640,83 @@ cgroup, timestamp, cmdline, exe_path].

.SS OPTIONS
.TP
\fB-f, --fields <FIELDS>\fR
\fB-f, --fields <FIELDS>\fR
Select which fields to display and in what order.

.TP
\fB--default\fR
\fB--default\fR
Show all top-layer fields. Overrides fields specified via \fB--fields\fR.

.TP
\fB--everything\fR
\fB--everything\fR
Show all fields. Overrides \fB--fields\fR and \fB--default\fR.

.TP
\fB-d, --detail\fR
\fB-d, --detail\fR
Show more information beyond the default fields.

.TP
\fB-b, --begin <BEGIN>\fR
\fB-b, --begin <BEGIN>\fR
Specify the start time, in the same format as the replay command.

.TP
\fB-e, --end <END>\fR
\fB-e, --end <END>\fR
Specify the end time, in the same format as the replay command.

.TP
\fB--duration <DURATION>\fR
\fB--duration <DURATION>\fR
Specify a duration using time strings (e.g., "10 min"). Supports keywords like "days", "min", "h", "sec" and relative times (e.g., "2 days 3 hr 15m 10sec").

.TP
\fB-F, --filter <FILTER>\fR
\fB-F, --filter <FILTER>\fR
Apply a regex filter to the field specified by \fB--select\fR.

.TP
\fB--sort\fR
\fB--sort\fR
Sort in ascending order by the field specified with \fB--select\fR.

.TP
\fB--rsort\fR
\fB--rsort\fR
Sort in descending order by the field specified with \fB--select\fR.

.TP
\fB--top <TOP>\fR
\fB--top <TOP>\fR
Display the top N results for each time slice. Default is 0 (show all).

.TP
\fB--repeat-title <REPEAT_TITLE>\fR
\fB--repeat-title <REPEAT_TITLE>\fR
Repeat the title line every N lines in raw output format.

.TP
\fB-O, --output-format <OUTPUT_FORMAT>\fR
\fB-O, --output-format <OUTPUT_FORMAT>\fR
Specify the output format. Options are \fBraw\fR, \fBcsv\fR, \fBtsv\fR, \fBkv\fR, \fBjson\fR, and \fBopenmetrics\fR. Defaults to \fBraw\fR.

.TP
\fB-o, --output <OUTPUT>\fR
\fB-o, --output <OUTPUT>\fR
Specify the output destination. Defaults to stdout.

.TP
\fB--disable-title\fR
\fB--disable-title\fR
Disable the title in raw, csv, or tsv format output.

.TP
\fB-r <YESTERDAYS>\fR
\fB-r <YESTERDAYS>\fR
Adjust the day offset, similar to the \fB-r\fR option in the replay command.

.TP
\fB--br <BR>\fR
\fB--br <BR>\fR
Specify the line break symbol between samples.

.TP
\fB--raw\fR
\fB--raw\fR
Dump raw data without units or conversions.

.TP
\fB-s, --select <SELECT>\fR
\fB-s, --select <SELECT>\fR
Specify a field for operations (used with \fB--sort\fR, \fB--rsort\fR, \fB--filter\fR, \fB--top\fR).

.TP
\fB-p, --pattern <PATTERN>\fR
\fB-p, --pattern <PATTERN>\fR
Use a saved pattern from the \fBdumprc\fR file under the \fB[process]\fR section.

.SS Examples
Expand Down Expand Up @@ -1645,7 +1645,7 @@ below dump > output.txt
.fi

.SH SEE ALSO
.B top(1), htop(1), iostat(1), vmstat(8)
.B top(1), htop(1), atop(1), iostat(1), vmstat(8)

.SH AUTHOR
Meta Platforms, Inc.
Expand Down
Loading

0 comments on commit 73ae75e

Please sign in to comment.