Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add add_observer_metadata geo.name to Quickstart #21501

Merged
merged 3 commits into from
Oct 7, 2020
Merged

Add add_observer_metadata geo.name to Quickstart #21501

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c689e9
Add `add_observer_metadata` `geo.name` to Quickstart
DanRoscigno Oct 2, 2020
4f3d4ed
Update getting-started.asciidoc
DanRoscigno Oct 3, 2020
6ecc606
tighten it up!
DanRoscigno Oct 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 37 additions & 3 deletions heartbeat/docs/getting-started.asciidoc
View file
Open in desktop
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