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

Align formatting of APM rules with other rules docs #4366

Merged
merged 7 commits into from
Oct 25, 2024

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Oct 14, 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>

@colleenmcginnis colleenmcginnis added the backport-8.x Automated backport to the 8.x branch with mergify label Oct 14, 2024
@colleenmcginnis colleenmcginnis self-assigned this Oct 14, 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
Copy link
Contributor Author

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

@bmorelli25 and/or @dedemorton can you take a look and let me know what you think?

@dedemorton
Copy link
Contributor

In general, I think what you've done is fine. Unfortunately there are a lot of inconsistencies across the alerting topics we've developed, so suggesting the best way forward is a little tricky. (See the issue I opened about this problem.)

I'm not sure who should make the final decision about how to structure these docs (maybe Lisa?), but I think we need to establish a repeatable pattern and stick with it (in the Obs docs, in the Kibana docs, etc).

To meet the immediate objective (getting the APM rules broken out into separate topics and organized with other rules), I'm OK with you sticking to the format you have here with the understanding that we will clean this up later.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review October 16, 2024 22:17
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner October 16, 2024 22:17
Copy link
Contributor

mergify bot commented Oct 18, 2024

This pull request is now in conflict. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue-4040 upstream/issue-4040
git merge upstream/main
git push upstream issue-4040

# Conflicts:
#	docs/en/observability/apm-alerts.asciidoc
#	docs/en/observability/apm/act-on-data/index.asciidoc
@bmorelli25
Copy link
Member

I'm impatient and wanted to merge #4373. And that caused some conflicts with this PR. Since it was my fault, I addressed the conflicts in e43784b. Sorry !!

@bmorelli25
Copy link
Member

Good stuff! I like where this is heading.

@colleenmcginnis colleenmcginnis added the backport-8.16 Automated backport with mergify label Oct 23, 2024
@colleenmcginnis colleenmcginnis requested a review from a team October 23, 2024 15:50
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.

🌸 ❗❗

@colleenmcginnis colleenmcginnis merged commit 49453be into elastic:main Oct 25, 2024
4 checks passed
@colleenmcginnis colleenmcginnis deleted the issue-4040 branch October 25, 2024 13:51
mergify bot pushed a commit that referenced this pull request Oct 25, 2024
* 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 bot pushed a commit that referenced this pull request Oct 25, 2024
* 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)
colleenmcginnis added a commit that referenced this pull request Oct 25, 2024
* 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)

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
colleenmcginnis added a commit that referenced this pull request Oct 25, 2024
* 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)

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
eedugon pushed a commit to eedugon/observability-docs that referenced this pull request Nov 6, 2024
* 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>
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 needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request]: Add list of valid action variables to APM alerting topics
3 participants