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.

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

Add recovery-stats telemetry device #639

Merged

Conversation

danielmitterdorfer
Copy link
Member

With this commit we add a new telemetry device called recovery-stats
which can be used to retrieve statistics about ongoing recoveries while
running a benchmark.

Closes #635

With this commit we add a new telemetry device called `recovery-stats`
which can be used to retrieve statistics about ongoing recoveries while
running a benchmark.

Closes elastic#635
@danielmitterdorfer danielmitterdorfer added enhancement Improves the status quo :Telemetry Telemetry Devices that gather additional metrics labels Jan 30, 2019
@danielmitterdorfer danielmitterdorfer added this to the 1.0.4 milestone Jan 30, 2019
@danielmitterdorfer
Copy link
Member Author

I've tested the changes with the attached test-track. That track restores an index taxis from a snapshot.

Test scenarios (all with an ES metrics store):

  • esrally --pipeline=from-sources-skip-build --telemetry=recovery-stats --track-path=/path/to/test-track
  • esrally --pipeline=from-sources-skip-build --telemetry=recovery-stats --track-path=/path/to/test-track --telemetry-params="recovery-stats-indices:'ta*'"
  • esrally --pipeline=from-sources-skip-build --telemetry=recovery-stats --track-path=/path/to/test-track --telemetry-params="recovery-stats-indices:'bla*'"
  • esrally --pipeline=from-sources-skip-build --telemetry=recovery-stats --track-path=/path/to/test-track --telemetry-params="recovery-stats-indices:'ta*',recovery-stats-sample-interval:2"
  • esrally --pipeline=from-sources-skip-build --telemetry=recovery-stats --track-path=/path/to/test-track --telemetry-params="telemetry-params.json"

telemetry-params.json:

{
  "recovery-stats-indices": {
    "default": "taxi*"
  },
  "recovery-stats-sample-interval": 2
}

Copy link
Contributor

@dliappis dliappis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks! I left a small note for the docs.

jfr Flight Recorder Enables Java Flight Recorder (requires an Oracle JDK)
perf perf stat Reads CPU PMU counters (requires Linux and perf)
node-stats Node Stats Regularly samples node stats
Command Name Description
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This table seems to be indented by +1 character to the right hence not aligned with the title. Is it on purpose?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. IIRC I just pressed tab and assumed it did the right thing.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've addressed this in b61b64e

@@ -102,6 +102,8 @@ def all_options(self):


class TargetHosts(ConnectOptions):
DEFAULT = "default"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯 thanks for this.

@danielmitterdorfer
Copy link
Member Author

I've tested this also with the in-memory metrics store and although this telemetry device is not useful there (it only writes raw metrics entries which get lost if the metrics store is transient), it should at least not break it. This is addressed in db94883. @dliappis can you please have another look at those changes?

Copy link
Contributor

@dliappis dliappis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested it with both internal and external metric store. Works great, thanks!

LGTM

@danielmitterdorfer danielmitterdorfer merged commit 977c0de into elastic:master Feb 1, 2019
@danielmitterdorfer
Copy link
Member Author

Thanks! Merged.

@danielmitterdorfer danielmitterdorfer deleted the recovery-telemetry branch February 1, 2019 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improves the status quo :Telemetry Telemetry Devices that gather additional metrics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants