Add metrics for successful/failed Spark index creation #837
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
Signed-off-by: Simeon Widdis <[email protected]>
Signed-off-by: Simeon Widdis <[email protected]>
Swiddis
requested review from
dai-chen,
rupal-bq,
mengweieric,
vamsimanohar,
penghuo,
seankao-az,
anirudha,
kaituo,
YANG-DB,
noCharger,
LantaoJin and
ykmr1224
as code owners
Signed-off-by: Simeon Widdis <[email protected]>
dai-chen
reviewed
Nov 6, 2024
Comment on lines
50
to
55
| val result = doCreate(spark, metadata) | ||
| emitIndexCreationStatusMetric(metadata, success = true) | ||
| Some(result) | ||
| } catch { | ||
| case e: Exception => | ||
| emitIndexCreationStatusMetric(metadata, success = false) |
There was a problem hiding this comment.
Could you double check if this is the right place? I recall this factory is actually deserializer from Flint metadata to index class. I guess you may want to intercept API call in FlintSpark? Also for all metrics related logic, please consider AOP style rather than insert this logic in many places.
There was a problem hiding this comment.
There was a problem hiding this comment.
Moved the metric collection to the new location. I experimented with trying something AOP-like but it was cumbersome -- linking the existing logic in spark/refresh introduces a circular dependency, and the callable implicitly raising Exception makes error handling awkward if trying to make a general-purpose duplicate of what exists on the Scala side.
Signed-off-by: Simeon Widdis <[email protected]>
Signed-off-by: Simeon Widdis <[email protected]>
Swiddis
force-pushed
the
feature/index-metrics
branch
from
f8f1624 to
7df59b8
Compare
Signed-off-by: Simeon Widdis <[email protected]>
Signed-off-by: Simeon Widdis <[email protected]>
ykmr1224
reviewed
Nov 13, 2024
flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchClient.java
Outdated
Show resolved
Hide resolved
flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchClient.java
Show resolved
Hide resolved
flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchClient.java
Show resolved
Hide resolved
flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchClient.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Simeon Widdis <[email protected]>
Signed-off-by: Simeon Widdis <[email protected]>
Signed-off-by: Simeon Widdis <[email protected]>
ykmr1224
reviewed
Nov 14, 2024
flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchClient.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Simeon Widdis <[email protected]>
ykmr1224
approved these changes
Nov 14, 2024
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Nov 15, 2024
* Add index creation metrics Signed-off-by: Simeon Widdis <[email protected]> * Update emit metric function location Signed-off-by: Simeon Widdis <[email protected]> * Apply scalafmt Signed-off-by: Simeon Widdis <[email protected]> * revert FlintSparkIndexFactory metrics emission Signed-off-by: Simeon Widdis <[email protected]> * Update OS client to emit metrics Signed-off-by: Simeon Widdis <[email protected]> * Fix index kind detection Signed-off-by: Simeon Widdis <[email protected]> * Remove cumbersome with() method Signed-off-by: Simeon Widdis <[email protected]> * Revert the void change Signed-off-by: Simeon Widdis <[email protected]> * Make the code branchless Signed-off-by: Simeon Widdis <[email protected]> * Add default case to switches Signed-off-by: Simeon Widdis <[email protected]> * Apply PR feedback Signed-off-by: Simeon Widdis <[email protected]> --------- Signed-off-by: Simeon Widdis <[email protected]> (cherry picked from commit 6f37b2d) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
ykmr1224
pushed a commit
that referenced
this pull request
Nov 15, 2024
* Add index creation metrics * Update emit metric function location * Apply scalafmt * revert FlintSparkIndexFactory metrics emission * Update OS client to emit metrics * Fix index kind detection * Remove cumbersome with() method * Revert the void change * Make the code branchless * Add default case to switches * Apply PR feedback --------- (cherry picked from commit 6f37b2d) Signed-off-by: Simeon Widdis <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kenrickyap
pushed a commit
to Bit-Quill/opensearch-spark
that referenced
this pull request
Dec 11, 2024
…oject#837) * Add index creation metrics Signed-off-by: Simeon Widdis <[email protected]> * Update emit metric function location Signed-off-by: Simeon Widdis <[email protected]> * Apply scalafmt Signed-off-by: Simeon Widdis <[email protected]> * revert FlintSparkIndexFactory metrics emission Signed-off-by: Simeon Widdis <[email protected]> * Update OS client to emit metrics Signed-off-by: Simeon Widdis <[email protected]> * Fix index kind detection Signed-off-by: Simeon Widdis <[email protected]> * Remove cumbersome with() method Signed-off-by: Simeon Widdis <[email protected]> * Revert the void change Signed-off-by: Simeon Widdis <[email protected]> * Make the code branchless Signed-off-by: Simeon Widdis <[email protected]> * Add default case to switches Signed-off-by: Simeon Widdis <[email protected]> * Apply PR feedback Signed-off-by: Simeon Widdis <[email protected]> --------- Signed-off-by: Simeon Widdis <[email protected]>
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.
Description
Success and failure metrics for spark index creation -- note that "failure" here means an execution failure (e.g. Spark couldn't execute the query), not validation failure (e.g. the index already exists).
E.g. success for creating a skipping index:
Related Issues
N/A
Check List
--signoffBy 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.