kibana/docs/uptime/overview.asciidoc
Andrew Cholakian 6652045cbf
Uptime 7.7 docs (#62228)
Add docs for 7.7 features:

- Alerting
- Duration anomalies
- Settings

Point security docs to heartbeat.
2020-04-16 15:38:57 -05:00

74 lines
2.8 KiB
Plaintext

[role="xpack"]
[[uptime-overview]]
== Overview
The Uptime overview is intended to help you quickly identify and diagnose outages and
other connectivity issues within your network or environment. There is a date range
selection that is global to the Uptime UI; you can use this selection to highlight
an absolute date range, or a relative one, similar to other areas of Kibana.
[float]
=== Filter bar
[role="screenshot"]
image::uptime/images/filter-bar.png[Filter bar]
The filter bar is designed to let you quickly view specific groups of monitors, or even
an individual monitor, if you have defined many.
This control allows you to use automated filter options, as well as input custom filter
text to select specific monitors by field, URL, ID, and other attributes.
[float]
=== Snapshot panel
[role="screenshot"]
image::uptime/images/snapshot-view.png[Snapshot view]
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
in an `up` or `down` state are displayed, based on the last check reported by Heartbeat
for each monitor.
Next to the counts, there is a histogram displaying the change over time throughout the
selected date range.
[float]
=== Monitor list
[role="screenshot"]
image::uptime/images/monitor-list.png[Monitor list]
The Monitor list displays information at the level of individual monitors.
The data shown here will flesh out your individual monitors, and provide a quick
way to navigate to a more in-depth visualization for interesting hosts or endpoints.
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
[role="screenshot"]
image::uptime/images/observability_integrations.png[Observability integrations]
The Monitor list also contains a menu of possible integrations. If Uptime detects Kubernetes or
Docker related host information, it will provide links to open the Metrics app or Logs app pre-filtered
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.