Repository navigation
docs(alerts): add an Insights page - #148
Merged
Merged
Conversation
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
|
@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. |
Contributor
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configuration
⛔ Files ignored due to path filters: 1
📒 Files selected for processing: 2
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. Comment |
- 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
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
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.
Issue Reference
Closes OpsiMate/OpsiMate#1086
What Was Changed
opsimate-docs/docs/alerts/insights.md, added to the Alerts category insidebars.js.AlertInsights.tsx,components/Analytics/and the field comments inpackages/shared/src/alerts/alertAnalytics.ts.GET /api/v1/alerts/analyticswithfrom/to(leave outfromfor all time),tz,filters+search, andtagKey.fromaftertoreturns 400.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, andnpm run buildpasses with no broken-link or anchor warnings. A screenshot of the rendered docs page will be added in a follow-up comment.