Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
26 changes: 26 additions & 0 deletions docs/uptime/alerting.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[role="xpack"]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

When I view the documentation preview for this page, I'm presented with two images without any context: http://kibana_66118.docs-preview.app.elstc.co/guide/en/kibana/7.8/uptime-alerting.html

I think we should move the paragraphs (context) above each of the screenshots.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Changed this in f0a0de9.

[[uptime-alerting]]

== Uptime alerting

Comment on lines +4 to +5

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should we add an alerting overview here? Something like:

The Uptime app integrates with Kibana's {kibana-ref}/alerting-getting-started.html[alerting and actions] feature. It provides a set of built-in actions and Uptime specific threshold alerts for you to use
and enables central management of all alerts from <<management,Kibana Management>>.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated in 0495751.

[float]
=== Monitor status alerts

[role="screenshot"]
image::uptime/images/monitor-status-alert-flyout.png[Create monitor status alert flyout]

To receive alerts when a monitor goes down, use the alerting menu at the top of the
overview page. Use a query in the alert flyout to determine which monitors to check
with your alert. If you already have a query in the overview page search bar it will
be carried over into this box.

[float]
=== TLS alerts

[role="screenshot"]
image::uptime/images/tls-alert-flyout.png[Create TLS alert flyout]

Uptime also provides the ability to create an alert that will notify you when one or
more of your monitors have a TLS certificate that will expire within some threshold,
or when its age exceeds a limit. The values for these thresholds are configurable on
the <<uptime-settings, Settings page>>.
15 changes: 15 additions & 0 deletions docs/uptime/certificates.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[role="xpack"]
[[uptime-certificates]]

== Certificates

[role="screenshot"]
image::uptime/images/certificates-page.png[Certificates]

Uptime has a certificates page, which will visualize all of the TLS certificates Heartbeat

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Our docs generally use the active voice ( I can't find a citation, but maybe @bmorelli25 has one?) . This could be written: "Use the certificates page to visualize all of your TLS certificates..."

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The Elastic guide to writing style talks about active voice.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Please have a look at 24ff319 where I've tried to prefer active voice as much as I could. I also tried to simplify a large chunk of the copy I had added.

is monitoring in your indices. In addition to the common name, associated monitors, issuer
information, and SHA fingerprints, Uptime will also assign a status based on the values stored
in the <<uptime-settings, Settings page>>.

Several of the columns on this page are sortable, and the search bar at the top of the view
allows you to search on most of the TLS-related fields in your Uptime indices. Additionally, the `Alerts` dropdown at the top of the page will allow you to define a TLS alert.
Binary file removed docs/uptime/images/alert-flyout.png
Binary file not shown.
Binary file added docs/uptime/images/certificates-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/uptime/images/check-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/uptime/images/crosshair-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/uptime/images/filter-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/uptime/images/monitor-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/uptime/images/observability_integrations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/uptime/images/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/uptime/images/snapshot-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/uptime/images/status-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/uptime/images/tls-alert-flyout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/uptime/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@ To get started with Elastic Uptime, refer to {uptime-guide}/install-uptime.html[
* <<uptime-overview>>
* <<uptime-monitor>>
* <<uptime-settings>>
* <<uptime-certificates>>
* <<uptime-alerting>>

--

include::overview.asciidoc[]
include::monitor.asciidoc[]
include::settings.asciidoc[]
include::certificates.asciidoc[]
include::alerting.asciidoc[]
11 changes: 0 additions & 11 deletions docs/uptime/overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,6 @@ way to navigate to a more in-depth visualization for interesting hosts or endpoi
This table includes information like the most recent status, when the monitor was last checked, its
ID and URL, its IP address, and a dedicated sparkline showing its check status over time.

[float]
=== Creating and managing alerts

[role="screenshot"]
image::uptime/images/alert-flyout.png[Create alert flyout]

To receive alerts when a monitor goes down, use the alerting menu at the top of the
overview page. Use a query in the alert flyout to determine which monitors to check
with your alert. If you already have a query in the overview page search bar it will
be carried over into this box.

[float]
=== Observability integrations

Expand Down
21 changes: 20 additions & 1 deletion docs/uptime/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
== Settings

[role="screenshot"]
image::uptime/images/settings.png[Filter bar]
image::uptime/images/settings.png[Settings page]

=== Indices

The Uptime settings page lets you change which Heartbeat indices are displayed
by the uptime app. Users must have the 'all' permission to modify items on this page.
Expand All @@ -25,3 +27,20 @@ to manually query Elasticsearch for data outside this pattern!
See the <<uptime-security,Uptime Elasticsearch Security>>
and {heartbeat-ref}/securing-heartbeat.html[Heartbeat security]
docs for more information.

=== Certificate thresholds

The settings page also allows you to specify thresholds for all the TLS certificates monitored

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Active voice: "Specify thresholds for all TLS certificates on the settings page"

in your environment. There is a field for maximum age, and the minimum number of days before

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think we need to be this descriptive, that part of the app is self explanatory. IMHO we shouldn't document the obvious. Would like @bmorelli25 's thoughts here.

Perhaps the content would be better if it described what the fields vs. documenting their existence. Rephrasing this as: "Use the certificate maximum age field to control the number of days before expiration Uptime should display the certificate as being in a warning state. Warnings for maximum certificate age can also be set here. Some user agents and browsers consider certificates invalid after a certain amount of time.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Agreed. But looking at the screenshot, I only see "Expiration threshold" and "Age limit" as options. The docs should match those names. I'd alter Andrew's recommendation to something like this:

The settings page also allows you to specify thresholds for displaying and alerting on TLS certificates. Use the expiration threshold to specify <>, and the age limit field to control the <>. Some user agents and browsers consider certificates invalid after a certain amount of time.

expiration before Uptime should consider a monitor to be in warning state.

For example, you may want to make sure that none of your organization's TLS certificates have been
valid for longer than one year. This is becoming a common security requirement. Modifying the `Age limit`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
For example, you may want to make sure that none of your organization's TLS certificates have been
valid for longer than one year. This is becoming a common security requirement. Modifying the `Age limit`
For example, a common security requirement is to make sure that none of your organization's TLS certificates have been valid for longer than one year. Modifying the `Age limit`

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated in 4a63705.

field's value to 365 days will help you keep track of which certificates you may want to refresh.

Likewise, if you want to see which of your TLS certificates are close to expiring ahead of time, specify
an `Expiration threshold` on this page. When the count of a certificate's remaining valid days falls
below this threshold, Uptime will consider it in a warning state.

The thresholds specified on this page affect how your certificates are visualized on the Certificates page,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This could be moved up IMHO to make the importance more clear.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, this should be in the first paragraph

and which certificates Uptime will warn about when running a TLS alert.