Skip to content

Commit

Permalink
Uptime 7.7 docs (#62228) (#63770)
Browse files Browse the repository at this point in the history
Add docs for 7.7 features:

- Alerting
- Duration anomalies
- Settings

Point security docs to heartbeat.
  • Loading branch information
andrewvc committed Apr 21, 2020
1 parent b0d7c8c commit e4fa2ce
Show file tree
Hide file tree
Showing 16 changed files with 63 additions and 85 deletions.
2 changes: 1 addition & 1 deletion docs/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For more {kib} configuration settings, see <<settings>>.
[role="exclude",id="uptime-security"]
== Uptime security

This page has moved. Please see the new section in the {uptime-guide}/uptime-security.html[Uptime Monitoring Guide].
This page has moved. Please see the new section in the {heartbeat-ref}/securing-heartbeat.html[Uptime Monitoring Guide].

[role="exclude",id="infra-read-only-access"]
== Configure source read-only access
Expand Down
1 change: 0 additions & 1 deletion docs/uptime-guide/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ include::install.asciidoc[]

include::deployment-arch.asciidoc[]

include::security.asciidoc[]
5 changes: 5 additions & 0 deletions docs/uptime-guide/install.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ Additional information is available in {heartbeat-ref}/heartbeat-configuration.h
[role="screenshot"]
image::images/uptime-setup.png[Installation instructions on the Uptime page in Kibana]

[[setup-security]]
=== Step 4: Setup Security

Secure your installation by following the {heartbeat-ref}/securing-heartbeat.html[Secure Heartbeat] documentation.

[float]
==== Important considerations

Expand Down
60 changes: 0 additions & 60 deletions docs/uptime-guide/security.asciidoc

This file was deleted.

Binary file added docs/uptime/images/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.
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 removed docs/uptime/images/error-list.png
Binary file not shown.
Binary file modified docs/uptime/images/monitor-charts.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/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 added 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.
2 changes: 2 additions & 0 deletions docs/uptime/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ To get started with Elastic Uptime, refer to {uptime-guide}/install-uptime.html[

* <<uptime-overview>>
* <<uptime-monitor>>
* <<uptime-settings>>

--

include::overview.asciidoc[]
include::monitor.asciidoc[]
include::settings.asciidoc[]
25 changes: 15 additions & 10 deletions docs/uptime/monitor.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,24 @@
The Monitor page will help you get further insight into the performance
of a specific network endpoint. You'll see a detailed visualization of
the monitor's request duration over time, as well as the `up`/`down`
status over time.
status over time. You can also also detect anomalies in response time data
by configuring Machine Learning jobs on this page.

[float]
=== Status bar
=== Status panel

[role="screenshot"]
image::uptime/images/status-bar.png[Status bar]

The Status bar displays a quick summary of the latest information
The Status panel displays a quick summary of the latest information
regarding your monitor. You can view its latest status, click a link to
visit the targeted URL, see its most recent request duration, and determine the
amount of time that has elapsed since the last check.

You can use the Status bar to get a quick summary of current performance,
beyond simply knowing if the monitor is `up` or `down`.
When two Heartbeat instances are configured in different geographic locations
the map will show each location as a pinpoint on the map, along with the
amount of time elapsed since data was last received from that location.


[float]
=== Monitor charts
Expand All @@ -32,12 +35,14 @@ date range. These charts can help you gain insight into how quickly requests are
by the targeted endpoint, and give you a sense of how frequently a host or endpoint
was down in your selected timespan.

The first chart displays request duration information for your monitor.
The Monitor duration chart displays request duration information for your monitor.
The area surrounding the line is the range of request time for the corresponding
bucket. The line is the average time.
bucket. The line is the average time. Anomaly detection using Machine Learning
can be configured in the upper right hand of this panel. When response times change
in an unexpected way the time range in which they occurred will be given filled with a color.

Next, is a graphical representation of the check statuses over time. Hover over
the charts to display crosshairs with more specific numeric data.
The pings over time chart is a graphical representation of the check statuses over time.
Hover over the charts to display crosshairs with more specific numeric data.

[role="screenshot"]
image::uptime/images/crosshair-example.png[Chart crosshair]
Expand All @@ -49,6 +54,6 @@ image::uptime/images/crosshair-example.png[Chart crosshair]
image::uptime/images/check-history.png[Check history view]

The Check history displays the total count of this monitor's checks for the selected
date range. You can additionally filter the checks by `status` to help find recent problems
date range. You can additionally filter the checks by status and location to help find recent problems
on a per-check basis. This table can help you gain some insight into more granular details
about recent individual data points Heartbeat is logging about your host or endpoint.
26 changes: 13 additions & 13 deletions docs/uptime/overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ This control allows you to use automated filter options, as well as input custom
text to select specific monitors by field, URL, ID, and other attributes.

[float]
=== Snapshot view
=== Snapshot panel

[role="screenshot"]
image::uptime/images/snapshot-view.png[Snapshot view]

This view is intended to quickly give you a sense of the overall
This panel is intended to quickly give you a sense of the overall
status of the environment you're monitoring, or a subset of those monitors.
Here, you can see the total number of detected monitors within the selected
Uptime date range. In addition to the total, the counts for the number of monitors
Expand All @@ -49,6 +49,17 @@ 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 All @@ -60,14 +71,3 @@ Docker related host information, it will provide links to open the Metrics app o
for this host. Additionally, this feature supplies links to simply filter the other views on the host's
IP address, to help you quickly determine if these other solutions contain data relevant to your current
interest.

[float]
=== Error list

[role="screenshot"]
image::uptime/images/error-list.png[Error list]

The Error list displays aggregations of errors that Heartbeat has logged. Errors are
displayed by Error type, monitor ID, and message. Clicking a monitor's ID will take you
to the corresponding Monitor view, which can provide you richer information about the individual
data points that are resulting in the displayed errors.
27 changes: 27 additions & 0 deletions docs/uptime/settings.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[role="xpack"]
[[uptime-settings]]

== Settings

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

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.
Uptime settings apply to the current space only. Use different settings in different
spaces to segment different uptime use cases and domains.

As an example, imagine your organization has one team for internal IT services, and another
for public services. Each team operates independently and is only responsible for its
own services. In this scenario, you might set up separate Heartbeat instances for each team,
writing out to index patterns named `it-heartbeat-\*`, and `external-heartbeat-\*`. You would
create separate roles and users for each in Elasticsearch, each with access to their own spaces,
named `it` and `external` respectively. Within each space you would navigate to the settings page
and set the correct index pattern to match only the indices that space is allowed to access.

Note that the pattern set here only restricts what the Uptime app shows. Users may still be able
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.

0 comments on commit e4fa2ce

Please sign in to comment.