[synthetics] Update monitor status rule docs #4345

colleenmcginnis · 2024-10-03T18:40:51Z

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>

github-actions · 2024-10-03T18:41:03Z

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

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 · 2024-10-10T11:15:32Z

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 · 2024-10-16T08:46:46Z

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 !!

docs/en/observability/monitor-status-alert.asciidoc

shahzad31 · 2024-10-16T08:50:20Z

@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 · 2024-10-16T12:45:03Z

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

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

bmorelli25 · 2024-10-18T23:51:22Z

docs/en/observability/monitor-status-alert.asciidoc

+[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>>.
+====


Did you mean to duplicate this on this page?

I added the second note after Paul's comment here.

docs/en/observability/monitor-status-alert.asciidoc

shahzad31

LGTM !!

elasticdocs · 2024-10-22T15:27:03Z

🚀 Built elastic-dot-co-docs-preview-docs successfully!

https://elastic-dot-co-docs-production-92ztiveit-elastic-dev.vercel.app
Built with commit ea68830

Issues? Visit #next-docs in Slack

@paulb-elastic

* document synthetics monitor status rule * document how to move from the uptime rule to the synthetics rule * add code comments * address feedback from @paulb-elastic * add info on using slos for availability * add link * delete table * port to serverless (cherry picked from commit 08cf555) # Conflicts: # docs/en/serverless/serverless-observability.docnav.json

@paulb-elastic

* document synthetics monitor status rule * document how to move from the uptime rule to the synthetics rule * add code comments * address feedback from @paulb-elastic * add info on using slos for availability * add link * delete table * port to serverless (cherry picked from commit 08cf555) # Conflicts: # docs/en/serverless/serverless-observability.docnav.json

@paulb-elastic

…4423) * [synthetics] Update monitor status rule docs (#4345) * document synthetics monitor status rule * document how to move from the uptime rule to the synthetics rule * add code comments * address feedback from @paulb-elastic * add info on using slos for availability * add link * delete table * port to serverless (cherry picked from commit 08cf555) # Conflicts: # docs/en/serverless/serverless-observability.docnav.json * Delete docs/en/serverless directory --------- Co-authored-by: Colleen McGinnis <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

@paulb-elastic

…4424) * [synthetics] Update monitor status rule docs (#4345) * document synthetics monitor status rule * document how to move from the uptime rule to the synthetics rule * add code comments * address feedback from @paulb-elastic * add info on using slos for availability * add link * delete table * port to serverless (cherry picked from commit 08cf555) # Conflicts: # docs/en/serverless/serverless-observability.docnav.json * Delete docs/en/serverless directory --------- Co-authored-by: Colleen McGinnis <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

@paulb-elastic

* document synthetics monitor status rule * document how to move from the uptime rule to the synthetics rule * add code comments * address feedback from @paulb-elastic * add info on using slos for availability * add link * delete table * port to serverless

colleenmcginnis added 3 commits October 3, 2024 11:54

document synthetics monitor status rule

fa192ee

document how to move from the uptime rule to the synthetics rule

46055c1

add code comments

fbe6a38

colleenmcginnis added backport-8.x Automated backport to the 8.x branch with mergify needs-dev-review labels Oct 3, 2024

colleenmcginnis requested a review from shahzad31 October 3, 2024 18:40

colleenmcginnis self-assigned this Oct 3, 2024

colleenmcginnis requested a review from a team as a code owner October 3, 2024 18:40

docs-project-automation bot added the needs-writer-review label Oct 3, 2024

colleenmcginnis added 2 commits October 10, 2024 12:58

Merge branch 'main' into issue-4164

470e1d2

address feedback from @paulb-elastic

33fa303

shahzad31 reviewed Oct 16, 2024

View reviewed changes

docs/en/observability/monitor-status-alert.asciidoc Show resolved Hide resolved

shahzad31 previously approved these changes Oct 16, 2024

View reviewed changes

colleenmcginnis added 2 commits October 16, 2024 16:29

Merge branch 'main' into issue-4164

3eff35d

add info on using slos for availability

795c241

colleenmcginnis dismissed shahzad31’s stale review via 795c241 October 16, 2024 22:12

add link

792b424

bmorelli25 reviewed Oct 18, 2024

View reviewed changes

docs/en/observability/monitor-status-alert.asciidoc Outdated Show resolved Hide resolved

colleenmcginnis requested review from shahzad31 and bmorelli25 October 22, 2024 14:49

colleenmcginnis added 2 commits October 22, 2024 09:59

Merge branch 'main' into issue-4164

c73155e

delete table

8443dc7

shahzad31 previously approved these changes Oct 22, 2024

View reviewed changes

port to serverless

ea68830

colleenmcginnis dismissed shahzad31’s stale review via ea68830 October 22, 2024 15:20

colleenmcginnis added the ci:doc-build label Oct 22, 2024

colleenmcginnis removed the needs-dev-review label Oct 22, 2024

colleenmcginnis requested a review from a team October 22, 2024 16:21

bmorelli25 approved these changes Oct 22, 2024

View reviewed changes

bmorelli25 added backport-8.16 Automated backport with mergify and removed needs-writer-review labels Oct 22, 2024

colleenmcginnis merged commit 08cf555 into elastic:main Oct 23, 2024
13 checks passed

colleenmcginnis deleted the issue-4164 branch October 23, 2024 13:07

This was referenced Oct 23, 2024

[8.x](backport #4345) [synthetics] Update monitor status rule docs #4423

Merged

[8.16](backport #4345) [synthetics] Update monitor status rule docs #4424

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[synthetics] Update monitor status rule docs #4345

[synthetics] Update monitor status rule docs #4345

colleenmcginnis commented Oct 3, 2024 •

edited

Loading

github-actions bot commented Oct 3, 2024

paulb-elastic commented Oct 10, 2024

shahzad31 commented Oct 16, 2024

shahzad31 commented Oct 16, 2024

colleenmcginnis commented Oct 16, 2024 •

edited

Loading

shahzad31 left a comment

bmorelli25 Oct 18, 2024

colleenmcginnis Oct 22, 2024

shahzad31 left a comment

elasticdocs commented Oct 22, 2024 •

edited

Loading

[synthetics] Update monitor status rule docs #4345

[synthetics] Update monitor status rule docs #4345

Conversation

colleenmcginnis commented Oct 3, 2024 • edited Loading

Description

Documentation sets edited in this PR

Related issue

Checklist

Follow-up tasks

github-actions bot commented Oct 3, 2024

paulb-elastic commented Oct 10, 2024

shahzad31 commented Oct 16, 2024

shahzad31 commented Oct 16, 2024

colleenmcginnis commented Oct 16, 2024 • edited Loading

shahzad31 left a comment

Choose a reason for hiding this comment

bmorelli25 Oct 18, 2024

Choose a reason for hiding this comment

colleenmcginnis Oct 22, 2024

Choose a reason for hiding this comment

shahzad31 left a comment

Choose a reason for hiding this comment

elasticdocs commented Oct 22, 2024 • edited Loading

colleenmcginnis commented Oct 3, 2024 •

edited

Loading

colleenmcginnis commented Oct 16, 2024 •

edited

Loading

elasticdocs commented Oct 22, 2024 •

edited

Loading