-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
[Heartbeat] Always use synthetics data streams for browser #32064
Merged
andrewvc
merged 2 commits into
elastic:main
from
andrewvc:always-use-synthetics-namespaces-for-browsers
Jun 23, 2022
Merged
[Heartbeat] Always use synthetics data streams for browser #32064
andrewvc
merged 2 commits into
elastic:main
from
andrewvc:always-use-synthetics-namespaces-for-browsers
Jun 23, 2022
Conversation
This file contains 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
A frequent UX issue for our users is wanting to set different retention periods for network / screenshot data. Our default settings for browser monitors really hurt here since we lump them all into a `heartbeat` data stream unless users are using fleet. This addresses this issue by defaulting browser monitors to use `synthetics*` data streams which breaks them out by type. We can't do this in any sort of simple way with the 'heartbeat' prefix. This shouldn't be a practical issue for most users since in 8.x all kibana clusters have synthetics templates pre-installed. Users who have explicitly set their kibana index pattern to only `heartbeat-*` with no `synthetics-*` will be affected. Given that we are in beta this potential breakage is worth it for the long term benefits to users. This also implies Kibana has been setup with Elasticsearch, which is overwhelmingly the case. If kibana is not setup then the mappings for this synthetics index will be incorrect, but this is likely not a real-world concern. See also elastic/observability-docs#1944
andrewvc
added
enhancement
Heartbeat
Team:obs-ds-hosted-services
Label for the Observability Hosted Services team
labels
Jun 23, 2022
botelastic
bot
added
needs_team
Indicates that the issue/PR needs a Team:* label
and removed
needs_team
Indicates that the issue/PR needs a Team:* label
labels
Jun 23, 2022
Collaborator
LGTM, tested with a fresh install and heartbeat.yml config only. Browser monitor is configured to use HB data view: Tested with: heartbeat.monitors:
- type: http
enabled: true
id: my-monitor
name: My Monitor
urls: ["http://localhost:9200"]
schedule: '@every 1m'
- type: icmp
enabled: true
id: my-monitor-2
schedule: "@every 1m"
hosts: [8.8.8.8]
- type: tcp
enabled: true
id: my-monitor-3
schedule: "@every 1m"
hosts: ["google.es"]
- type: browser
enabled: true
id: my-monitor-4
schedule: "@every 1m"
name: "My monitor 2"
source:
inline:
script: |
step("load homepage", async () => {
await page.goto('https://www.elastic.co');
}); |
emilioalvap
approved these changes
Jun 23, 2022
Pinging @elastic/uptime (Team:Uptime) |
LGTM. Data for browser monitors was properly segmented into data streams. No data was written to heartbeat. |
chrisberkhout
pushed a commit
that referenced
this pull request
Jun 1, 2023
* [Heartbeat] Always use synthetics data streams for browser A frequent UX issue for our users is wanting to set different retention periods for network / screenshot data. Our default settings for browser monitors really hurt here since we lump them all into a `heartbeat` data stream unless users are using fleet. This addresses this issue by defaulting browser monitors to use `synthetics*` data streams which breaks them out by type. We can't do this in any sort of simple way with the 'heartbeat' prefix. This shouldn't be a practical issue for most users since in 8.x all kibana clusters have synthetics templates pre-installed. Users who have explicitly set their kibana index pattern to only `heartbeat-*` with no `synthetics-*` will be affected. Given that we are in beta this potential breakage is worth it for the long term benefits to users. This also implies Kibana has been setup with Elasticsearch, which is overwhelmingly the case. If kibana is not setup then the mappings for this synthetics index will be incorrect, but this is likely not a real-world concern. See also elastic/observability-docs#1944 * Add changelog, improve docs copy, and add deprecating warning to `index` setting
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
A frequent UX issue for our users is wanting to set different retention periods for network / screenshot data. Our default settings for browser monitors really hurt here since we lump them all into a
heartbeat
data stream unless users are using fleet. This addresses this issue by defaulting browser monitors to usesynthetics*
data streams which breaks them out by type.We can't do this in any sort of simple way with the 'heartbeat' prefix. This shouldn't be a practical issue for most users since in 8.x all kibana clusters have synthetics templates pre-installed. Users who have explicitly set their kibana index pattern to only
heartbeat-*
with nosynthetics-*
will be affected. Given that we are in beta this potential breakage is worth it for the long term benefits to users.This also implies Kibana has been setup with Elasticsearch, which is overwhelmingly the case. If kibana is not setup then the mappings for this synthetics index will be incorrect, but this is likely not a real-world concern.
See also elastic/observability-docs#1944
Checklist
CHANGELOG.next.asciidoc
orCHANGELOG-developer.next.asciidoc
.How to test this PR locally
Check against a fresh stack with the synthetics integration not installed.