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.

Sign up for GitHub

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

Jump to bottom

[synthetics] Incorporate lightweight monitors more thoroughly into docs #2073

Closed
wants to merge 2 commits into from
Closed

[synthetics] Incorporate lightweight monitors more thoroughly into docs #2073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b979d45
add lighweight equivalent, update vocab
colleenmcginnis Aug 9, 2022
6766b6a
catch up to main
colleenmcginnis Aug 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/en/observability/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ include::uptime-set-up-heartbeat.asciidoc[leveloffset=+3]

include::uptime-set-up-app.asciidoc[leveloffset=+3]

include::uptime-lightweight-monitors.asciidoc[leveloffset=+2]

include::synthetics-journeys.asciidoc[leveloffset=+2]

include::synthetics-create-test.asciidoc[leveloffset=+3]
Expand All @@ -114,10 +116,10 @@ include::synthetics-manage-monitors.asciidoc[leveloffset=+3]

include::synthetics-command-reference.asciidoc[leveloffset=+3]

include::synthetics-params-secrets.asciidoc[leveloffset=+3]

include::synthetics-configuration.asciidoc[leveloffset=+3]

include::synthetics-params-secrets.asciidoc[leveloffset=+3]

include::synthetics-recorder.asciidoc[leveloffset=+3]

include::synthetics-visualize.asciidoc[leveloffset=+3]
Expand Down
6 changes: 1 addition & 5 deletions docs/en/observability/synthetics-command-reference.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
[[synthetics-command-reference]]
= Synthetics command reference

++++
<titleabbrev>Command reference</titleabbrev>
++++
= Elastic Synthetics command reference

beta[]

Expand Down
6 changes: 1 addition & 5 deletions docs/en/observability/synthetics-configuration.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
[[synthetics-configuration]]
= Synthetic tests configuration

++++
<titleabbrev>Synthetic tests configuration</titleabbrev>
++++
= Elastic Synthetics configuration

:synthetics_version: v1.0.0-beta.31

Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/synthetics-journeys.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[synthetics-journeys]]
= Use synthetic monitors
= Use browser monitors

beta[]

Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/synthetics-manage-monitors.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[synthetics-manage-monitors]]
= Manage synthetic monitors
= Manage browser monitors

beta[]

Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/synthetics-run-test.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[synthetic-run-tests]]
= Create a synthetic monitor
= Create a browser monitor

beta[]

Expand Down
4 changes: 2 additions & 2 deletions docs/en/observability/synthetics-visualize.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[[synthetics-visualize]]
= Visualize synthetic monitoring
= Visualize results from browser monitors

++++
<titleabbrev>Visualize</titleabbrev>
<titleabbrev>Visualize browser monitors</titleabbrev>
++++

beta[]
Expand Down
35 changes: 35 additions & 0 deletions docs/en/observability/uptime-lightweight-monitors.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[[uptime-lightweight-monitors]]
= Use lightweight monitors

// What do we want to say about lightweight monitors?
Copy link
Contributor

Choose a reason for hiding this comment

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

IMO the main difference between these and browser monitors is that there isn't a browser environment that needs to be spun-up. Therefore, these are usually quicker.


In the {uptime-app}, you can monitor the status of network endpoints using the following lightweight checks:

// lint ignore v4 v6
|===
| *HTTP monitor* | Monitor your website. The HTTP monitor checks to make sure specific endpoints return the correct
status code and display the correct text.
| *ICMP monitor* | Check the availability of your hosts. The ICMP monitor uses ICMP (v4 and v6) Echo
Requests to check the network reachability of the hosts you are pinging. This will tell you whether the
host is available and connected to the network, but doesn't tell you if a service on the host is running or
not.
| *TCP monitor* | Monitor the services running on your hosts. The TCP monitor checks individual ports
to make sure the service is accessible and running.
|===

// diagram similar to https://www.elastic.co/guide/en/observability/current/synthetics-journeys.html ?

[discrete]
== Configure a monitor

// List all options?
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there will be plenty of common options for us to list together, so perhaps we could start with the "common required options", then move on to the options that are specific for each monitor, and then list "common options" (the remaining non-required ones).


[discrete]
== Create a monitor

// Options are available in the set up guide
Comment on lines +28 to +30
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't this section a bit redundant considering the previous "configure a monitor" section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apologies -- meant to be the lightweight equivalent of Create a browser monitor, but if there's not enough to say specifically for lightweight monitors (like there is for browser monitors) then we can remove it.


[discrete]
== Manage monitors

// How to
Comment on lines +33 to +35
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure I understand what you mean by manage. Is it editing and deleting them? Or is it managing the results (i.e. viewing results and debugging)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Meant to be the lightweight equivalent of Manage browser monitors, but if there's not enough to say specifically for lightweight monitors (like there is for browser monitors) then we can remove it.

2 changes: 1 addition & 1 deletion docs/en/observability/uptime-set-up.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[uptime-set-up]]
= Set up monitors
= Set up your first monitor

To set up an uptime monitor, you need to configure the monitor, run it, and send data back to {es}.
After setup is complete, the data will be available in the {uptime-app} in {kib} to view, analyze, and alert on.
Expand Down