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

[Meta] Observability alerting doc improvements #3622

Closed
14 of 21 tasks
dedemorton opened this issue Feb 13, 2024 · 1 comment
Closed
14 of 21 tasks

[Meta] Observability alerting doc improvements #3622

dedemorton opened this issue Feb 13, 2024 · 1 comment
Assignees

Comments

@dedemorton
Copy link
Contributor

dedemorton commented Feb 13, 2024

This meta issue tracks all the issues and tasks related to improving the Observability alerting documentation.

The work required to resolve this issue will span multiple sprints.

Open questions

  • When syncing the stateful content with serverless, do we want to align with the serverless content as closely as possible? YAS!
  • Do we like the format of the serverless content and want to follow it? Maybe - def like the collapsible sections, but want to make sure procedures in serverless do not gloss over details. Also want to remove extraneous screen captures in favor of providing content that adds value.
  • How should we handle the Uptime-related rules? Looks like some of them do appear under Synthetics. Do we want update the content to show they are relevant for Synthetics? Are they deprecated? Will they be discontinued? Removed? We are leaving them for now. We may want to add a note to the page to indicate that the Uptime UI is disabled until Heartbeat data is available.
  • Are there threshold rules that should be marked as deprecated now that the custom threshold rule is GA? Is it worth the effort right now to rewrite those docs to sync them with serverless? Are they deprecated? Will they be discontinued? Removed? TBD. Leave as-is for now.
  • Is there any reason why we are not alphabetizing the list of rule types in the UI? It's hard to see the organizing principle at work here, which means the list is harder for users to scan. This is fixed (in serverless, at least)

Draft TOC (stateful)

  • Alerting
    • Create and manage rules
      • Custom threshold
      • Inventory threshold
      • Log threshold
      • Metric threshold
      • Monitor status
      • SLO burn rate
      • TLS certificate
      • Uptime duration anomaly
      • Other* (create one category with pointersor move the pages to appear alphabetically in this section)?
    • View and manage alerts

*Missing from the navigation:

Elasticsearch query - covered in Kibana docs here: https://www.elastic.co/guide/en/kibana/8.12/rule-type-es-query.html
Anomaly detection - covered in the ML docs here: https://www.elastic.co/guide/en/machine-learning/master/ml-configuring-alerts.html
APM Anomaly - covered in APM docs here: https://www.elastic.co/guide/en/kibana/8.12/apm-alerts.html
Error count threshold - covered in APM docs here: https://www.elastic.co/guide/en/kibana/master/apm-alerts.html
Failed transaction rate threshold - covered in APM docs here: https://www.elastic.co/guide/en/kibana/master/apm-alerts.html
Latency threshold - covered in APM docs here: https://www.elastic.co/guide/en/kibana/master/apm-alerts.html

Rules that appear under Observability in 8.13:

Image

@dedemorton dedemorton self-assigned this Feb 13, 2024
cauemarcondes added a commit to elastic/kibana that referenced this issue Mar 20, 2024
…76252)

## Summary

This is a part of
elastic/observability-docs#3622.

Before this PR, all four in-product APM alerting documentation links
pointed to
https://www.elastic.co/guide/en/kibana/master/apm-alerts.html. This PR
updates our in-product links to point to either our Serverless or
Stateful documentation, depending on the product type.

Closes elastic/observability-docs#3586.

---------

Co-authored-by: Kibana Machine <[email protected]>
Co-authored-by: Caue Marcondes <[email protected]>
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Mar 20, 2024
…astic#176252)

## Summary

This is a part of
elastic/observability-docs#3622.

Before this PR, all four in-product APM alerting documentation links
pointed to
https://www.elastic.co/guide/en/kibana/master/apm-alerts.html. This PR
updates our in-product links to point to either our Serverless or
Stateful documentation, depending on the product type.

Closes elastic/observability-docs#3586.

---------

Co-authored-by: Kibana Machine <[email protected]>
Co-authored-by: Caue Marcondes <[email protected]>
(cherry picked from commit 62aa327)
kibanamachine added a commit to elastic/kibana that referenced this issue Mar 20, 2024
…ss) (#176252) (#179093)

# Backport

This will backport the following commits from `main` to `8.13`:
- [Make in-product APM alerting links smart (stateful vs serverless)
(#176252)](#176252)

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

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

<!--BACKPORT [{"author":{"name":"Brandon
Morelli","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-03-20T18:43:41Z","message":"Make
in-product APM alerting links smart (stateful vs serverless)
(#176252)\n\n## Summary\r\n\r\nThis is a part
of\r\nhttps://github.com/elastic/observability-docs/issues/3622.\r\n\r\nBefore
this PR, all four in-product APM alerting documentation links\r\npointed
to\r\nhttps://www.elastic.co/guide/en/kibana/master/apm-alerts.html.
This PR\r\nupdates our in-product links to point to either our
Serverless or\r\nStateful documentation, depending on the product
type.\r\n\r\nCloses
https://github.com/elastic/observability-docs/issues/3586.\r\n\r\n---------\r\n\r\nCo-authored-by:
Kibana Machine
<[email protected]>\r\nCo-authored-by:
Caue Marcondes
<[email protected]>","sha":"62aa3279dfdfb12112827826b6ff2d76b50fbe96","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:obs-ux-infra_services","v8.14.0","v8.13.1"],"title":"Make
in-product APM alerting links smart (stateful vs
serverless)","number":176252,"url":"https://github.com/elastic/kibana/pull/176252","mergeCommit":{"message":"Make
in-product APM alerting links smart (stateful vs serverless)
(#176252)\n\n## Summary\r\n\r\nThis is a part
of\r\nhttps://github.com/elastic/observability-docs/issues/3622.\r\n\r\nBefore
this PR, all four in-product APM alerting documentation links\r\npointed
to\r\nhttps://www.elastic.co/guide/en/kibana/master/apm-alerts.html.
This PR\r\nupdates our in-product links to point to either our
Serverless or\r\nStateful documentation, depending on the product
type.\r\n\r\nCloses
https://github.com/elastic/observability-docs/issues/3586.\r\n\r\n---------\r\n\r\nCo-authored-by:
Kibana Machine
<[email protected]>\r\nCo-authored-by:
Caue Marcondes
<[email protected]>","sha":"62aa3279dfdfb12112827826b6ff2d76b50fbe96"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/176252","number":176252,"mergeCommit":{"message":"Make
in-product APM alerting links smart (stateful vs serverless)
(#176252)\n\n## Summary\r\n\r\nThis is a part
of\r\nhttps://github.com/elastic/observability-docs/issues/3622.\r\n\r\nBefore
this PR, all four in-product APM alerting documentation links\r\npointed
to\r\nhttps://www.elastic.co/guide/en/kibana/master/apm-alerts.html.
This PR\r\nupdates our in-product links to point to either our
Serverless or\r\nStateful documentation, depending on the product
type.\r\n\r\nCloses
https://github.com/elastic/observability-docs/issues/3586.\r\n\r\n---------\r\n\r\nCo-authored-by:
Kibana Machine
<[email protected]>\r\nCo-authored-by:
Caue Marcondes
<[email protected]>","sha":"62aa3279dfdfb12112827826b6ff2d76b50fbe96"}},{"branch":"8.13","label":"v8.13.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Brandon Morelli <[email protected]>
@dedemorton
Copy link
Contributor Author

This meta issue has gotten quite large. I've made sure that we have issues to track the remaining work, so I am going to close this issue now so we don't have to kick this issue forward with every sprint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant