docs: document monitoring threshold breach workflow trigger [sc-16661] - #1464
Draft
juanmleng wants to merge 2 commits into
Draft
docs: document monitoring threshold breach workflow trigger [sc-16661]#1464juanmleng wants to merge 2 commits into
juanmleng wants to merge 2 commits into
Conversation
Adds a guide page for starting a record workflow automatically when an ongoing monitoring metric enters a breached state, listed under Ongoing monitoring below Set thresholds and alerts. Also adds the trigger to the Workflow Start list in the workflows guide, in both the HTML and RevealJS variants of the shared include, so the enumeration of triggers stays complete.
The alert email and the workflow run on different rhythms — the email fires for every breaching reading, the workflow starts only on the transition into breach — so one person can receive three things for a single breach: the alert email, the workflow's broadcast email, and the in-app broadcast. Nothing said so, and the difference is worth knowing before adding a broadcast step. Names the toggles that reduce it, and both of their limits: they apply to the whole organization rather than to one record or workflow, and they suppress emails only, so the in-app notification arrives either way. Also corrects the Breached Metric Name row. It described a bare display name, which is only the last dot segment of a metric's key and collides between metrics — the variable now resolves to the name followed by the key, matching how the metric is labelled where you pick it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What and why?
Documents the new On Monitoring Threshold Breach workflow trigger, which starts a record workflow automatically when an ongoing monitoring metric enters a breached state.
Before: Ongoing monitoring covered thresholds and stakeholder email alerts only. The Workflow Start list covered Manually / On Inventory Record Registration / On Field Change / Via Webhook.
After:
Shortcut: https://app.shortcut.com/validmind/story/16661
Implementation:
validmind/backendhttps://github.com/validmind/backend/pull/3458,validmind/frontendhttps://github.com/validmind/frontend/pull/2797How to test
All four render with no new warnings.
Hosted preview: to be added once the
validatejob deploys.What needs special review?
launchdarkly.rollout.monitoring-breach-trigger, off by default, enforced on both the UI and the firing path). This page describes behaviour customers cannot see until the flag is enabled, so it should not be promoted to prod ahead of the rollout. Merging tomainis fine._add-new-workflows.qmdis a shared include with two format variants; both were edited. Consumers areguide/workflows/configure-workflows.qmd(HTML) andtraining/administrator-fundamentals/using-validmind-for-risk-management.qmd(RevealJS) — both rendered and checked.passedparameter and does not re-evaluate thresholds, so a metric that defines thresholds but never setspassednever starts a workflow. That is easy for a customer to misread.Dependencies, breaking changes, and deployment notes
site/.Release notes
Documented how to start a workflow automatically when an ongoing monitoring metric breaches its threshold. Learn more ...
Checklist