Skip to content

docs(alerts): add an Insights page - #148

Merged
idanlodzki merged 3 commits into
OpsiMate:mainfrom
Apu-Emdad:docs/insights-page
Oct 13, 2026
Merged

idanlodzki merged 3 commits into
OpsiMate:mainfrom
Apu-Emdad:docs/insights-page

Conversation

@Apu-Emdad

Copy link
Copy Markdown
Contributor

Issue Reference

Closes OpsiMate/OpsiMate#1086


What Was Changed

  • New page: opsimate-docs/docs/alerts/insights.md, added to the Alerts category in sidebars.js.
  • Sources: written from AlertInsights.tsx, components/Analytics/ and the field comments in packages/shared/src/alerts/alertAnalytics.ts.
  • What the page covers:
    • Opening it: the Insights entry in the left sidebar.
    • Time range: Today / 24h / 7 days (default) / 30 days / 90 days / All time. Windows of 48h or less are bucketed by hour, longer ones by day, in the browser's time zone.
    • Dashboard scope: limits every number to the alerts matching a saved dashboard's filters and search.
    • Overview tab:
      • alert episodes (an alert firing twice counts twice)
      • resolved, with the previous-period delta (none on All time)
      • firing now
      • noise ratio
      • volume by severity with the resolutions overlay
      • peak hours and busiest days
      • severity split
      • top responders, top alerts and common tags
    • Reliability tab:
      • MTTR (mean / median / p90 + delta)
      • MTTA (first human action: own, silence, comment, action or resolve)
      • MTBF
      • re-fire rate (re-fires within 24h)
      • ack coverage
      • episodes per day
      • the MTTR/MTTA trend chart
    • By alert tab: one row per alert name, with episodes, firing now, MTTR, MTBF, re-fire rate, worst severity and last seen.
    • Tags tab: per-value episodes, resolved, MTTR and firing now, a volume chart, and per-value MTTR/MTTA trends.
    • API: GET /api/v1/alerts/analytics with from / to (leave out from for all time), tz, filters + search, and tagKey. from after to returns 400.
  • Screenshot: one image of the Overview tab, taken from the live demo, at static/img/insights-overview.png.

Why Was It Changed

The Insights page wasn't documented anywhere, so people had no way to know what the numbers mean or how they're computed.


Screenshots

The page embeds the Overview tab screenshot (static/img/insights-overview.png). I previewed the page locally, and npm run build passes with no broken-link or anchor warnings. A screenshot of the rendered docs page will be added in a follow-up comment.

Document the Insights page (/insights): the time-range presets and how
they are bucketed, dashboard scope, what every number on the Overview,
Reliability, By alert and Tags tabs means, and the
GET /api/v1/alerts/analytics endpoint behind it. Add it to the Alerts
category in the sidebar, with a screenshot of the Overview tab taken from
the live demo.

Closes OpsiMate/OpsiMate#1086
@vercel

vercel Bot commented Oct 13, 2026

Copy link
Copy Markdown

@Apu-Emdad is attempting to deploy a commit to the idan lodzki's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: Repository: OpsiMate/documentation/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 80b63762-bd87-472b-8e90-50d8489a3e9b
📥 Commits

Reviewing files that changed from the base of the PR and between 06e0ee5 and 541b4ad.

⛔ Files ignored due to path filters: 1
  • opsimate-docs/static/img/insights-overview.png is excluded by !**/*.png
📒 Files selected for processing: 2
  • opsimate-docs/docs/alerts/insights.md
  • opsimate-docs/sidebars.js
 ________________________________________________________________________________________________________________________________
< Some things are better done than described. Don't fall into the specification spiral - at some point you need to start coding. >
 --------------------------------------------------------------------------------------------------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

idanlodzki and others added 2 commits October 14, 2026 00:14
- By alert: list the real columns (Alert name, Episodes, MTTR, MTBF, Re-fire, Last seen); worst severity and the firing badge live in the name cell
- Tags: add the Distinct values / Tagged episodes / Tag coverage / Firing now cards; table is Value, Episodes, MTTR, Firing (no resolved count)
- API example: use a <your-api-token> placeholder instead of a literal token

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
# Conflicts:
#	opsimate-docs/sidebars.js
@idanlodzki
idanlodzki merged commit 828dbda into OpsiMate:main Oct 13, 2026
2 of 3 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.

Docs: add an Insights page

2 participants