Update telemetry device docs #1247
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Telemetry device docs are a little out of date wrt which ones to attach when setting up the cluster vs at runtime. Given that the new cluster management commands are experimental we take the opportunity to briefly clarify which category of telemetry devices needs to be specified via the start subcommand. In a future PR we could enhance telemetry devices to have an additional (internal) property, that is presented via the `list` subcommand, to explicitly classify their usage level i.e. setup vs runtime.
dliappis
added
enhancement
danielmitterdorfer
approved these changes
Apr 21, 2021
docs/telemetry.rst
Outdated
|
|
||
| .. note:: | ||
|
|
||
| If you are using the experimental `cluster management commands <cluster_management>`_, setup level telemetry devices (and their parameters) should only be specified via the ``start`` subcommand and not via the `race`` subcommand. For more details check ``esrally start --help``. |
There was a problem hiding this comment.
Nit: You need to enclose the race subcommand in two backticks but there is only one at the beginning.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Telemetry device docs are a little out of date wrt which ones to attach
when setting up the cluster vs at runtime.
Given that the new cluster management commands are experimental we take
the opportunity to briefly clarify which category of telemetry devices
needs to be specified via the start subcommand.
In a future PR we could enhance telemetry devices to have an additional
(internal) property, that is presented via the
listsubcommand, toexplicitly classify their usage level i.e. setup vs runtime.