-
Notifications
You must be signed in to change notification settings - Fork 14.1k
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
docs: deprecate old alerts and dash/charts reports #13440
Merged
dpgaspar
merged 3 commits into
apache:master
from
preset-io:danielgaspar/ch6091/add-additional-deprecation-notices-to-the
Mar 5, 2021
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -424,6 +424,7 @@ def _try_json_readsha( # pylint: disable=unused-argument | |
|
||
# --------------------------------------------------- | ||
# Thumbnail config (behind feature flag) | ||
# Also used by Alerts & Reports | ||
# --------------------------------------------------- | ||
THUMBNAIL_SELENIUM_USER = "admin" | ||
THUMBNAIL_CACHE_CONFIG: CacheConfig = { | ||
|
@@ -614,18 +615,8 @@ class CeleryConfig: # pylint: disable=too-few-public-methods | |
CELERY_ACKS_LATE = False | ||
CELERY_ANNOTATIONS = { | ||
"sql_lab.get_sql_results": {"rate_limit": "100/s"}, | ||
"email_reports.send": { | ||
"rate_limit": "1/s", | ||
"time_limit": 120, | ||
"soft_time_limit": 150, | ||
"ignore_result": True, | ||
}, | ||
} | ||
CELERYBEAT_SCHEDULE = { | ||
"email_reports.schedule_hourly": { | ||
"task": "email_reports.schedule_hourly", | ||
"schedule": crontab(minute=1, hour="*"), | ||
}, | ||
"reports.scheduler": { | ||
"task": "reports.scheduler", | ||
"schedule": crontab(minute="*", hour="*"), | ||
|
@@ -891,24 +882,35 @@ class CeleryConfig: # pylint: disable=too-few-public-methods | |
SQL_QUERY_MUTATOR = None | ||
|
||
# Enable / disable scheduled email reports | ||
# | ||
# Warning: This config key is deprecated and will be removed in version 2.0.0" | ||
ENABLE_SCHEDULED_EMAIL_REPORTS = False | ||
|
||
# Enable / disable Alerts, where users can define custom SQL that | ||
# will send emails with screenshots of charts or dashboards periodically | ||
# if it meets the criteria | ||
# | ||
# Warning: This config key is deprecated and will be removed in version 2.0.0" | ||
ENABLE_ALERTS = False | ||
|
||
# --------------------------------------------------- | ||
# Alerts & Reports | ||
# --------------------------------------------------- | ||
# Used for Alerts/Reports (Feature flask ALERT_REPORTS) to set the size for the | ||
# sliding cron window size, should be synced with the celery beat config minus 1 second | ||
ALERT_REPORTS_CRON_WINDOW_SIZE = 59 | ||
# A custom prefix to use on all Alerts & Reports emails | ||
EMAIL_REPORTS_SUBJECT_PREFIX = "[Report] " | ||
|
||
# Slack API token for the superset reports | ||
SLACK_API_TOKEN = None | ||
SLACK_PROXY = None | ||
|
||
# If enabled, certail features are run in debug mode | ||
# If enabled, certain features are run in debug mode | ||
# Current list: | ||
# * Emails are sent using dry-run mode (logging only) | ||
# | ||
# Warning: This config key is deprecated and will be removed in version 2.0.0" | ||
SCHEDULED_EMAIL_DEBUG_MODE = False | ||
|
||
# This auth provider is used by background (offline) tasks that need to access | ||
|
@@ -917,26 +919,29 @@ class CeleryConfig: # pylint: disable=too-few-public-methods | |
MACHINE_AUTH_PROVIDER_CLASS = "superset.utils.machine_auth.MachineAuthProvider" | ||
|
||
# Email reports - minimum time resolution (in minutes) for the crontab | ||
# | ||
# Warning: This config key is deprecated and will be removed in version 2.0.0" | ||
EMAIL_REPORTS_CRON_RESOLUTION = 15 | ||
|
||
# The MAX duration (in seconds) a email schedule can run for before being killed | ||
# by celery. | ||
# | ||
# Warning: This config key is deprecated and will be removed in version 2.0.0" | ||
EMAIL_ASYNC_TIME_LIMIT_SEC = 300 | ||
|
||
# Email report configuration | ||
# From address in emails | ||
EMAIL_REPORT_FROM_ADDRESS = "reports@superset.org" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same comment with these config removals. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This one is used anywhere, safe to just remove |
||
|
||
# Send bcc of all reports to this address. Set to None to disable. | ||
# This is useful for maintaining an audit trail of all email deliveries. | ||
# | ||
# Warning: This config key is deprecated and will be removed in version 2.0.0" | ||
EMAIL_REPORT_BCC_ADDRESS = None | ||
|
||
# User credentials to use for generating reports | ||
# This user should have permissions to browse all the dashboards and | ||
# slices. | ||
# TODO: In the future, login as the owner of the item to generate reports | ||
# | ||
# Warning: This config key is deprecated and will be removed in version 2.0.0" | ||
EMAIL_REPORTS_USER = "admin" | ||
EMAIL_REPORTS_SUBJECT_PREFIX = "[Report] " | ||
|
||
# The webdriver to use for generating reports. Use one of the following | ||
# firefox | ||
|
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think these removals break SEMVER - we shouldn't change the defaults for the configuration between majors. Let's keep the schedules, but perhaps add a deprecation?