Skip to content

feat(alertStatus): Add Alert Status documentation #4820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 10, 2022

Conversation

mikellykels
Copy link
Contributor

@mikellykels mikellykels commented Mar 9, 2022

Add new Alert Status documentation for issue alerts.

- Still need to add a screenshot

FIXES WOR-1625

Add new Alert Status documentation for issue alerts.

FIXES WOR-1625
@vercel
Copy link

vercel bot commented Mar 9, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sentry/sentry-docs/7VkatGV9PMMLwW9G5zn9MUwRvKoe
✅ Preview: https://sentry-docs-git-kelly-alert-status.sentry.dev

@mikellykels mikellykels requested review from imatwawana and a team March 9, 2022 21:01
Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just commenting for now, but I'll circle back and to review again when the screenshot has been added. I've made a few style edits and a couple wording changes to avoid repetition. Otherwise looks good!

@imatwawana
Copy link
Contributor

imatwawana commented Mar 9, 2022

Forgot to add, we'll need to add an EA note on this just after the new heading you've added per here.

Copy link
Member

@scttcper scttcper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it looks good to me, but i'd let @imatwawana take another look

Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple more wording fixes, but otherwise looks great!


</Note>

The **Alert Details** page shows you the number of times an issue alert rule was triggered over time, grouped in one hour time buckets. Clicking on the alert rule name in the "Alert Rules" tab, or on the notification you receive will take you to this page. The page also includes the alert rule conditions, the current status of the alert (Warning, Critical, or Resolved), and alert details such as when it was created, when it was last modified, and the team that owns the alert.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The **Alert Details** page shows you the number of times an issue alert rule was triggered over time, grouped in one hour time buckets. Clicking on the alert rule name in the "Alert Rules" tab, or on the notification you receive will take you to this page. The page also includes the alert rule conditions, the current status of the alert (Warning, Critical, or Resolved), and alert details such as when it was created, when it was last modified, and the team that owns the alert.
The **Alert Details** page shows you the number of times an issue alert rule was triggered over time, grouped in one hour buckets. Clicking on the alert rule name in the "Alert Rules" tab, or on the notification you receive will take you to this page. The page also includes the alert rule conditions, the current status of the alert (Warning, Critical, or Resolved), and alert details such as when it was created, when it was last modified, and the team that owns the alert.


![Alert details illustrates a graph showing the alerts triggered over time.](issue-alert-status-page-details.png)

The **Alert Details** page also includes a list of issues that triggered the alert. You can see which issues triggered the alert and then open that issue's page to find more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The **Alert Details** page also includes a list of issues that triggered the alert. You can see which issues triggered the alert and then open that issue's page to find more information.
The **Alert Details** page also includes a list of issues that triggered the alert. You can click on any of the issues in the list to go to that issue's details page for more information.

@mikellykels mikellykels merged commit 0948526 into master Mar 10, 2022
@mikellykels mikellykels deleted the kelly/alert-status branch March 10, 2022 20:28
@github-actions github-actions bot locked and limited conversation to collaborators Mar 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants