feat(sqllab): log error_detail on fetch failed #23377
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
Codecov Report
@@ Coverage Diff @@
## master #23377 +/- ##
==========================================
+ Coverage 65.91% 65.97% +0.05%
==========================================
Files 1907 1907
Lines 73453 73596 +143
Branches 7976 7982 +6
==========================================
+ Hits 48420 48552 +132
- Misses 22983 22996 +13
+ Partials 2050 2048 -2
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 6 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| @@ -32,6 +32,8 @@ import { | |||
| } from 'src/components/MessageToasts/actions'; | |||
| import { getClientErrorObject } from 'src/utils/getClientErrorObject'; | |||
| import COMMON_ERR_MESSAGES from 'src/utils/errorMessages'; | |||
| import { LOG_ACTIONS_SQLLAB_FETCH_QUERY } from 'src/logger/LogUtils'; | |||
There was a problem hiding this comment.
Could we make the event type more explicit like LOG_ACTIONS_SQLLAB_FAILED_QUERY? This would help when interpreting the event and also remove the need for the has_err attribute.
There was a problem hiding this comment.
I followed this way as LOG_ACTIONS_RENDER_CHART implemented using has_err attribute but I agree with your idea to have a dedicated logging type name.
Let me update accordingly
Comment on lines
277
to
297
| errors?.forEach(({ error_type: errorType, extra }) => { | ||
| if (extra?.issue_codes) { | ||
| extra?.issue_codes.forEach(({ message }) => { | ||
| dispatch( | ||
| logEvent(LOG_ACTIONS_SQLLAB_FETCH_QUERY, { | ||
| ...eventData, | ||
| error_type: errorType, | ||
| error_details: message, | ||
| }), | ||
| ); | ||
| }); | ||
| } else { | ||
| dispatch( | ||
| logEvent(LOG_ACTIONS_SQLLAB_FETCH_QUERY, { | ||
| ...eventData, | ||
| error_type: errorType, | ||
| error_details: errorType, | ||
| }), | ||
| ); | ||
| } | ||
| }); |
There was a problem hiding this comment.
Suggested change
| errors?.forEach(({ error_type: errorType, extra }) => { | |
| if (extra?.issue_codes) { | |
| extra?.issue_codes.forEach(({ message }) => { | |
| dispatch( | |
| logEvent(LOG_ACTIONS_SQLLAB_FETCH_QUERY, { | |
| ...eventData, | |
| error_type: errorType, | |
| error_details: message, | |
| }), | |
| ); | |
| }); | |
| } else { | |
| dispatch( | |
| logEvent(LOG_ACTIONS_SQLLAB_FETCH_QUERY, { | |
| ...eventData, | |
| error_type: errorType, | |
| error_details: errorType, | |
| }), | |
| ); | |
| } | |
| }); | |
| errors?.forEach(({ error_type: errorType, extra }) => { | |
| const messages = extra?.issue_codes.map(code => code.message) || [errorType]; | |
| messages.forEach(message => { | |
| dispatch( | |
| logEvent(LOG_ACTIONS_SQLLAB_FETCH_QUERY, { | |
| ...eventData, | |
| error_type: errorType, | |
| error_details: message, | |
| }), | |
| ); | |
| }); | |
| }); |
|
@michael-s-molina I updated as you commented. Please take a look for updates |
justinpark
added a commit
to airbnb/superset-fork
that referenced
this pull request
Mar 23, 2023
justinpark
added a commit
to airbnb/superset-fork
that referenced
this pull request
Mar 31, 2023
This reverts commit 531ab0d.
mistercrunch
added
🏷️ bot
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.
SUMMARY
This commit adds a logging event for fetch failed in sqllab in order to measure the impact of troubleshooting.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
After:
Before:
N/A
TESTING INSTRUCTIONS
Run any error query like
SELECT unknowncolumnin sqllaband then check the network tab for the logging event data
ADDITIONAL INFORMATION