docs(metrics): rename Monitors feature to Alerts - #3492
Conversation
Renames the product feature across the docs site and adds a redirect from the old page URL. App routes, the webhook payload schema, and the feat-monitors discussions label keep the legacy naming. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@claude review |
There was a problem hiding this comment.
LGTM — mechanical, well-scoped rename with one wording nit flagged inline that doesn't affect correctness.
Extended reasoning...
Overview
This PR renames the "Monitors" feature to "Alerts" across the docs site: the feature page (renamed file + URL), sidebar meta.json, pricing tables (React component and both md-override sources), the self-hosting compatibility matrix, changelog card labels/canonical links, and every cross-reference in blog posts, FAQ, engineering resources, the Slack integration page, and the handbook. A permanent redirect from the old /docs/metrics/features/monitors URL is added in lib/redirects.js.
Security risks
None. This is a pure content/copy and redirect change with no application logic, auth, or data-handling code touched.
Level of scrutiny
Low-to-medium. The change is large in file count (size:L) but each file's diff is a mechanical, low-ambiguity string/link substitution following one consistent naming decision (monitor → alert, monitor-firing → notification). The PR correctly preserves intentionally-unchanged internal seams (app routes, webhook payload schema, feat-monitors label) and documents that decision with an in-page callout, which is the trickiest part of this kind of rename to get right.
Other factors
md-override/pricing.mdandmd-override/pricing-self-host.mdwere updated in the same change as the pricing table component, keeping the override/rendered-page pair in sync per repo convention.- The renamed
alerts.mdxfile keeps a single H1 and all referenced anchors (#alert-setup,#alert-states,#automations, etc.) are defined in the file. - The one issue surfaced (a pre-existing "spend alerts" vs. "alerts" naming overlap in the cost-management doc) is a wording nit already called out as an inline comment — it doesn't affect correctness of any link, redirect, or code path, so it doesn't warrant blocking this otherwise clean rename.
The rename made "alerts" a substring of the pre-existing "spend alerts" billing feature, so the disambiguation sentence in the cost management guide read as a subtype relationship. Qualify the renamed feature as "cost-metric alerts" where the two appear together. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Summary
The docs call the threshold-alerting feature "Monitors" (borrowed from Datadog terminology), which collides with the broader "Monitoring" stage of the AI engineering loop and reads less intuitively than "Alert" (as flagged by @clemo in the #product-langfuse thread).
To achieve this we:
/docs/metrics/features/monitorsURLNote: app routes (
cloud.langfuse.com/project/~/monitors), the webhook payload schema (type: "monitor-alert",monitorId), and thefeat-monitorsdiscussions label keep the legacy naming, per the ticket's DoD that internal seams stay put. The docs page now carries a callout stating the payload naming is unchanged so existing integrations keep working. Changelog entries keep their dated prose as a historical record — only their card labels and canonical links were updated.Fixes LFE-14881
Verification
pnpm run format:check— all matched files use Prettier code stylenode scripts/check-h1-headings.js— no multiple-H1 violationsnode scripts/copy_md_sources.js— Markdown source generated atpublic/md-src/docs/metrics/features/alerts.md/docs/metrics/features/alertsreturns 200 with title "Alerts";/docs/metrics/features/monitorsreturns 308 to the new URL/pricingand/self-hosting/upgrade/versioningreturn 200pnpm build+pnpm link-check(left to CI)Test plan
#alert-setup,#alert-states,#automations) all resolve/docs/metrics/features/monitorsURL, confirm it redirects to/docs/metrics/features/alerts/pricing, confirm the row reads "Alerts" with limits of 2 / 20 / 50 / 100 alerts, and that the rendered table matchesmd-override/pricing.md/self-hosting/upgrade/versioning, click the "Alerts" row and confirm the expandable detail panel still opens (theCompatDetailname must match the row label)ALERTand the Alert threshold field, matching the strings the app emits🤖 Generated with Claude Code
Note
Low Risk
Documentation and redirect-only changes with no application logic; risk is limited to broken links or inconsistent terminology, which the PR appears to address systematically.
Overview
Renames the threshold-metric feature from Monitors to Alerts across the docs site, pricing, and cross-links, with the primary page at
/docs/metrics/features/alertsand a permanent redirect from/docs/metrics/features/monitors.Copy is updated so an alert is the configured rule and notifications describe what fires on severity changes (including automation setup and renotify wording). Pricing and self-host tables now show alert limits (2 / 20 / 50 / 100); the alerts doc adds a callout that webhook payload fields (
monitor-alert,monitorId) stay legacy for existing integrations while app URLs under~/monitorsare unchanged in prose.Reviewed by Cursor Bugbot for commit 8e5392b. Bugbot is set up for automated code reviews on this repo. Configure here.