mirror of
https://github.com/apache/superset.git
synced 2026-04-10 11:55:24 +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>
100 lines
3.2 KiB
Python
100 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.
|
|
"""Models for scheduled execution of jobs"""
|
|
import enum
|
|
from typing import Optional, Type
|
|
|
|
from flask_appbuilder import Model
|
|
from sqlalchemy import Boolean, Column, Enum, ForeignKey, Integer, String, Text
|
|
from sqlalchemy.ext.declarative import declared_attr
|
|
from sqlalchemy.orm import relationship, RelationshipProperty
|
|
|
|
from superset import security_manager
|
|
from superset.models.alerts import Alert
|
|
from superset.models.helpers import AuditMixinNullable, ImportMixin
|
|
|
|
metadata = Model.metadata # pylint: disable=no-member
|
|
|
|
|
|
class ScheduleType(str, enum.Enum):
|
|
slice = "slice"
|
|
dashboard = "dashboard"
|
|
alert = "alert"
|
|
|
|
|
|
class EmailDeliveryType(str, enum.Enum):
|
|
attachment = "Attachment"
|
|
inline = "Inline"
|
|
|
|
|
|
class SliceEmailReportFormat(str, enum.Enum):
|
|
visualization = "Visualization"
|
|
data = "Raw data"
|
|
|
|
|
|
class EmailSchedule:
|
|
|
|
"""Schedules for emailing slices / dashboards"""
|
|
|
|
__tablename__ = "email_schedules"
|
|
|
|
id = Column(Integer, primary_key=True)
|
|
active = Column(Boolean, default=True, index=True)
|
|
crontab = Column(String(50))
|
|
|
|
@declared_attr
|
|
def user_id(self) -> int:
|
|
return Column(Integer, ForeignKey("ab_user.id"))
|
|
|
|
@declared_attr
|
|
def user(self) -> RelationshipProperty:
|
|
return relationship(
|
|
security_manager.user_model,
|
|
backref=self.__tablename__,
|
|
foreign_keys=[self.user_id],
|
|
)
|
|
|
|
recipients = Column(Text)
|
|
slack_channel = Column(Text)
|
|
deliver_as_group = Column(Boolean, default=False)
|
|
delivery_type = Column(Enum(EmailDeliveryType))
|
|
|
|
|
|
class DashboardEmailSchedule(Model, AuditMixinNullable, ImportMixin, EmailSchedule):
|
|
__tablename__ = "dashboard_email_schedules"
|
|
dashboard_id = Column(Integer, ForeignKey("dashboards.id"))
|
|
dashboard = relationship(
|
|
"Dashboard", backref="email_schedules", foreign_keys=[dashboard_id]
|
|
)
|
|
|
|
|
|
class SliceEmailSchedule(Model, AuditMixinNullable, ImportMixin, EmailSchedule):
|
|
__tablename__ = "slice_email_schedules"
|
|
slice_id = Column(Integer, ForeignKey("slices.id"))
|
|
slice = relationship("Slice", backref="email_schedules", foreign_keys=[slice_id])
|
|
email_format = Column(Enum(SliceEmailReportFormat))
|
|
|
|
|
|
def get_scheduler_model(report_type: str) -> Optional[Type[EmailSchedule]]:
|
|
if report_type == ScheduleType.dashboard:
|
|
return DashboardEmailSchedule
|
|
if report_type == ScheduleType.slice:
|
|
return SliceEmailSchedule
|
|
if report_type == ScheduleType.alert:
|
|
return Alert
|
|
return None
|