-
Notifications
You must be signed in to change notification settings - Fork 5k
Add docs on run_from fields
#33466
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.
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
Merged
andrewvc
merged 5 commits into
elastic:main
from
andrewvc:add-location-metadata-through-run-from
Oct 28, 2022
+63
−2
Merged
Add docs on run_from fields
#33466
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
77f9da4
Add docs on `run_from` fields
andrewvc 4a7a4e3
Apply suggestions from code review
andrewvc 8f56a84
Incorporate PR feedback
andrewvc 8c3edef
Merge branch 'main' into add-location-metadata-through-run-from
andrewvc 4097a4a
Apply suggestions from code review
andrewvc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,27 @@ | ||
| [[configuration-observer-options]] | ||
| == Add observer and geo metadata | ||
|
|
||
| It is often useful to view and query various attributes of the instance Heartbeat is running on. This data is attached to events via the <<add-observer-metadata,`add_observer_metadata`>> processor. This processor populates the ECS `observer.*` fields. One field of particular utility is the `observer.geo.name` field, which you can configure via this processor. Use this field to create distinctive geographic regions for your uptime checks. You might label your regions by datacenter name or geographic region, e.g. `virginia-dc-1`, or `us-east-1a`, or `virginia-us`. | ||
| Use the `heartbeat.run_from` option to set the geographic location fields relevant to a given heartbeat instance. | ||
|
|
||
| Note that Heartbeat should not be used with the similarly named <<add-host-metadata,`add_host_metadata`>> processor. In ECS parlance the host is the thing that is monitored, not the thing doing the monitoring, which is the observer. | ||
| The `run_from` option is used to label the geographic location where the monitor is running. | ||
| Note, you can also set the `run_from` option on an individual monitor to apply a unique setting to just that monitor. | ||
|
|
||
| The `run_from` option takes two top-level fields: | ||
|
|
||
| * `id`: A string used to uniquely identify the geographic location. It is indexed as the `observer.name` field. | ||
| * `geo`: A map conforming to https://www.elastic.co/guide/en/ecs/current/ecs-geo.html[ECS geo fields]. It is indexed under `observer.geo`. | ||
|
|
||
| Example: | ||
|
|
||
| ```yaml | ||
| heartbeat.run_from: | ||
| id: my-custom-geo | ||
| geo: | ||
| name: nyc-dc1-rack2 | ||
| location: 40.7128, -74.0060 | ||
| continent_name: North America | ||
| country_iso_code: US | ||
| region_name: New York | ||
| region_iso_code: NY | ||
| city_name: New York | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.