chore: additional logging in alerts and reports #21802
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 #21802 +/- ##
==========================================
+ Coverage 66.85% 66.92% +0.07%
==========================================
Files 1805 1805
Lines 69061 70583 +1522
Branches 7369 7369
==========================================
+ Hits 46169 47238 +1069
- Misses 20995 21448 +453
Partials 1897 1897
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
dpgaspar
reviewed
Oct 14, 2022
| @@ -207,6 +207,8 @@ def send(self) -> None: | |||
| dryrun=False, | |||
| header_data=content.header_data, | |||
| ) | |||
| logger.info("Report sent to email") | |||
| logger.info( | |||
| "Report sent to email, notification content is %s", content.header_data | |||
There was a problem hiding this comment.
checked HeaderDataType is safe to log.
There was a problem hiding this comment.
We log it in other places, so I think that it is.
superset/utils/core.py
Outdated
| @@ -1020,6 +1021,7 @@ def send_mime_email( | |||
| if smtp_user and smtp_password: | |||
| smtp.login(smtp_user, smtp_password) | |||
| logger.debug("Sent an email to %s", str(e_to)) | |||
| logger.info("Sent email notification content is %s", mime_msg.as_string()) | |||
There was a problem hiding this comment.
don't think we should log the mime_msg itself
There was a problem hiding this comment.
ok, I think this one we can actually delete. Ty
superset/tasks/scheduler.py
Outdated
| @@ -85,10 +85,12 @@ def execute(report_schedule_id: int, scheduled_dttm: str) -> None: | |||
| logger.exception( | |||
| "An unexpected occurred while executing the report: %s", task_id | |||
| ) | |||
| execute.update_state(state="FAILURE") | |||
There was a problem hiding this comment.
Can you add a test to assert this?
superset/tasks/scheduler.py
Outdated
| except CommandException: | ||
| logger.exception( | ||
| "A downstream exception occurred while generating" " a report: %s", task_id | ||
| ) | ||
| execute.update_state(state="FAILURE") |
There was a problem hiding this comment.
can you add a test to assert this?
AAfghahi
force-pushed
the
arash/logAlertReports
branch
2 times, most recently
from
1c0a622 to
9399632
Compare
AAfghahi
force-pushed
the
arash/logAlertReports
branch
from
9399632 to
eee545e
Compare
AAfghahi
force-pushed
the
arash/logAlertReports
branch
from
eee545e to
bdd1fdc
Compare
AAfghahi
force-pushed
the
arash/logAlertReports
branch
from
bdd1fdc to
31d4f8a
Compare
AAfghahi
force-pushed
the
arash/logAlertReports
branch
from
37ee741 to
f33c698
Compare
AAfghahi
force-pushed
the
arash/logAlertReports
branch
from
f33c698 to
5c1f57e
Compare
eschutho
approved these changes
Oct 24, 2022
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 adds more logging for alerts and reports, to better understand downstream exceptions.
Of particular note is that our logs show this messaging often:
So we wanted to mark that task as having failed.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION