-
Notifications
You must be signed in to change notification settings - Fork 159
docs: build alerts as code #8588
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
Conversation
ericpgreen2
left a comment
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.
The documentation addresses a real user need and the live connector tip is valuable. However, each section needs 1-2 sentences of explanatory context before diving into YAML snippets. Currently the page reads as a series of code blocks without enough connective prose.
Sections needing additional context:
-
Metrics SQL (line 78): Add a sentence clarifying when to use
metrics_sqlvs regularsql. Themetrics_sqlsyntax is documented in Custom APIs—consider linking there or adding a brief explanation. -
Custom API (line 89): Add a sentence explaining when you'd use this approach. Link to Custom APIs.
-
Resource Status (line 101): Add use case context (e.g., "useful for monitoring pipeline health and catching reconciliation failures").
-
Recovery Notifications (line 156): Explain when you'd want each option. For example: "Use
on_recoverto confirm issues are resolved; useon_errorto catch alert evaluation failures (e.g., query syntax errors)." -
Re-notification (line 167): Explain the use case (e.g., "Prevents alert fatigue while ensuring ongoing issues aren't forgotten").
-
Intervals (line 200): This concept only appears in an example. Consider promoting it to its own subsection under "Scheduling Alerts" with an explanation of when to use interval-based monitoring vs simple cron schedules.
Properties to mention (with link to reference):
Add a note: "For advanced properties like glob, for, watermark, and timeout, see the Alert YAML Reference."
Developed in collaboration with Claude Code
|
|
||
| Alert on any resource errors in your project: | ||
|
|
||
| ```yaml |
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.
Add a brief note explaining ISO 8601 duration format for users unfamiliar with this syntax (e.g., "PT1H = 1 hour, P1D = 1 day").
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.
And/or link to the time syntax docs
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.
not sure how this applies, i dont think we can use those durations in the alert YAML, its
ericpgreen2
left a comment
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.
Nice! I especially like the "Working Examples" section.
I'm not sure what we should call the sidebar title, alerts seems overlapping with explore/alerts, granted theyll be separated soon into dev and user pages..
thoughts?
reason: there's been at least 2 questions related to data quality but customer was on live connector so good to shout out that they can use alerts instead
Checklist: