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

[8.17](backport #4709) Enhancements to alerting docs #4748

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jan 7, 2025

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>

This is an automatic backport of pull request #4709 done by [Mergify](https://mergify.com).

* 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 mergify bot requested a review from a team as a code owner January 7, 2025 18:18
@mergify mergify bot added the backport label Jan 7, 2025
Copy link
Contributor

github-actions bot commented Jan 7, 2025

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 enabled auto-merge (squash) January 7, 2025 18:51
@colleenmcginnis colleenmcginnis merged commit f4a1453 into 8.17 Jan 7, 2025
8 checks passed
@colleenmcginnis colleenmcginnis deleted the mergify/bp/8.17/pr-4709 branch January 7, 2025 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant