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.x](backport #4366) Align formatting of APM rules with other rules docs #4435

Merged
merged 1 commit into from
Oct 25, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 25, 2024

Description

Aligns formatting of APM rules with other rules docs. This includes:

  • Splitting the current APM rules docs from one long page, to a separate page for each rule.
  • Adding lists of filters, conditions, action types, and valid action variables.
  • Adding an intro to APM rules in the APM section of the Observability guide with links to relevant rules docs.

So far, I've fully written the APM Anomaly rule page. If the team thinks this is a good approach, I'll finish building out the content on the pages for the rest of the APM-related rules.

Preview: https://observability-docs_bk_4366.docs-preview.app.elstc.co/guide/en/observability/master/apm-alerts.html

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 #4040

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)
    • Other:
      I'm not going to port to serverless right now because:
  • 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 #4366 done by [Mergify](https://mergify.com).

* split apm alerts and format like other rule docs

* fill out individual apm rule pages

* address feedback

* apm ui -> applications ui

---------

Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>
(cherry picked from commit 49453be)
@mergify mergify bot requested a review from a team as a code owner October 25, 2024 13:53
@mergify mergify bot added the backport label Oct 25, 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 enabled auto-merge (squash) October 25, 2024 14:24
@colleenmcginnis colleenmcginnis merged commit 2673a18 into 8.x Oct 25, 2024
8 checks passed
@colleenmcginnis colleenmcginnis deleted the mergify/bp/8.x/pr-4366 branch October 25, 2024 14:24
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