[8.12] [DOCS] Replace table of links with single link to Obs alerting docs (#177525) (#178427)

# Backport

This will backport the following commits from `main` to `8.12`:
- [[DOCS] Replace table of links with single link to Obs alerting docs
(#177525)](https://github.com/elastic/kibana/pull/177525)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"DeDe
Morton","email":"dede.morton@elastic.co"},"sourceCommit":{"committedDate":"2024-03-11T18:34:31Z","message":"[DOCS]
Replace table of links with single link to Obs alerting docs
(#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links
with a single link to the\r\nobservability alerting docs because this
table is likely to get stale\r\nover time (in fact, it already is
stale).\r\n\r\nThe change looks like this when rendered in
HTML:\r\n\r\n\r\n![image](a3f67a18-f227-435d-9b56-ddb221cdce7c)\r\n\r\n\r\nNotes/open
issues:\r\n- [x] The [main
alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor
Kibana now has links to related alerting documentation, but is
it\r\nclear that those links point to docs that describe how to manage
alerts\r\nfrom those apps? The link text seems maybe not descriptive
enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going
to leave this\r\nas-is because I think the feedback we received
initially about the lack\r\nof links was before the links were
added._\r\n- [x] In the intro, I feel a thought might be missing from
this\r\nstatement: \"For information on creating security rules, refer
to Create\r\na detection rule.\" Should this instead say something like:
\"Security\r\nrules must be defined in the Security app. For more
information, refer\r\nto the security docs about creating a detection
rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's
alerting capabilities\r\nshould be more consistent, but I don't want to
rewrite other folk's\r\nsections. So I have aligned my description with
the security section,\r\nfor better or worse. It's hard to make this
info consistent when each\r\nsolution/app is doing its own thing with
alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is
it correct to say \"create alerts\" rather than something
like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep
as \"create\"\r\nfor now since the UI is not using
\"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you
help me sort through my list of open issues?\r\n\r\nCo-authored-by:
Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:all-open","v8.14.0","v8.12.3"],"title":"[DOCS]
Replace table of links with single link to Obs alerting
docs","number":177525,"url":"https://github.com/elastic/kibana/pull/177525","mergeCommit":{"message":"[DOCS]
Replace table of links with single link to Obs alerting docs
(#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links
with a single link to the\r\nobservability alerting docs because this
table is likely to get stale\r\nover time (in fact, it already is
stale).\r\n\r\nThe change looks like this when rendered in
HTML:\r\n\r\n\r\n![image](a3f67a18-f227-435d-9b56-ddb221cdce7c)\r\n\r\n\r\nNotes/open
issues:\r\n- [x] The [main
alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor
Kibana now has links to related alerting documentation, but is
it\r\nclear that those links point to docs that describe how to manage
alerts\r\nfrom those apps? The link text seems maybe not descriptive
enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going
to leave this\r\nas-is because I think the feedback we received
initially about the lack\r\nof links was before the links were
added._\r\n- [x] In the intro, I feel a thought might be missing from
this\r\nstatement: \"For information on creating security rules, refer
to Create\r\na detection rule.\" Should this instead say something like:
\"Security\r\nrules must be defined in the Security app. For more
information, refer\r\nto the security docs about creating a detection
rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's
alerting capabilities\r\nshould be more consistent, but I don't want to
rewrite other folk's\r\nsections. So I have aligned my description with
the security section,\r\nfor better or worse. It's hard to make this
info consistent when each\r\nsolution/app is doing its own thing with
alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is
it correct to say \"create alerts\" rather than something
like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep
as \"create\"\r\nfor now since the UI is not using
\"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you
help me sort through my list of open issues?\r\n\r\nCo-authored-by:
Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/177525","number":177525,"mergeCommit":{"message":"[DOCS]
Replace table of links with single link to Obs alerting docs
(#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links
with a single link to the\r\nobservability alerting docs because this
table is likely to get stale\r\nover time (in fact, it already is
stale).\r\n\r\nThe change looks like this when rendered in
HTML:\r\n\r\n\r\n![image](a3f67a18-f227-435d-9b56-ddb221cdce7c)\r\n\r\n\r\nNotes/open
issues:\r\n- [x] The [main
alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor
Kibana now has links to related alerting documentation, but is
it\r\nclear that those links point to docs that describe how to manage
alerts\r\nfrom those apps? The link text seems maybe not descriptive
enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going
to leave this\r\nas-is because I think the feedback we received
initially about the lack\r\nof links was before the links were
added._\r\n- [x] In the intro, I feel a thought might be missing from
this\r\nstatement: \"For information on creating security rules, refer
to Create\r\na detection rule.\" Should this instead say something like:
\"Security\r\nrules must be defined in the Security app. For more
information, refer\r\nto the security docs about creating a detection
rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's
alerting capabilities\r\nshould be more consistent, but I don't want to
rewrite other folk's\r\nsections. So I have aligned my description with
the security section,\r\nfor better or worse. It's hard to make this
info consistent when each\r\nsolution/app is doing its own thing with
alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is
it correct to say \"create alerts\" rather than something
like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep
as \"create\"\r\nfor now since the UI is not using
\"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you
help me sort through my list of open issues?\r\n\r\nCo-authored-by:
Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075"}},{"branch":"8.12","label":"v8.12.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
This commit is contained in:
Kibana Machine 2024-03-11 14:58:11 -04:00 committed by GitHub
parent 44832c5467
commit d96fd4edb9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -39,7 +39,7 @@ see {subscriptions}[the subscription page].
[[observability-rules]]
=== {observability} rules
{observability} rules are categorized into APM and {user-experience}, Logs, Metrics, {stack-monitor-app}, and Uptime.
{observability} rules detect complex conditions in your observability data and create alerts when a rule's conditions are met. For example, you can create a rule that detects when the value of a metric exceeds a specified threshold or when an anomaly occurs on a system or service you are monitoring. For more information, refer to {observability-guide}/create-alerts.html[Alerting].
[NOTE]
==============================================
@ -47,27 +47,6 @@ If you create a rule in the {observability} app, its alerts are not visible in
*{stack-manage-app} > {rules-ui}*. They are visible only in the {observability} app.
==============================================
[cols="2*<"]
|===
| <<apm-alerts, APM and User Experience>>
| Detect complex conditions in *APM* data and trigger built-in actions when the conditions are met.
| {observability-guide}/logs-threshold-alert.html[Logs rules]
| Detect complex conditions in the {logs-app}.
| {observability-guide}/metrics-threshold-alert.html[Metrics rules]
| Detect complex conditions in the {metrics-app}.
| {observability-guide}/slo-burn-rate-alert.html[SLO burn rate rule]
| Detect when the burn rate is above a defined threshold.
| {observability-guide}/monitor-status-alert.html[Uptime rules]
| Detect complex conditions in the {uptime-app}.
|===
[float]
[[ml-rules]]
=== Machine learning rules