rib / gputop

A GPU profiling tool
160 stars 37 forks source link

Incomplete/Nonfunctional help menu #196

Closed cmpatel8588 closed 5 years ago

cmpatel8588 commented 5 years ago

As gputop has lots of metrics, its impossible to figure out what are available metrics. Unfortunately "-help" is not providing this info.

localhost ~ # gputop-wrapper -h
Usage: gputop-wrapper [options] <program> [program args...]

         -h, --help                        Display this help
         -H, --host <hostname>             Host to connect to
         -p, --port <port>                 Port on which the server is running
         -P, --period <period>             Accumulation period (in seconds, floating point)
         -m, --metric <name>               Metric set to use
                                     (prints out a list of metric sets if missing)
         -M, --max                         Outputs maximum counter values
                                     (first line after units)
         -c, --columns <col0,col1,..>      Columns to print out
                                     (prints out a lists of counters if missing)
         -n, --no-human-units              Disable human readable units (for machine readable output)
         -N, --no-headers                  Disable headers (for machine readable output)
         -O, --child-output <filename>     Outputs the child's standard output to filename
         -o, --output <filename>           Outputs gputop-wrapper's data to filename
                                     (disables human readable units)
         -w, --max-inactive-time <time>    Maximum time of inactivity before killing
                                     the child process (in seconds, floating point)

localhost ~ # gputop-wrapper -m
gputop-wrapper: option requires an argument -- 'm'
Unrecognized option: 63
localhost ~ # gputop-wrapper --m
gputop-wrapper: option '--m' is ambiguous; possibilities: '--metric' '--max-inactive-time' '--max'
Unrecognized option: 63
localhost ~ # gputop-wrapper --metric
gputop-wrapper: option '--metric' requires an argument
Unrecognized option: 63

Example mentioned above, -m suppose to prints out list of metrics sets if missing, but in this case its not.

Without help showing any information, this is quite cumbersome to figure out what are available options for different metrics.

djdeath commented 5 years ago

Maybe this isn't obvious but just run :

gputop-wrapper

It'll print out all the available metrics.

I'll add a -m list.

djdeath commented 5 years ago

And there is also a confusing mistake in the --help print out...

djdeath commented 5 years ago

Pushed 2 commit on master : https://github.com/rib/gputop/commit/5d5df6373107bd559d5bffe153ed3510b9fac67b https://github.com/rib/gputop/commit/c1bc2055db5ea20cddfc30d720cbf6f61896d66c

So you can now do :

gputop-wrapper -m list to list the metrics gputop-wrapper -m RenderBasic -c list to list the counters.