add `--user-tags` as alias for `--user-tag` #1599

pakio · 2022-10-22T16:04:52Z

This PR closes #1577, adding a track option --user-tags as an alias for --user-tag.

==== checklist ====

Have you signed the contributor license agreement? - yes
Have you followed the contributor guidelines? - yes
Have you run make check-all successfully? - yes
Did you choose a descriptive title and description for your PR? - yes
(Only for maintainers) Did you apply appropriate labels and a milestone? - skip

pakio · 2022-10-23T00:51:55Z

esrally/rally.py

        "--user-tag",
+        "--user-tags",


didn't change the order to keep backward compatibility, in order to be able to set tag by env var USER_TAG.

dliappis

Thank you for raising this!

I left some comments. One thing that is missing IMHO is that we should emit a "Deprecation warning" when --user-tag is use in the CLI. That way people who don't happen to check the migration guide or read docs will be reminded that they should be switching away.

dliappis · 2022-10-24T06:28:33Z

docs/command_line_reference.rst




-When you run ``esrally list races``, this will show up again::
+Wesrally list raceshen you run ``esrally list races``, this will show up again::


I think this was introduced by accident?

unintended, thank you for the catch 🙏

dliappis · 2022-10-24T06:29:04Z

docs/metrics.rst

@@ -108,7 +108,7 @@ Rally captures also some meta information for each metric record:
 * Node name: If Rally provisions the cluster, it will choose a unique name for each node.
 * Source revision: We always record the git hash of the version of Elasticsearch that is benchmarked. This is even done if you benchmark an official binary release.
 * Distribution version: We always record the distribution version of Elasticsearch that is benchmarked. This is even done if you benchmark a source release.
-* Custom tag: You can define one custom tag with the command line flag ``--user-tag``. The tag is prefixed by ``tag_`` in order to avoid accidental clashes with Rally internal tags.
+* Custom tags: You can define one custom tags with the command line flag ``--user-tags``. The tags are prefixed by ``tag_`` in order to avoid accidental clashes with Rally internal tags.


Suggested change

* Custom tags: You can define one custom tags with the command line flag ``--user-tags``. The tags are prefixed by ``tag_`` in order to avoid accidental clashes with Rally internal tags.

* Custom tags: You can define custom tags with the command line flag ``--user-tags``. The tags are prefixed by ``tag_`` in order to avoid accidental clashes with Rally internal tags.

dliappis · 2022-10-24T06:36:53Z

docs/migrate.rst

@@ -446,7 +446,7 @@ If you need lap functionality, the following shell script can be used instead::

    for lap in $(seq 1 ${RALLY_LAPS})
    do
-      esrally --pipeline=benchmark-only --user-tag lap:$lap
+      esrally --pipeline=benchmark-only --user-tags lap:$lap


It would be very nice if we could document at the top of this file that --user-tag is now deprecated in favor of --user-tags. The next version can be found in https://github.com/elastic/rally/blob/master/esrally/_version.py#L1 so it'll be effective from 2.6.1.

As mentioned in #1599 (comment) maybe it's just enough to mention that starting with 2.6.1 --user-tags has been introduced as a "synonym" to --user-tag.

oh, sorry I didn't notice this was a migration guide.
I think that might be better to be in the migration guide section for v2.6.1, so I simply reverts this change.

dliappis · 2022-10-24T10:28:04Z

Thank you for raising this!

I left some comments. One thing that is missing IMHO is that we should emit a "Deprecation warning" when --user-tag is use in the CLI. That way people who don't happen to check the migration guide or read docs will be reminded that they should be switching away.

I discussed with @pquentin and instead of doing what I proposed here, we could just keep the functionality for both i.e. no need for a depreciation warning and allow both for the foreseeable future. Given the large usage of Rally this would probably be the least disruptive change for users.

pakio · 2022-10-24T12:31:46Z

Thank you @dliappis for your discussion and review! Given the result, do you think the current way of migration, adding --user-tags as a secondary parameter looks good to you? I also considered to add as a separate argument so that we can support both USER_TAG and USER_TAGS as well, and which might be more easier to show deprecation message in the future.

dliappis · 2022-10-31T13:27:42Z

@elasticmachine test this please

dliappis

Sorry for the delay, this looks great thank you. I've triggered now CI tests, if they are green, I'll merge it in.

…-tag-alias

pquentin · 2022-11-02T10:32:40Z

@elasticmachine test this please

add --user-tags as alias for --user-tag

962450f

pakio force-pushed the ISSUE-1577_add-user-tag-alias branch 2 times, most recently from 447e7e0 to 277c303 Compare October 22, 2022 16:27

update docs

5887733

pakio force-pushed the ISSUE-1577_add-user-tag-alias branch from 277c303 to 5887733 Compare October 23, 2022 00:44

pakio commented Oct 23, 2022

View reviewed changes

dliappis requested changes Oct 24, 2022

View reviewed changes

dliappis requested a review from pquentin October 24, 2022 06:39

dliappis added :Config Config file format changes, new properties, ... tech debt labels Oct 24, 2022

update docs

94aba04

pakio requested review from dliappis and removed request for pquentin October 24, 2022 12:46

dliappis requested a review from pquentin October 31, 2022 13:27

dliappis approved these changes Oct 31, 2022

View reviewed changes

pquentin added 2 commits November 2, 2022 12:06

Clarify user-tag documentation

e6916e5

Merge remote-tracking branch 'origin/master' into ISSUE-1577_add-user…

052e2e5

…-tag-alias

pquentin merged commit 722ef67 into elastic:master Nov 2, 2022

pquentin added this to the 2.7.0 milestone Nov 2, 2022

pquentin added the enhancement Improves the status quo label Nov 2, 2022

pakio deleted the ISSUE-1577_add-user-tag-alias branch November 2, 2022 12:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add `--user-tags` as alias for `--user-tag` #1599

add `--user-tags` as alias for `--user-tag` #1599

pakio commented Oct 22, 2022

pakio Oct 23, 2022

dliappis left a comment

dliappis Oct 24, 2022

pakio Oct 24, 2022

dliappis Oct 24, 2022

dliappis Oct 24, 2022

dliappis Oct 24, 2022

pakio Oct 24, 2022

dliappis commented Oct 24, 2022

pakio commented Oct 24, 2022

dliappis commented Oct 31, 2022

dliappis left a comment

pquentin commented Nov 2, 2022




		When you run ``esrally list races``, this will show up again::
		Wesrally list raceshen you run ``esrally list races``, this will show up again::

	* Custom tags: You can define one custom tags with the command line flag ``--user-tags``. The tags are prefixed by ``tag_`` in order to avoid accidental clashes with Rally internal tags.
	* Custom tags: You can define custom tags with the command line flag ``--user-tags``. The tags are prefixed by ``tag_`` in order to avoid accidental clashes with Rally internal tags.

add --user-tags as alias for --user-tag #1599

add --user-tags as alias for --user-tag #1599

Conversation

pakio commented Oct 22, 2022

pakio Oct 23, 2022

Choose a reason for hiding this comment

dliappis left a comment

Choose a reason for hiding this comment

dliappis Oct 24, 2022

Choose a reason for hiding this comment

pakio Oct 24, 2022

Choose a reason for hiding this comment

dliappis Oct 24, 2022

Choose a reason for hiding this comment

dliappis Oct 24, 2022

Choose a reason for hiding this comment

dliappis Oct 24, 2022

Choose a reason for hiding this comment

pakio Oct 24, 2022

Choose a reason for hiding this comment

dliappis commented Oct 24, 2022

pakio commented Oct 24, 2022

dliappis commented Oct 31, 2022

dliappis left a comment

Choose a reason for hiding this comment

pquentin commented Nov 2, 2022

add `--user-tags` as alias for `--user-tag` #1599

add `--user-tags` as alias for `--user-tag` #1599