Skip to content

docs: add Unified Alerts View and SLOs pages under Alerting - #388

Merged
anirudha merged 2 commits into
opensearch-project:mainfrom
lezzago:docs/alerting-slo-unified-alerts
Aug 5, 2026
Merged

docs: add Unified Alerts View and SLOs pages under Alerting#388
anirudha merged 2 commits into
opensearch-project:mainfrom
lezzago:docs/alerting-slo-unified-alerts

Conversation

@lezzago

@lezzago lezzago commented Aug 4, 2026

Copy link
Copy Markdown
Member

What

Adds documentation for two alerting/monitoring features and reorganizes the Alerting section of the docs site.

  • Unified Alerts View — a new page describing the single screen that merges OpenSearch monitors and Prometheus alerts (Alerts / Rules / Routing tabs, filters, alert timeline).
  • SLOs — a three-page section:
    • Overview — concepts (SLI, SLO, error budget, burn rate, MWMBR) and how SLOs compile into Prometheus rules.
    • Create an SLO — the template-first wizard walkthrough.
    • Explore an SLO — the detail page (attainment, error budget, burn-rate tiers, charts).
  • Sidebar — moves the Alerting group to sit right after Send Data, with the new pages nested under it.
  • Adds walkthrough GIFs and screenshots for both features.

Style

The pages are written generically in the feature-documentation style used by the other feature pages (anomaly-detection, apm, investigate) — concept + UI walkthrough, without deployment-specific plumbing (container names, compose files, ports, curl commands, repo paths).

Testing

npm run build passes with clean internal-link validation (141 pages). Verified all pages render and images load via the local preview.

Misc

Also includes a small unrelated fix for a flaky property-based test in Performance.test.ts (a sanitized fast-check company name could collapse to an empty string and fail an alt truthiness assertion). Added a fallback matching the existing pattern in that file.

@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.62%. Comparing base (b93a0b7) to head (0281a42).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #388   +/-   ##
=======================================
  Coverage   55.62%   55.62%           
=======================================
  Files           4        4           
  Lines         169      169           
  Branches       47       47           
=======================================
  Hits           94       94           
  Misses         74       74           
  Partials        1        1           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Add a Unified Alerts View page and a three-page SLOs section (overview,
create, explore) to the Alerting section, with walkthrough GIFs and
screenshots. Move the Alerting group to sit after Send Data in the
sidebar. Keep the pages generic (feature-style), consistent with the
other feature docs.

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>
@lezzago
lezzago force-pushed the docs/alerting-slo-unified-alerts branch from 959570a to 2c5d595 Compare August 4, 2026 23:45
@lezzago
lezzago marked this pull request as draft August 4, 2026 23:52
The company-name generator sanitized `< > " ' &` out of the fast-check
string but had no fallback, so a short input made entirely of those
characters collapsed to an empty string and failed the `alt` truthiness
assertion (seed-dependent flake). Add the `|| 'company name'` fallback,
matching the pattern already used by the other alt-text generators in
this file.

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>
@lezzago
lezzago marked this pull request as ready for review August 5, 2026 00:07
@anirudha
anirudha merged commit 14dc2dd into opensearch-project:main Aug 5, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants