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

[BUG] Clarify what tool-specific options are #3443

Closed
1 task done
ndokos opened this issue May 31, 2023 · 1 comment · Fixed by #3462
Closed
1 task done

[BUG] Clarify what tool-specific options are #3443

ndokos opened this issue May 31, 2023 · 1 comment · Fixed by #3462
Assignees
@ndokos
Labels
Agent bug Documentation tools Of and related to the operation and behavior of various tools (iostat, sar, etc.)
Milestone
v0.72

Comments

@ndokos
Copy link
Member

ndokos commented May 31, 2023

Is there an existing issue for this?

  • I have searched the existing issues

Description

pbench-register-tools' help message says:

pbench-register-tool --name=<tool-name>  ... -- [all tool specific options here]

and to get the tool-specific options, it says:

...
For a list of tool specific options, run:
	/opt/pbench-agent/tool-scripts/<tool-name> --help

The trouble is that the tool help message includes not only tool-specific options, but also generic options (like --dir) which are used internally by pbench and should NOT be specified when registering the tool.

We should clarify what are the tool-specific options and warn in pbench-register-tool to only use those on the RHS of --.

PBENCH-1173

To Reproduce

On a system, with pbench-agent installed, do:

  • pbench-regiter-tool --help
  • /opt/pbench-agent/tool-scripts/vmstat --help

Actual Results

As described.

Expected Results

Point out the differences between options that should and should not be specified when registering a tool.

Additional information

No response
@ndokos ndokos added bug Agent Documentation tools Of and related to the operation and behavior of various tools (iostat, sar, etc.) labels May 31, 2023
@ndokos ndokos added this to the v0.72 milestone May 31, 2023
@ndokos ndokos self-assigned this May 31, 2023
ndokos added a commit to ndokos/pbench that referenced this issue May 31, 2023
@ndokos
Clarify what tool-specific options are
637dd25 
Fixes distributed-system-analysis#3443

Modify the help message of pbench-register-tool to
warn against using generic options for a tool when
it is registered.

Modify the help message of base-tool (and everybody
who is symlinked to it) to clarify which are generic
options and which are tool-specific options.

PBENCH-1173
@ndokos ndokos mentioned this issue May 31, 2023
Merged
ndokos added a commit to ndokos/pbench that referenced this issue May 31, 2023
@ndokos
Clarify what tool-specific options are
e45bafd 
Fixes distributed-system-analysis#3443

Modify the help message of pbench-register-tool to
warn against using generic options for a tool when
it is registered.

Modify the help message of base-tool (and everybody
who is symlinked to it) to clarify which are generic
options and which are tool-specific options.

PBENCH-1173
ndokos added a commit to ndokos/pbench that referenced this issue May 31, 2023
@ndokos
Clarify what tool-specific options are
380b08e 
Fixes distributed-system-analysis#3443

Modify the help message of pbench-register-tool to
warn against using generic options for a tool when
it is registered.

Modify the help message of base-tool (and everybody
who is symlinked to it) to clarify which are generic
options and which are tool-specific options.

PBENCH-1173
ndokos added a commit to ndokos/pbench that referenced this issue Jun 1, 2023
@ndokos
Clarify what tool-specific options are
b8079de 
Fixes distributed-system-analysis#3443

Modify the help message of pbench-register-tool to
warn against using generic options for a tool when
it is registered.

Modify the help message of base-tool (and everybody
who is symlinked to it) to clarify which are generic
options and which are tool-specific options.

PBENCH-1173
ndokos added a commit to ndokos/pbench that referenced this issue Jun 2, 2023
@ndokos
Clarify what tool-specific options are
2110ad8 
Fixes distributed-system-analysis#3443

Modify the help message of pbench-register-tool to warn against using
operational options (i.e. options used internally by pbench) for a
tool when it is registered.

Modify the help message of base-tool (and everybody who is symlinked
to it) to clarify which are operational options and which are
tool-specific options: operational options should not be specified
when registering a tool: they are used by pbench internally; only
tool-specific options are specifed when registering the tool (on the
RHS of `--` in the invocation of `pbench-register-tool`).

PBENCH-1173
ndokos added a commit that referenced this issue Jun 2, 2023
@ndokos
Clarify what tool-specific options are (#3444)
c560bdf 
Fixes #3443

Modify the help message of pbench-register-tool to warn against using
operational options (i.e. options used internally by pbench) for a
tool when it is registered.

Modify the help message of base-tool (and everybody who is symlinked
to it) to clarify which are operational options and which are
tool-specific options: operational options should not be specified
when registering a tool: they are used by pbench internally; only
tool-specific options are specifed when registering the tool (on the
RHS of `--` in the invocation of `pbench-register-tool`).

PBENCH-1173
ndokos added a commit to ndokos/pbench that referenced this issue Jun 7, 2023
@ndokos
Clarify what tool-specific options are
af24d02 
Fixes distributed-system-analysis#3443

Modify the help message of pbench-register-tool to warn against using
operational options (i.e. options used internally by pbench) for a
tool when it is registered.

Modify the help message of base-tool (and everybody who is symlinked
to it) to clarify which are operational options and which are
tool-specific options: operational options should not be specified
when registering a tool: they are used by pbench internally; only
tool-specific options are specifed when registering the tool (on the
RHS of `--` in the invocation of `pbench-register-tool`).

PBENCH-1173
ndokos added a commit to ndokos/pbench that referenced this issue Jun 13, 2023
@ndokos
Clarify what tool-specific options are (distributed-system-analysis#3444
5074676 
)

Fixes distributed-system-analysis#3443

Modify the help message of pbench-register-tool to warn against using
operational options (i.e. options used internally by pbench) for a
tool when it is registered.

Modify the help message of base-tool (and everybody who is symlinked
to it) to clarify which are operational options and which are
tool-specific options: operational options should not be specified
when registering a tool: they are used by pbench internally; only
tool-specific options are specifed when registering the tool (on the
RHS of `--` in the invocation of `pbench-register-tool`).

PBENCH-1173
@ndokos ndokos mentioned this issue Jun 13, 2023
Merged
@ndokos
Copy link
Member Author

ndokos commented Jun 15, 2023

Fixed by #3444 in b0.72
Fixed by #3462 in main

ndokos added a commit to ndokos/pbench that referenced this issue Jul 3, 2023
@ndokos
Clarify what tool-specific options are (distributed-system-analysis#3444
bc37e67 
)

Fixes distributed-system-analysis#3443

Modify the help message of base-tool (and everybody who is symlinked
to it) to clarify the tool-specific options that may be specified when
registering a tool (on the RHS of `--` in the invocation of
`pbench-register-tool`).

PBENCH-1173
ndokos added a commit to ndokos/pbench that referenced this issue Jul 3, 2023
@ndokos
Clarify what tool-specific options are (distributed-system-analysis#3444
529b6dd 
)

Fixes distributed-system-analysis#3443

Modify the help message of base-tool (and everybody who is symlinked
to it) to clarify the tool-specific options that may be specified when
registering a tool (on the RHS of `--` in the invocation of
`pbench-register-tool`).

PBENCH-1173
ndokos added a commit that referenced this issue Jul 3, 2023
@ndokos
Clarify what tool-specific options are (#3444) (#3462)
d6b2ed9 
Fixes #3443

Modify the help message of base-tool (and everybody who is symlinked
to it) to clarify the tool-specific options that may be specified when
registering a tool (on the RHS of `--` in the invocation of
`pbench-register-tool`).

PBENCH-1173
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ndokos ndokos

Labels
Agent bug Documentation tools Of and related to the operation and behavior of various tools (iostat, sar, etc.)
Projects
None yet
Milestone
v0.72
Development

Successfully merging a pull request may close this issue.

Clarify what tool-specific options are (Forward port of #3444 from b0.72 to main) ndokos/pbench
1 participant
@ndokos