Skip to content

Commit

Permalink
Add add_observer_metadata geo.name to Quickstart (#21501) (#21639)
Browse files Browse the repository at this point in the history
* Add `add_observer_metadata` `geo.name` to Quickstart

The observer location is very important in the Uptime app and the out-of-the-box machine learning job.

* Update getting-started.asciidoc

The instructions about editing heartbeat.yml were too wordy

* tighten it up!

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Dan Roscigno <dan@roscigno.com>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
  • Loading branch information
3 people authored Oct 7, 2020
1 parent a4c668c commit c1c6c7d
Showing 1 changed file with 37 additions and 3 deletions.
40 changes: 37 additions & 3 deletions heartbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,43 @@ was started. Heartbeat adds the `@every` keyword to the syntax provided by the

include::{libbeat-dir}/shared/config-check.asciidoc[]

[float]
[[configurelocation]]
=== Step 4: Configure the Heartbeat location

Heartbeat can be deployed in multiple locations so that you can detect
differences in availability and response times across those locations.
Configure the Heartbeat location to allow {kib} to display location-specific
information on Uptime maps and perform Uptime anomaly detection based
on location.

To configure the location of a Heartbeat instance, modify the
`add_observer_metadata` processor in +{beatname_lc}.yml+. The following
example specifies the `geo.name` of the `add_observer_metadata` processor as
`us-east-1a`:

[source,yaml]
----------------------------------------------------------------------
# ============================ Processors ============================
processors:
- add_observer_metadata:
# Optional, but recommended geo settings for the location Heartbeat is running in
geo: <1>
# Token describing this location
name: us-east-1a <2>
# Lat, Lon "
#location: "37.926868, -78.024902" <3>
----------------------------------------------------------------------
<1> Uncomment the `geo` setting.
<2> Uncomment `name` and assign the name of the location of the Heartbeat server.
<3> Optionally uncomment `location` and assign the latitude and longitude.

include::{libbeat-dir}/shared/config-check.asciidoc[]

[float]
[[setup-assets]]
=== Step 4: Set up assets
=== Step 5: Set up assets

{beatname_uc} comes with predefined assets for parsing, indexing, and
visualizing your data. To load these assets:
Expand Down Expand Up @@ -128,7 +162,7 @@ environment. If you're using a different output, such as {ls}, see

[float]
[[start]]
=== Step 5: Start Heartbeat
=== Step 6: Start Heartbeat

Before starting {beatname_uc}, modify the user credentials in
+{beatname_lc}.yml+ and specify a user who is
Expand All @@ -145,7 +179,7 @@ events to your defined output.

[float]
[[view-data]]
=== Step 6: View your data in {kib}
=== Step 7: View your data in {kib}

{beatname_uc} comes with pre-built {kib} dashboards and UIs for visualizing the
status of your services. The dashboards are available in the
Expand Down

0 comments on commit c1c6c7d

Please sign in to comment.