mirror of
https://github.com/elastic/kibana.git
synced 2025-04-22 17:04:01 -04:00
[docs][uptime] Add Uptime Monitoring Guide (#40566)
* docs: uptime guide first draft * docs: uptime guide updates * docs: clean up duplication * docs: nits * temporarily remove link from kib to uptime * reviewer feedback * change from getting started to install
This commit is contained in:
parent
19abe936d2
commit
9903d2e772
8 changed files with 116 additions and 19 deletions
|
@ -19,3 +19,8 @@ See <<monitoring-kibana>>.
|
||||||
include::{asciidoc-dir}/../../shared/settings.asciidoc[]
|
include::{asciidoc-dir}/../../shared/settings.asciidoc[]
|
||||||
|
|
||||||
For more {kib} configuration settings, see <<settings>>.
|
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].
|
||||||
|
|
BIN
docs/uptime-guide/images/uptime-setup.png
Normal file
BIN
docs/uptime-guide/images/uptime-setup.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 402 KiB |
12
docs/uptime-guide/index.asciidoc
Normal file
12
docs/uptime-guide/index.asciidoc
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
[[uptime-guide]]
|
||||||
|
= Uptime monitoring guide
|
||||||
|
|
||||||
|
include::versions.asciidoc[]
|
||||||
|
|
||||||
|
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
|
||||||
|
|
||||||
|
include::overview.asciidoc[]
|
||||||
|
|
||||||
|
include::install.asciidoc[]
|
||||||
|
|
||||||
|
include::security.asciidoc[]
|
69
docs/uptime-guide/install.asciidoc
Normal file
69
docs/uptime-guide/install.asciidoc
Normal file
|
@ -0,0 +1,69 @@
|
||||||
|
[[install-uptime]]
|
||||||
|
== Install Uptime
|
||||||
|
|
||||||
|
The easiest way to get started with Elastic Uptime is by using our hosted {es} Service on Elastic Cloud.
|
||||||
|
The {es} Service is available on both AWS and GCP,
|
||||||
|
and automatically configures {es} and {kib}.
|
||||||
|
|
||||||
|
[float]
|
||||||
|
=== Hosted Elasticsearch Service
|
||||||
|
|
||||||
|
Skip managing your own {es} and {kib} instance by using our
|
||||||
|
https://www.elastic.co/cloud/elasticsearch-service[hosted {es} Service] on
|
||||||
|
Elastic Cloud.
|
||||||
|
|
||||||
|
https://www.elastic.co/cloud/elasticsearch-service/signup[Try out the {es} Service for free],
|
||||||
|
then jump straight to <<install-heartbeat>>.
|
||||||
|
|
||||||
|
[float]
|
||||||
|
[[before-installation]]
|
||||||
|
=== Install the stack yourself
|
||||||
|
|
||||||
|
If you'd rather install the stack yourself,
|
||||||
|
first see the https://www.elastic.co/support/matrix[Elastic Support Matrix] for information about supported operating systems and product compatibility. Then, follow the steps below.
|
||||||
|
|
||||||
|
* <<install-elasticsearch>>
|
||||||
|
* <<install-kibana>>
|
||||||
|
* <<install-heartbeat>>
|
||||||
|
|
||||||
|
[[install-elasticsearch]]
|
||||||
|
=== Step 1: Install Elasticsearch
|
||||||
|
|
||||||
|
Install an Elasticsearch cluster, start it up, and make sure it's running.
|
||||||
|
|
||||||
|
. Verify that your system meets the
|
||||||
|
https://www.elastic.co/support/matrix#matrix_jvm[minimum JVM requirements] for {es}.
|
||||||
|
. {stack-gs}/get-started-elastic-stack.html#install-elasticsearch[Install Elasticsearch].
|
||||||
|
. {stack-gs}/get-started-elastic-stack.html#_make_sure_elasticsearch_is_up_and_running[Make sure elasticsearch is up and running].
|
||||||
|
|
||||||
|
[[install-kibana]]
|
||||||
|
=== Step 2: Install Kibana
|
||||||
|
|
||||||
|
Install Kibana, start it up, and open up the web interface:
|
||||||
|
|
||||||
|
. {stack-gs}/get-started-elastic-stack.html#install-kibana[Install Kibana].
|
||||||
|
. {stack-gs}/get-started-elastic-stack.html#_launch_the_kibana_web_interface[Launch the Kibana Web Interface].
|
||||||
|
|
||||||
|
[[install-heartbeat]]
|
||||||
|
=== Step 3: Install and configure Heartbeat
|
||||||
|
|
||||||
|
Uptime requires the setup of monitors in Heartbeat.
|
||||||
|
These monitors provide the data you'll be visualizing in the {kibana-ref}/xpack-uptime.html[Uptime UI].
|
||||||
|
|
||||||
|
See the *Setup Instructions* in Kibana for instructions on installing and configuring Heartbeat.
|
||||||
|
Additional information is available in {heartbeat-ref}/heartbeat-configuration.html[Configure Heartbeat].
|
||||||
|
|
||||||
|
[role="screenshot"]
|
||||||
|
image::images/uptime-setup.png[Installation instructions on the Uptime page in Kibana]
|
||||||
|
|
||||||
|
[float]
|
||||||
|
==== Important considerations
|
||||||
|
|
||||||
|
* Make sure you're using the same major versions of Heartbeat and Kibana.
|
||||||
|
|
||||||
|
* Index patterns tell Kibana which Elasticsearch indices you want to explore.
|
||||||
|
The Uptime UI requires a +heartbeat-{short-version}*+ index pattern.
|
||||||
|
If you have configured a different index pattern, you can use {ref}/indices-aliases.html[field aliases] to ensure data is recognized by the UI.
|
||||||
|
|
||||||
|
After you install and configure Heartbeat,
|
||||||
|
the {kibana-ref}/xpack-uptime.html[Uptime UI] will automatically populate with the Heartbeat monitors.
|
11
docs/uptime-guide/overview.asciidoc
Normal file
11
docs/uptime-guide/overview.asciidoc
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
[role="xpack"]
|
||||||
|
[[uptime-overview]]
|
||||||
|
== Overview
|
||||||
|
|
||||||
|
The Elastic Uptime solution built on the Elastic Stack.
|
||||||
|
It allows you to monitor the availability and response time of software services and applications in real time.
|
||||||
|
|
||||||
|
Based on {heartbeat-ref}/index.html[Heartbeat], an open source uptime monitor, Elastic Uptime is transparent,
|
||||||
|
flexible, and developer-friendly.
|
||||||
|
It can be deployed both inside and outside your organization's network to understand service uptime and
|
||||||
|
response time characteristics from multiple network vantage points.
|
|
@ -1,7 +1,5 @@
|
||||||
[role="xpack"]
|
|
||||||
[[uptime-security]]
|
[[uptime-security]]
|
||||||
|
== Elasticsearch Security
|
||||||
== Use with Elasticsearch Security
|
|
||||||
|
|
||||||
If you use Elasticsearch security, you'll need to enable certain privileges for users
|
If you use Elasticsearch security, you'll need to enable certain privileges for users
|
||||||
that would like to access the Uptime app. Below is an example of creating
|
that would like to access the Uptime app. Below is an example of creating
|
||||||
|
@ -70,4 +68,4 @@ PUT /_security/user/jacknich
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
---------------------------------------------------------------
|
---------------------------------------------------------------
|
||||||
// CONSOLE
|
// CONSOLE
|
11
docs/uptime-guide/versions.asciidoc
Normal file
11
docs/uptime-guide/versions.asciidoc
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
// version can be: 7.0.1, 8.0.0-alpha1, etc.
|
||||||
|
// branch can be: master, 8.0, 8.1, etc.
|
||||||
|
// major-version can be: 8.x, 7.x, 6.x, etc.
|
||||||
|
// short-version can be: 8, 7, 6, etc.
|
||||||
|
// release-state is only: released | prerelease | unreleased
|
||||||
|
|
||||||
|
:version: 8.0.0-alpha1
|
||||||
|
:branch: master
|
||||||
|
:major-version: 8.x
|
||||||
|
:short-version: 8
|
||||||
|
:release-state: prerelease
|
|
@ -4,25 +4,16 @@
|
||||||
|
|
||||||
[partintro]
|
[partintro]
|
||||||
--
|
--
|
||||||
Use the Uptime UI to monitor the status of network endpoints via HTTP/S, TCP,
|
Uptime allows you to monitor the status of network endpoints via HTTP/S, TCP, and ICMP.
|
||||||
and ICMP. You will be able to explore status over time, drill into specific monitors,
|
You can explore endpoint status over time, drill down into specific monitors,
|
||||||
and view a high-level snapshot of your environment at a selected point in time.
|
and easily view a high-level snapshot of your environment at any point in time.
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
== Add monitors
|
== Get Started
|
||||||
To get started with Uptime monitoring, you'll need to define some monitors and run Heartbeat.
|
|
||||||
These monitors will provide the data we will be visualizing in the Uptime UI.
|
|
||||||
See {heartbeat-ref}/heartbeat-configuration.html[Configure Heartbeat] for instructions
|
|
||||||
on configuring monitors to begin storing Uptime information in your cluster.
|
|
||||||
|
|
||||||
[float]
|
|
||||||
== Uptime, Heartbeat, and Kibana
|
|
||||||
For Uptime to work, it is important you use the same major versions of Heartbeat and Kibana.
|
|
||||||
For example, version 6.7 of Kibana will expect an index of `heartbeat-6*`,
|
|
||||||
while Kibana 7.0 requires an index of `heartbeat-7*` (containing documents from Heartbeat 7.0).
|
|
||||||
|
|
||||||
|
See the *Setup Instructions* in Kibana for instructions on installing and configuring Heartbeat.
|
||||||
|
// See the {uptime-guide}/getting-started.html[getting started] guide for instructions on getting started with Elastic Uptime.
|
||||||
--
|
--
|
||||||
|
|
||||||
include::overview.asciidoc[]
|
include::overview.asciidoc[]
|
||||||
include::monitor.asciidoc[]
|
include::monitor.asciidoc[]
|
||||||
include::security.asciidoc[]
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue