-
Notifications
You must be signed in to change notification settings - Fork 203
Add orchestrator jobs data to alerts #1997
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
Open
quickcoffee
wants to merge
6
commits into
elementary-data:master
Choose a base branch
from
quickcoffee:1944-add-orchestrator-job-data-alerts
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9ef15ab
correct column references
c7d89e2
correct message building pipeline
476fae6
Polish up orchestrator info formatting
8244b2a
Fix coderabbit issues
7f13126
Merge branch 'master' into 1944-add-orchestrator-job-data-alerts
arbiv f721a57
Merge branch 'master' into 1944-add-orchestrator-job-data-alerts
arbiv 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
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -15,6 +15,7 @@ | |
| Icon.BELL: "🔔", | ||
| Icon.GEM: "💎", | ||
| Icon.SPARKLES: "✨", | ||
| Icon.LINK: "🔗", | ||
| } | ||
|
|
||
| for icon in Icon: | ||
|
|
||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -4,11 +4,13 @@ | |
| from pydantic import BaseModel | ||
|
|
||
| from elementary.messages.block_builders import ( | ||
| BoldTextBlock, | ||
| BoldTextLineBlock, | ||
| BulletListBlock, | ||
| FactsBlock, | ||
| ItalicTextLineBlock, | ||
| JsonCodeBlock, | ||
| LinkInlineBlocks, | ||
| LinksLineBlock, | ||
| MentionLineBlock, | ||
| NonPrimaryFactBlock, | ||
|
|
@@ -42,6 +44,9 @@ | |
| from elementary.monitor.alerts.model_alert import ModelAlertModel | ||
| from elementary.monitor.alerts.source_freshness_alert import SourceFreshnessAlertModel | ||
| from elementary.monitor.alerts.test_alert import TestAlertModel | ||
| from elementary.monitor.data_monitoring.alerts.integrations.utils.orchestrator_link import ( | ||
| create_orchestrator_link, | ||
| ) | ||
| from elementary.monitor.data_monitoring.alerts.integrations.utils.report_link import ( | ||
| ReportLinkData, | ||
| ) | ||
|
|
@@ -105,6 +110,7 @@ def _get_run_alert_subtitle_block( | |
| suppression_interval: Optional[int] = None, | ||
| env: Optional[str] = None, | ||
| links: list[ReportLinkData] = [], | ||
| orchestrator_info: Optional[Dict[str, str]] = None, | ||
| ) -> LinesBlock: | ||
| summary = [] | ||
| summary.append((type.capitalize() + ":", name)) | ||
|
|
@@ -113,16 +119,62 @@ def _get_run_alert_subtitle_block( | |
| summary.append(("Status:", status or "Unknown")) | ||
| if detected_at_str: | ||
| summary.append(("Time:", detected_at_str)) | ||
|
|
||
| # Initialize subtitle lines with summary | ||
|
Contributor
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. please remove all of the inline comments you added, as it goes agains the conventions of the project (only complicated/unintuitive code should be commented) Relevant to the entire PR |
||
| subtitle_lines = [] | ||
|
|
||
| if orchestrator_info and orchestrator_info.get("job_name"): | ||
| orchestrator_name = orchestrator_info.get("orchestrator", "orchestrator") | ||
| job_info_text = f"{orchestrator_info['job_name']} (via {orchestrator_name})" | ||
|
|
||
| # Create job info with inline orchestrator link | ||
| orchestrator_link = create_orchestrator_link(orchestrator_info) | ||
| if orchestrator_link: | ||
| # Create inline blocks for job info + link | ||
| job_inlines: List[InlineBlock] = [ | ||
ofek1weiss marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| BoldTextBlock(text="Job:"), | ||
| TextBlock(text=job_info_text + " | "), | ||
| ] | ||
| job_inlines.extend( | ||
| LinkInlineBlocks( | ||
| text=orchestrator_link.text, | ||
| url=orchestrator_link.url, | ||
| icon=orchestrator_link.icon, | ||
| ) | ||
| ) | ||
|
|
||
| # Add custom line with job info + link instead of summary item | ||
| subtitle_lines.append(LineBlock(inlines=job_inlines)) | ||
| else: | ||
| summary.append(("Job:", job_info_text)) | ||
| if suppression_interval: | ||
| summary.append(("Suppression interval:", str(suppression_interval))) | ||
| subtitle_lines = [SummaryLineBlock(summary=summary)] | ||
|
|
||
| if links: | ||
| subtitle_lines.append( | ||
| LinksLineBlock( | ||
| links=[(link.text, link.url, link.icon) for link in links] | ||
| # Add the main summary line | ||
| subtitle_lines.append(SummaryLineBlock(summary=summary)) | ||
|
|
||
| # Combine regular links with orchestrator links | ||
| all_links = [] | ||
|
|
||
| # Add existing report links | ||
| for link in links: | ||
| all_links.append((link.text, link.url, link.icon)) | ||
|
|
||
| # Add orchestrator link if available (only if not already added inline) | ||
| if orchestrator_info and not orchestrator_info.get("job_name"): | ||
| orchestrator_link = create_orchestrator_link(orchestrator_info) | ||
| if orchestrator_link: | ||
| all_links.append( | ||
| ( | ||
| orchestrator_link.text, | ||
| orchestrator_link.url, | ||
| orchestrator_link.icon, | ||
| ) | ||
| ) | ||
| ) | ||
|
|
||
| if all_links: | ||
| subtitle_lines.append(LinksLineBlock(links=all_links)) | ||
|
|
||
| return LinesBlock(lines=subtitle_lines) | ||
|
|
||
| def _get_run_alert_subtitle_links( | ||
|
|
@@ -150,6 +202,7 @@ def _get_run_alert_subtitle_blocks( | |
| asset_type = "snapshot" if alert.materialization == "snapshot" else "model" | ||
| asset_name = alert.alias | ||
| links = self._get_run_alert_subtitle_links(alert) | ||
| orchestrator_info = alert.orchestrator_info | ||
| return [ | ||
| self._get_run_alert_subtitle_block( | ||
| type=asset_type, | ||
|
|
@@ -159,6 +212,7 @@ def _get_run_alert_subtitle_blocks( | |
| suppression_interval=alert.suppression_interval, | ||
| env=alert.env, | ||
| links=links, | ||
| orchestrator_info=orchestrator_info, | ||
| ) | ||
| ] | ||
|
|
||
|
|
||
This file contains hidden or 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 hidden or 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 hidden or 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
49 changes: 49 additions & 0 deletions
49
elementary/monitor/data_monitoring/alerts/integrations/utils/orchestrator_link.py
This file contains hidden or 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,49 @@ | ||
| from typing import Dict, Optional | ||
|
|
||
| from elementary.messages.blocks import Icon | ||
| from elementary.utils.pydantic_shim import BaseModel | ||
|
|
||
|
|
||
| class OrchestratorLinkData(BaseModel): | ||
| url: str | ||
| text: str | ||
| orchestrator: str | ||
| icon: Optional[Icon] = None | ||
|
|
||
|
|
||
| def create_orchestrator_link( | ||
| orchestrator_info: Dict[str, str] | ||
| ) -> Optional[OrchestratorLinkData]: | ||
| """Create an orchestrator link from orchestrator info if URL is available.""" | ||
| if not orchestrator_info or not orchestrator_info.get("run_url"): | ||
| return None | ||
|
|
||
| orchestrator = orchestrator_info.get("orchestrator", "orchestrator") | ||
|
|
||
| return OrchestratorLinkData( | ||
| url=orchestrator_info["run_url"], | ||
| text=f"View in {orchestrator}", | ||
| orchestrator=orchestrator, | ||
| icon=Icon.LINK, | ||
| ) | ||
|
|
||
|
|
||
| def create_job_link( | ||
| orchestrator_info: Dict[str, str] | ||
| ) -> Optional[OrchestratorLinkData]: | ||
| """Create a job-level orchestrator link if job URL is available.""" | ||
| if not orchestrator_info or not orchestrator_info.get("job_url"): | ||
| return None | ||
|
|
||
| orchestrator = orchestrator_info.get("orchestrator", "orchestrator") | ||
| job_name = orchestrator_info.get("job_name", "Job") | ||
|
|
||
| # Capitalize orchestrator name for display | ||
| display_name = orchestrator.replace("_", " ").title() | ||
|
|
||
| return OrchestratorLinkData( | ||
| url=orchestrator_info["job_url"], | ||
| text=f"{job_name} in {display_name}", | ||
| orchestrator=orchestrator, | ||
| icon=Icon.GEAR, | ||
| ) |
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
dont return a dict to represent structured data, create a dedicated
OrchestratorInfoclass for it