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.

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] Add id/name to all YML examples, fix geo defaults #17886

Merged
merged 6 commits into from
Apr 22, 2020

Conversation

andrewvc
Copy link
Contributor

@andrewvc andrewvc commented Apr 22, 2020

This patch fixes #16460 by using the id and name fields in all our examples. Customers should always set these. The only reason we don't require them is backwards compat concerns with earlier 7.x heartbeats.

Frequently on the forum we find that people haven't set these options when they really should. We took one step forward in #17694 and this completes the story.

This patch also fixes the indentation of the add_observer_metadata example in heartbeat.yml. Prior to this uncommenting it would not yield a valid config, due it being at the wrong indent level.

Checklist

  • My code follows the style guidelines of this project
    - [ ] I have commented my code, particularly in hard-to-understand areas
    - [ ] I have made corresponding changes to the documentation
    - [ ] I have made corresponding change to the default configuration files
    - [ ] I have added tests that prove my fix is effective or that my feature works
    - [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR locally

  • Try using the default heartbeat.yml it should run without error
  • Try uncommenting the add_observer_metadata options in heartbeat.yml, it should work
  • Try removing disabled from all configs in configs.d to run them, they should all work

This patch fixes elastic#16460 by using the `id` and `name` fields in all our examples. Customers should always set these. The only reason we don't require them is backwards compat concerns with earlier 7.x heartbeats.

This patch also fixes the indentation of the `add_observer_metadata` example in `heartbeat.yml`. Prior to this uncommenting it would not yield a valid config, due it being at the wrong indent level.
@andrewvc andrewvc added enhancement Heartbeat Team:obs-ds-hosted-services Label for the Observability Hosted Services team labels Apr 22, 2020
@andrewvc andrewvc requested a review from a team as a code owner April 22, 2020 01:38
@elasticmachine
Copy link
Collaborator

Pinging @elastic/uptime (:uptime)

Copy link
Contributor

@blakerouse blakerouse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Do have one comment with alignment, but not a blocker for landing.

heartbeat/heartbeat.yml Outdated Show resolved Hide resolved
libbeat/_meta/config.yml.tmpl Outdated Show resolved Hide resolved
@andrewvc andrewvc merged commit cdb20e2 into elastic:master Apr 22, 2020
@andrewvc andrewvc deleted the use-id-in-yml branch April 22, 2020 12:37
andrewvc added a commit to andrewvc/beats that referenced this pull request Apr 22, 2020
…c#17886)

This patch fixes elastic#16460 by using the `id` and `name` fields in all our examples. Customers should always set these. The only reason we don't require them is backwards compat concerns with earlier 7.x heartbeats.

This patch also fixes the indentation of the `add_observer_metadata` example in `heartbeat.yml`. Prior to this uncommenting it would not yield a valid config, due it being at the wrong indent level.

(cherry picked from commit cdb20e2)
andrewvc added a commit that referenced this pull request Apr 22, 2020
#17896)

This patch fixes #16460 by using the `id` and `name` fields in all our examples. Customers should always set these. The only reason we don't require them is backwards compat concerns with earlier 7.x heartbeats.

This patch also fixes the indentation of the `add_observer_metadata` example in `heartbeat.yml`. Prior to this uncommenting it would not yield a valid config, due it being at the wrong indent level.

(cherry picked from commit cdb20e2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Heartbeat Team:obs-ds-hosted-services Label for the Observability Hosted Services team v7.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Uptime][Docs] Consistently use id and name for heartbeat yaml docs
3 participants