Skip to content

models

Ping

Bases: Model

Ping model to store service ping data.

Source code in src\downtime_panda\blueprints\service\models.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
class Ping(db.Model):
    """Ping model to store service ping data."""

    __tablename__ = "ping"
    # ---------------------------------- COLUMNS --------------------------------- #
    id: Mapped[int] = mapped_column(
        BigInteger().with_variant(Integer, "sqlite"), primary_key=True
    )
    service_id: Mapped[int] = mapped_column(
        ForeignKey(Service.id, onupdate="CASCADE", ondelete="RESTRICT"), nullable=False
    )
    http_response: Mapped[int] = mapped_column(Integer(), nullable=False)
    response_time: Mapped[timedelta] = mapped_column(Interval(), nullable=False)
    pinged_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)

    # ----------------------------- STANDARD METHODS ----------------------------- #
    def __init__(
        self,
        service_id: int,
        http_status: int,
        response_time: timedelta,
        pinged_at: datetime,
    ):
        self.service_id = service_id
        self.http_response = http_status
        self.response_time = response_time
        self.pinged_at = pinged_at

    def __repr__(self) -> str:
        return f"<Ping {self.id} for Service {self.service_id}>"

    # ---------------------------------- METHODS --------------------------------- #
    def to_dict(self) -> dict[str, Any]:
        return {
            "http_response": self.http_response,
            "response_time": self.response_time.total_seconds(),
            "pinged_at": self.pinged_at.isoformat(),
        }

Service

Bases: Model

Service model to store service information and related pings.

Source code in src\downtime_panda\blueprints\service\models.py 
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
class Service(db.Model):
    """Service model to store service information and related pings."""

    __tablename__ = "service"
    # ---------------------------------- COLUMNS --------------------------------- #
    id: Mapped[int] = mapped_column(
        BigInteger().with_variant(Integer, "sqlite"), primary_key=True
    )
    uri: Mapped[str] = mapped_column(String(255), nullable=False, unique=True)

    # ------------------------------- RELATIONSHIPS ------------------------------ #
    ping: WriteOnlyMapped["Ping"] = relationship(order_by="Ping.pinged_at.desc()")

    # ----------------------------- STANDARD METHODS ----------------------------- #
    def __init__(self, uri: str):
        self.uri = uri

    def __repr__(self) -> str:
        return f"<Service {self.id}>"

    # -------------------------------- CONSTRUCTOR ------------------------------- #
    @classmethod
    def create_if_not_exists(cls, uri: str) -> Self:
        """Create a new service if it does not already exist."""
        if cls.uri_exists(uri):
            return cls.get_by_uri(uri)

        service = Service(
            uri=uri,
        )
        db.session.add(service)
        db.session.commit()
        db.session.refresh(service)

        # Schedule the ping job for the new service
        trigger = IntervalTrigger(seconds=5)
        scheduler.add_job(
            func=service.ping_service,
            args=[service.id],
            trigger=trigger,
            replace_existing=True,
            id=f"ping_service_{service.id}",
        )

        db.session.commit()
        return service

    @classmethod
    def get_by_uri(cls, uri: str) -> Self | None:
        """Get a service by its URI, or None if it does not exist."""
        return db.session.execute(select(cls).filter_by(uri=uri)).scalar_one_or_none()

    @classmethod
    def uri_exists(cls, uri: str) -> bool:
        """Checks if a service with the specified URI exists."""
        return cls.get_by_uri(uri=uri) is not None

    @classmethod
    def ping_service(cls, service_id: int) -> None:
        with scheduler.app.app_context():
            service = db.session.get(cls, service_id)
            logger.info(service)

            pinged_at = datetime.now(pytz.utc)
            try:
                response = requests.head(service.uri, allow_redirects=True)

                status_code = response.status_code
                response_time = response.elapsed
            except requests.exceptions.ConnectionError:
                response_time = timedelta(seconds=-1)
                status_code = NOT_FOUND

            ping = Ping(
                service_id=f"ping_service_{service.id}",
                http_status=status_code,
                response_time=response_time,
                pinged_at=pinged_at,
            )
            service.ping.add(ping)
            db.session.commit()

    def get_latest_ping(self) -> "Ping | None":
        """Get the latest ping for the service."""
        return db.session.execute(
            select(Ping).filter_by(service_id=self.id).order_by(Ping.pinged_at.desc())
        ).scalar()

    def get_latest_n_pings(self, n: int) -> Sequence["Ping"]:
        query = (
            select(Ping)
            .filter_by(service_id=self.id)
            .order_by(Ping.pinged_at.desc())
            .limit(n)
        )
        return db.session.execute(query).scalars().all()

    def get_pings_since(self, since: datetime) -> Sequence["Ping"]:
        query = (
            select(Ping)
            .filter_by(service_id=self.id)
            .where(Ping.pinged_at >= since)
            .order_by(Ping.pinged_at.desc())
        )
        return db.session.execute(query).scalars().all()

create_if_not_exists(uri) classmethod

Create a new service if it does not already exist.

Source code in src\downtime_panda\blueprints\service\models.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@classmethod
def create_if_not_exists(cls, uri: str) -> Self:
    """Create a new service if it does not already exist."""
    if cls.uri_exists(uri):
        return cls.get_by_uri(uri)

    service = Service(
        uri=uri,
    )
    db.session.add(service)
    db.session.commit()
    db.session.refresh(service)

    # Schedule the ping job for the new service
    trigger = IntervalTrigger(seconds=5)
    scheduler.add_job(
        func=service.ping_service,
        args=[service.id],
        trigger=trigger,
        replace_existing=True,
        id=f"ping_service_{service.id}",
    )

    db.session.commit()
    return service

get_by_uri(uri) classmethod

Get a service by its URI, or None if it does not exist.

Source code in src\downtime_panda\blueprints\service\models.py 
70
71
72
73
@classmethod
def get_by_uri(cls, uri: str) -> Self | None:
    """Get a service by its URI, or None if it does not exist."""
    return db.session.execute(select(cls).filter_by(uri=uri)).scalar_one_or_none()

get_latest_ping()

Get the latest ping for the service.

Source code in src\downtime_panda\blueprints\service\models.py 
105
106
107
108
109
def get_latest_ping(self) -> "Ping | None":
    """Get the latest ping for the service."""
    return db.session.execute(
        select(Ping).filter_by(service_id=self.id).order_by(Ping.pinged_at.desc())
    ).scalar()

uri_exists(uri) classmethod

Checks if a service with the specified URI exists.

Source code in src\downtime_panda\blueprints\service\models.py 
75
76
77
78
@classmethod
def uri_exists(cls, uri: str) -> bool:
    """Checks if a service with the specified URI exists."""
    return cls.get_by_uri(uri=uri) is not None