-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
Add descriptions to alert types #81850
Add descriptions to alert types #81850
Conversation
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
@@ -32,4 +32,7 @@ export const MonitorStatusTranslations = { | |||
name: i18n.translate('xpack.uptime.alerts.monitorStatus.clientName', { | |||
defaultMessage: 'Uptime monitor status', | |||
}), | |||
description: i18n.translate('xpack.uptime.alerts.monitorStatus.description', { | |||
defaultMessage: 'Alert when the status of an Uptime monitor is down.', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think this need a better copy, uptime monitor status alert also incorporate availability alert
so may be something like monitor is down or availability crosses set threshold?
help needed here @paulb-elastic @drewpost
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alert when your synthetic monitor is down or its availability breaches an availability threshold
cc @shahzad31
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the feedback! I went ahead and updated the description for this Uptime alert here: 3c83b62.
Pinging @elastic/apm-ui (Team:apm) |
Pinging @elastic/uptime (Team:uptime) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM for stack monitoring!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested some minor changes to the APM alert descriptions.
x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts
Outdated
Show resolved
Hide resolved
x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts
Outdated
Show resolved
Hide resolved
@chrisronline @phillipb @formgeist thanks for making sure my descriptions were accurate. I got the descriptions reviewed by @gchaps and we slightly modified them. I could use another review 👍 for awareness. |
Same for Uptime now, I just finished updating the copy 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
description: i18n.translate( | ||
'xpack.monitoring.alerts.elasticsearchVersionMismatch.description', | ||
{ | ||
defaultMessage: 'Alert when the cluster has mutliple versions of Elasticsearch.', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo here with mutliple
}, | ||
[ALERT_LOGSTASH_VERSION_MISMATCH]: { | ||
label: i18n.translate('xpack.monitoring.alerts.logstashVersionMismatch.label', { | ||
defaultMessage: 'Logstash version mismatch', | ||
}), | ||
description: i18n.translate('xpack.monitoring.alerts.logstashVersionMismatch.description', { | ||
defaultMessage: 'Alert when the cluster has mutliple versions of Logstash.', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo here with mutliple
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
…t-type-descriptions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
* Initial attempt at adding descriptions to alert types * Fix typecheck failures * Fix i18n check * Fix failing jest test * Fix i18n check again * Apply changes for Uptime * Update x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Co-authored-by: Casper Hübertz <casper@formgeist.com> * Update x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Co-authored-by: Casper Hübertz <casper@formgeist.com> * Fix jest test * Update geo threshold description * Update description of some alert types based on feedback from Gail * Update description of some alert types based on feedback from Gail * Fix i18n * Fix i18n * Fix ESLint * Update some copy * Update uptime alert description * Fix typos Co-authored-by: Casper Hübertz <casper@formgeist.com>
* Initial attempt at adding descriptions to alert types * Fix typecheck failures * Fix i18n check * Fix failing jest test * Fix i18n check again * Apply changes for Uptime * Update x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Co-authored-by: Casper Hübertz <casper@formgeist.com> * Update x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Co-authored-by: Casper Hübertz <casper@formgeist.com> * Fix jest test * Update geo threshold description * Update description of some alert types based on feedback from Gail * Update description of some alert types based on feedback from Gail * Fix i18n * Fix i18n * Fix ESLint * Update some copy * Update uptime alert description * Fix typos Co-authored-by: Casper Hübertz <casper@formgeist.com> Co-authored-by: Casper Hübertz <casper@formgeist.com>
💔 Build Failed
Failed CI StepsTest FailuresX-Pack API Integration Tests.x-pack/test/api_integration/apis/management/rollup/rollup·js.apis management rollup jobs Index patterns should return the date, numeric and keyword fields when an index pattern matches indicesStandard Out
Stack Trace
X-Pack API Integration Tests.x-pack/test/api_integration/apis/management/rollup/rollup·js.apis management rollup jobs Index patterns should return the date, numeric and keyword fields when an index pattern matches indicesStandard Out
Stack Trace
Metrics [docs]Async chunks
Page load bundle
Saved Objects .kibana field count
History
To update your PR or re-run it, just comment with: |
Part of #75548
In this PR, I'm adding a description to each alert type that is registered in the UI as well as making it required in TypeScript for any new alert type that gets created.
There's a few upcoming features that will start taking advantage of these:
Note to codeowners
I gave it my best guess at how to describe each alert type. I'd like to have the description (and code) reviewed either to make sure the description accurate or to get feedback on a better suggestion. So far, starting every description with "Alert when" seems right. I will get @gchaps to help review these after your feedback.
Note for docs
From a technical perspective, the
AlertTypeModel
in the UI now requires via TypeScript adescription
property.