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

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

[float]
=== Monitor status alerts

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.

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

[float]
=== TLS alerts

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

[role="screenshot"]
image::uptime/images/tls-alert-flyout.png[Create TLS alert flyout]
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]

The certificates page allows you to visualize TLS certificate data in your indices. In addition to the
common name, associated monitors, issuer information, and SHA fingerprints, Uptime also assigns a status
derived from the threshold values in the <<uptime-settings, Settings page>>.

Several of the columns on this page are sortable. You can use the search bar at the top of the view
to find values in most of the TLS-related fields in your Uptime indices. Additionally, you can
create a TLS alert using the `Alerts` dropdown at the top of the page.
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
23 changes: 22 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,22 @@ 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

You can modify settings in this section to control how Uptime will visualize your TLS values in the Certificates page.
These settings also determine which certificates will be selected by any TLS alert you define.

There are two fields, `age` and `expiration`. Use the `age` threshold to specify when Uptime should warn
you about certificates that have been valid for too long. Use the `expiration` threshold to make Uptime warn you
about certificates that have approaching expiration dates.

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` field's value to 365 days will help you keep track of which
certificates you may want to refresh.

Likewise, 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. If you have defined a TLS alert, you will
receive a notification from Uptime about the certificate.