2019-07-12 18:02:58 +02:00
[[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.
2020-02-26 20:45:22 +01:00
{ess-trial}[Try out the {es} Service for free],
2019-07-12 18:02:58 +02:00
then jump straight to <<install-heartbeat>>.
[float]
[[before-installation]]
=== Install the stack yourself
If you'd rather install the stack yourself,
2020-03-16 15:58:16 +01:00
first see the https://www.elastic.co/support/matrix[Elastic Support Matrix] for information about supported operating systems and product compatibility.
2019-07-12 18:02:58 +02:00
* <<install-elasticsearch>>
* <<install-kibana>>
* <<install-heartbeat>>
[[install-elasticsearch]]
=== Step 1: Install Elasticsearch
2020-06-04 16:58:58 +02:00
Install an {es} cluster, start it up, and make sure it's running.
2019-07-12 18:02:58 +02:00
. 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
2020-06-04 16:58:58 +02:00
Install {kib}, start it up, and open up the web interface:
2019-07-12 18:02:58 +02:00
. {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.
2020-06-04 16:58:58 +02:00
These monitors provide the data you'll be visualizing in the {kibana-ref}/xpack-uptime.html[Uptime app].
2019-07-12 18:02:58 +02:00
2020-06-04 16:58:58 +02:00
For instructions on installing and configuring Heartbeat, see the *Setup Instructions* in {kib}.
2019-07-12 18:02:58 +02:00
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]
2020-04-16 22:38:57 +02:00
[[setup-security]]
2020-06-04 16:58:58 +02:00
=== Step 4: Set up Security
2020-04-16 22:38:57 +02:00
Secure your installation by following the {heartbeat-ref}/securing-heartbeat.html[Secure Heartbeat] documentation.
2019-07-12 18:02:58 +02:00
[float]
==== Important considerations
2020-06-04 16:58:58 +02:00
* Make sure you're using the same major versions of Heartbeat and {kib}.
2019-07-12 18:02:58 +02:00
2020-06-04 16:58:58 +02:00
* Index patterns tell {kib} which {es} indices you want to explore.
The Uptime app requires a +heartbeat-{major-version-only}*+ index pattern.
If you have configured a different index pattern, you can use {ref}/indices-aliases.html[index aliases] to ensure data is recognized by the Uptime app.
2019-07-12 18:02:58 +02:00
After you install and configure Heartbeat,
2020-06-04 16:58:58 +02:00
the {kibana-ref}/xpack-uptime.html[Uptime app] is automatically populated with the Heartbeat monitors.