45d2c84826
* Add first draft of uptime docs. * Add first draft of uptime docs. * Implement PR feedback. * Add role info to uptime docs * Impelement some more PR feedback. * Attempt to add more copy focusing on the 'why' of each piece of the docs. * uptime docs: grammar, formatting, order * move location of uptime docs * Implement more PR feedback. * Add screenshots.
55 lines
2 KiB
Plaintext
55 lines
2 KiB
Plaintext
[role="xpack"]
|
|
[[uptime-monitor]]
|
|
== Monitor
|
|
|
|
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.
|
|
|
|
[float]
|
|
=== Status bar
|
|
|
|
[role="screenshot"]
|
|
image::uptime/images/status-bar.png[Status bar]
|
|
|
|
The Status bar 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`.
|
|
|
|
[float]
|
|
=== Monitor charts
|
|
|
|
[role="screenshot"]
|
|
image::uptime/images/monitor-charts.png[Monitor charts]
|
|
|
|
The Monitor charts visualize information over the time specified in the
|
|
date range. These charts can help you gain insight into how quickly requests are being resolved
|
|
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 area surrounding the line is the range of request time for the corresponding
|
|
bucket. The line is the average time.
|
|
|
|
Next, 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]
|
|
|
|
[float]
|
|
=== Check history
|
|
|
|
[role="screenshot"]
|
|
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
|
|
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.
|