Skip to content
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

Enhancements to alerting docs #4709

Merged
merged 5 commits into from
Jan 7, 2025

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Dec 18, 2024

Description

Makes some improvements to the alerting docs as suggested by @lucabelluccini:

  • List all available alerts with the "real" name in the Kibana (14aace2)
  • Prerequisites for APM - Anomaly rule (53df623)
  • Guidance on migrating from Uptime to Synthetics (2c53801)
  • Suggest the data being queried on each alert type
    • Note: @lucabelluccini mentioned it would be handy to have an hint to which data stream / data view / index pattern each kind of rule uses. E.g. for APM, one might think the user is allowed to use all the data from the traces-apm* data streams, while it's not true. I looked around quite a bit, but I couldn't find a source of truth anywhere. 😕 I'm not sure if that should block the other updates made here.

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4609

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

@colleenmcginnis colleenmcginnis added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Dec 18, 2024
@colleenmcginnis colleenmcginnis self-assigned this Dec 18, 2024
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review January 2, 2025 21:21
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner January 2, 2025 21:21
bmorelli25
bmorelli25 previously approved these changes Jan 3, 2025
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@colleenmcginnis colleenmcginnis merged commit 227efa7 into elastic:main Jan 7, 2025
4 checks passed
@colleenmcginnis colleenmcginnis deleted the issue-4609 branch January 7, 2025 18:17
@lucabelluccini
Copy link
Contributor

Thanks @colleenmcginnis ❤️

For the "it would be handy to have an hint to which data stream / data view / index pattern each kind of rule uses", I think we would need some help from the developers.
I could reverse-engineer it and look in the code...

I've discussed this with @paulb-elastic and there might be upcoming changes in 9.0 which will show the data views which can be used by the alerts directly in the Kibana UI.

mergify bot pushed a commit that referenced this pull request Jan 7, 2025
* restructure list of rules

* add prerequisites for apm anomaly rule

* clarify why we are referencing sli in rule docs

* double-check names against ui

(cherry picked from commit 227efa7)
mergify bot pushed a commit that referenced this pull request Jan 7, 2025
* restructure list of rules

* add prerequisites for apm anomaly rule

* clarify why we are referencing sli in rule docs

* double-check names against ui

(cherry picked from commit 227efa7)
mergify bot pushed a commit that referenced this pull request Jan 7, 2025
* restructure list of rules

* add prerequisites for apm anomaly rule

* clarify why we are referencing sli in rule docs

* double-check names against ui

(cherry picked from commit 227efa7)
colleenmcginnis added a commit that referenced this pull request Jan 7, 2025
* restructure list of rules

* add prerequisites for apm anomaly rule

* clarify why we are referencing sli in rule docs

* double-check names against ui

(cherry picked from commit 227efa7)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Jan 7, 2025
* restructure list of rules

* add prerequisites for apm anomaly rule

* clarify why we are referencing sli in rule docs

* double-check names against ui

(cherry picked from commit 227efa7)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Jan 7, 2025
* restructure list of rules

* add prerequisites for apm anomaly rule

* clarify why we are referencing sli in rule docs

* double-check names against ui

(cherry picked from commit 227efa7)

Co-authored-by: Colleen McGinnis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Observability Alerting - Enhancements to O11y Alerting doc
3 participants