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

[synthetics] Update monitor status rule docs #4345

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Oct 3, 2024

Description

The Synthetics monitor status rule type was improved in elastic/kibana#186585. This PR makes a few updates to the Create a monitor status rule doc including:

  • Marking the Uptime rule as deprecated and making it clear that the Synthetics rule is the right choice moving forward.
  • Fully documenting the Synthetics monitor status rule type with details on the available filters, conditions, action types, and action variables.
  • Documenting how users who have an existing Uptime rule that they are using for their Synthetics monitors can replace the Uptime rule with the Synthetics rule.
    • @shahzad31 @paulb-elastic I'm not sure if this section (preview) is what you had in mind. I'm not sure there's a 1:1 comparison for everything included in the Uptime rule unless I'm misunderstanding. For example, I don't think you can recreate the Uptime rule's availability condition exactly using the new Synthetics rule conditions (would you use a synthetics SLI instead?). Let me know if I'm missing something or if there's a different way we should approach this.

Note: I documented the Uptime and Synthetics rules on the same page titled "Create a monitor status rule" because the "Alerts and rules" dropdown in both the Uptime app and Synthetics UI uses the language "Monitor status rule", but I could be persuaded to document them separately. Either way, starting in 9.0.0, I imagine the Uptime content on this page will go away.

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 #4164
Closes #4337

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 needs-dev-review labels Oct 3, 2024
@colleenmcginnis colleenmcginnis self-assigned this Oct 3, 2024
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner October 3, 2024 18:40
Copy link
Contributor

github-actions bot commented Oct 3, 2024

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.

@paulb-elastic
Copy link
Contributor

I've not had a chance to look through this fully, but a couple of comments:

starting in 9.0.0, I imagine the Uptime content on this page will go away

Uptime is not being removed now in 9.0.0. It's still deprecated, but won't be removed until a later date (the release note was updated recently to reflect that change).

This deprecated content: whilst it's true that Uptime is deprecated (and as such, the corresponding rule), is this section clear that Uptime is deprecated and the suggestion is to use Synthetics as a whole solution (specifically, is there a chance it could be misread and people think they should use the Synthetics rule if still using Uptime)?

@shahzad31
Copy link
Contributor

In PR preview, Monitor status rule still leads me to Uptime monitor status rule docs , i will recommend replacing that link with synthetics status alert !!

image

@shahzad31
Copy link
Contributor

@colleenmcginnis we don't allow know creating availability alert from status rules, it doesn't make sense as far as i can understand. if you want you can mention Synthetics Availability SLI indicator, that's more suited for that kind of scenerio, where user want to get alerted on availability. So user looking for availability alert can learn about Synthetics Availability SLI indicator.

@colleenmcginnis
Copy link
Contributor Author

colleenmcginnis commented Oct 16, 2024

In PR preview, Monitor status rule still leads me to Uptime monitor status rule docs , i will recommend replacing that link with synthetics status alert !!

You'll need to look at this link (master instead of current): https://observability-docs_bk_4345.docs-preview.app.elstc.co/guide/en/observability/master/monitor-status-alert.html. (Then we can backport to publish to other branches.)

shahzad31
shahzad31 previously approved these changes Oct 16, 2024
Copy link
Contributor

@shahzad31 shahzad31 left a comment

Choose a reason for hiding this comment

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

LGTM , other than if we want to leave a comment about availability condition being replaced with Synthetics Availability SLI !!

Comment on lines +141 to +149
[WARNING]
====
*The Uptime app and the Uptime monitor status rule are deprecated as of version 8.15.0.*

If you are using the Uptime monitor status rule with the Uptime app, you should migrate the Uptime monitor and the Uptime monitor status rule to Elastic Synthetics and the Synthetics monitor rule.

If you are using the Uptime monitor status rule with a monitor created with Elastic Synthetics, you should migrate the Uptime monitor status rule to the Synthetics monitor rule.
Learn how in <<migrate-monitor-rule>>.
====
Copy link
Member

Choose a reason for hiding this comment

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

Did you mean to duplicate this on this page?

Comment on lines +293 to +296
// Not sure if this is actually helpful AND not sure if there are equivalents for
// availability checks

Copy link
Member

Choose a reason for hiding this comment

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

@\reviewers it looks like there's still a question to be answered here

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 needs-dev-review needs-writer-review
Projects
None yet
4 participants