[LU-11837] iokit-lstats example should be modified

• Type: Improvement
• Resolution: Unresolved
• Priority: Minor
• Affects Version/s: Lustre 2.12.0, Lustre 2.13.0
• Assignee: WC Triage
• Reporter: James Nunez (Inactive)

Description

Looking at the iokit-lstats script, we see the example

very short example:
#
# to start collection:
#   VMSTAT_INTERVAL=0 SERVICE_INTERVAL=2 SDIO_INTERVAL=0 iokit-lstats start
#

Yet, if you run this command on a client, you’ll get errors

# VMSTAT_INTERVAL=0 SERVICE_INTERVAL=2 SDIO_INTERVAL=0 iokit-lstats start
error: list_param: param_path 'ost/*': No such file or directory
error: list_param: listing 'ost/*': No such file or directory
error: list_param: param_path 'mdt/*': No such file or directory
error: list_param: listing 'mdt/*': No such file or directory
error: list_param: param_path 'obdfilter/*': No such file or directory
error: list_param: listing 'obdfilter/*': No such file or directory
error: list_param: param_path 'mds/*': No such file or directory
error: list_param: listing 'mds/*': No such file or directory

A process is started, but the errors might concern the user.

The example doesn’t even run without complaining on a server. On an MDS, we see

# VMSTAT_INTERVAL=0 SERVICE_INTERVAL=2 SDIO_INTERVAL=0 iokit-lstats start
error: list_param: param_path 'ost/*': No such file or directory
error: list_param: listing 'ost/*': No such file or directory
error: list_param: param_path 'obdfilter/*': No such file or directory
error: list_param: listing 'obdfilter/*': No such file or directory

It seems like the example needs to be modified and/or some clarification should be added on where the command should be run.

Also, it would be nice to add a help flag to this script if we allow users to run it

# VMSTAT_INTERVAL=0 SERVICE_INTERVAL=2 SDIO_INTERVAL=0 iokit-lstats --help
Unknown command
# VMSTAT_INTERVAL=0 SERVICE_INTERVAL=2 SDIO_INTERVAL=0 iokit-lstats -help
Unknown command

Issue Links

• is related to: LU-11732 stats collection script