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 improved error messaging in Worker class #741

Merged
merged 1 commit into from
Feb 10, 2025

Conversation

OVI3D0
Copy link
Member

@OVI3D0 OVI3D0 commented Feb 7, 2025

Description

Adds more detailed error messaging to the console if a request fails or if a workload is improperly configured.

Example:

[ERROR] Cannot execute-test. Benchmark operation failed:
Worker ID: 0
Task: index-statrs
Workload: geonames
Test Procedure: append-no-conflicts
Cause: Unknown
Error: No runner available for operation type [index-statrs]

Issues Resolved

#715

Testing

  • New functionality includes testing
    make test

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@OVI3D0 OVI3D0 marked this pull request as ready for review February 10, 2025 18:59
Copy link
Collaborator

@IanHoang IanHoang left a comment

Choose a reason for hiding this comment

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

This is clearer but one other step we should consider keeping track of a running list of "causes" that Worker Coordinator commonly encounters. I'm not sure how descriptive these causes are in the exception e but if we find a correlation between a cause and something like the way the OSB cli was set up, we should suggest a potential fix for the user.

@OVI3D0
Copy link
Member Author

OVI3D0 commented Feb 10, 2025

This is clearer but one other step we should consider keeping track of a running list of "causes" that Worker Coordinator commonly encounters. I'm not sure how descriptive these causes are in the exception e but if we find a correlation between a cause and something like the way the OSB cli was set up, we should suggest a potential fix for the user.

This makes sense and could give the user a better sense of where they can make a fix to stop the error and run a benchmark. Even in the example, No runner available for operation type ... is a bit ambiguous and a newer user might not know they misspelled the name of an operation.

@OVI3D0 OVI3D0 merged commit 7951e1d into opensearch-project:main Feb 10, 2025
10 checks passed
@OVI3D0 OVI3D0 deleted the improved-errors branch February 10, 2025 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants