-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
created helper class for incorporation of sentry in monitor alerts
- Loading branch information
Showing
4 changed files
with
76 additions
and
5 deletions.
There are no files selected for viewing
Empty file.
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 |
---|---|---|
@@ -0,0 +1,54 @@ | ||
import logging | ||
|
||
from typing import List | ||
|
||
from spidermon.contrib.actions.sentry import SendSentryMessage | ||
|
||
from shub_workflow.script import BaseScriptProtocol | ||
from shub_workflow.utils import resolve_shub_jobkey | ||
from shub_workflow.utils.monitor import BaseMonitorProtocol | ||
|
||
|
||
LOG = logging.getLogger(__name__) | ||
|
||
|
||
class SentryMixin(BaseScriptProtocol): | ||
""" | ||
A class for adding sentry alert capabilities to a shub_workflow class. | ||
""" | ||
|
||
def __init__(self): | ||
self.sentry_handler = SendSentryMessage( | ||
fake=self.project_settings.get("SPIDERMON_SENTRY_FAKE"), | ||
sentry_dsn=self.project_settings.get("SPIDERMON_SENTRY_DSN"), | ||
sentry_log_level=self.project_settings.get("SPIDERMON_SENTRY_LOG_LEVEL"), | ||
project_name=self.project_settings.get("SPIDERMON_SENTRY_PROJECT_NAME"), | ||
environment=self.project_settings.get("SPIDERMON_SENTRY_ENVIRONMENT_TYPE"), | ||
) | ||
self.messages: List[str] = [] | ||
|
||
def send_sentry_message(self): | ||
if self.messages: | ||
message = dict() | ||
title = f"{self.sentry_handler.project_name} | {self.sentry_handler.environment} | Monitor notification" | ||
message["title"] = title | ||
message["failure_reasons"] = "/n".join(self.messages) | ||
job_key = resolve_shub_jobkey() | ||
if job_key: | ||
message["job_link"] = f"https://app.zyte.com/p/{job_key}" | ||
if self.sentry_handler.fake: | ||
LOG.info(message) | ||
else: | ||
self.sentry_handler.send_message(message) | ||
|
||
def append_message(self, message: str): | ||
self.messages.append(message) | ||
|
||
|
||
class MonitorSentryMixin(SentryMixin, BaseMonitorProtocol): | ||
""" | ||
Mixin for adding sentry capabilities to shub_workflow monitors. | ||
""" | ||
def close(self): | ||
super().close() # type: ignore | ||
self.send_sentry_message() |
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