mirror of
https://github.com/apache/superset.git
synced 2026-04-26 19:44:58 +00:00
318e5347bc
* feat: add support for alerts
* Add ModelViews
* First pass at adding scheduled Alert support
* Fix syntax errors
* Add log_retention and database to model
* Improving screenshots
* Still refactoring screenshots
* Pass down thumb_size properly
* Progress on screenshot endpoint
* Add alerts.last_eval_dttm and alert query logic
* Getting ready to split compute_screenshot and screenshot/{SHA}
* split the endpoints
* Improving alerting loop
* empty methods
* Add CLI command 'superset alert' that runs a sched loop
* Getting things to work
* email delivery
* A working email\!
* Add feature flag
* Add some description_columns to AlertModelView
* Little tweaks
* Use database.get_df, eval cells for truthiness
* Migrate thumbnail/screenshot functions to use new arg pattern
* Addressing PR feedback
* Update alerts DB migration down_revision
* Resolve _deliver_email arg conflict
* Make mypy happy
* Make isort happy
* Make pylint happy
Co-authored-by: Rob DiCiuccio <rob.diciuccio@gmail.com>
98 lines
3.2 KiB
Python
98 lines
3.2 KiB
Python
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
from flask_appbuilder import CompactCRUDMixin
|
|
from flask_appbuilder.models.sqla.interface import SQLAInterface
|
|
from flask_babel import lazy_gettext as _
|
|
|
|
from superset.constants import RouteMethod
|
|
from superset.models.alerts import Alert, AlertLog
|
|
from superset.utils.core import markdown
|
|
|
|
from .base import SupersetModelView
|
|
|
|
# TODO: access control rules for this module
|
|
|
|
|
|
class AlertLogModelView(
|
|
CompactCRUDMixin, SupersetModelView
|
|
): # pylint: disable=too-many-ancestors
|
|
datamodel = SQLAInterface(AlertLog)
|
|
include_route_methods = {RouteMethod.LIST} | {"show"}
|
|
list_columns = (
|
|
"scheduled_dttm",
|
|
"dttm_start",
|
|
"duration",
|
|
"state",
|
|
)
|
|
|
|
|
|
class AlertModelView(SupersetModelView): # pylint: disable=too-many-ancestors
|
|
datamodel = SQLAInterface(Alert)
|
|
route_base = "/alert"
|
|
include_route_methods = RouteMethod.CRUD_SET
|
|
|
|
list_columns = (
|
|
"label",
|
|
"database",
|
|
"crontab",
|
|
"last_eval_dttm",
|
|
"last_state",
|
|
"active",
|
|
)
|
|
add_columns = (
|
|
"label",
|
|
"active",
|
|
"crontab",
|
|
"database",
|
|
"sql",
|
|
"alert_type",
|
|
"owners",
|
|
"recipients",
|
|
"slice",
|
|
"dashboard",
|
|
"log_retention",
|
|
"grace_period",
|
|
)
|
|
label_columns = {
|
|
"sql": "SQL",
|
|
"log_retention": _("Log Retentions (days)"),
|
|
}
|
|
description_columns = {
|
|
"sql": _(
|
|
"A SQL statement that defines whether the alert should get "
|
|
"triggered or not. If the statement return no row, the alert "
|
|
"is not triggered. If the statement returns one or many rows, "
|
|
"the cells will be evaluated to see if they are 'truthy' "
|
|
"if any cell is truthy, the alert will fire. Truthy values "
|
|
"are non zero, non null, non empty strings."
|
|
),
|
|
"crontab": markdown(
|
|
"A CRON-like expression. "
|
|
"[Crontab Guru](https://crontab.guru/) is "
|
|
"a helpful resource that can help you craft a CRON expression.",
|
|
True,
|
|
),
|
|
"recipients": _("A semicolon ';' delimited list of email addresses"),
|
|
"log_retention": _("How long to keep the logs around for this alert"),
|
|
"grace_period": _(
|
|
"Once an alert is triggered, how long, in seconds, before "
|
|
"Superset nags you again."
|
|
),
|
|
}
|
|
edit_columns = add_columns
|
|
related_views = [AlertLogModelView]
|