Skip to content

Add docs on run_from fields#33466

Merged
andrewvc merged 5 commits intoelastic:mainfrom
andrewvc:add-location-metadata-through-run-from
Oct 28, 2022
Merged

Add docs on run_from fields#33466
andrewvc merged 5 commits intoelastic:mainfrom
andrewvc:add-location-metadata-through-run-from

Conversation

@andrewvc
Copy link
Copy Markdown
Contributor

@andrewvc andrewvc commented Oct 27, 2022 •
edited
Loading

What does this PR do?

Fixes https://github.com/elastic/synthetics-service/issues/635

Documents the new run_from field, which was added in #30632 .

This is a pure docs PR, since the implementation came with states.

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.

@andrewvc andrewvc added docs Heartbeat Team:obs-ds-hosted-services Label for the Observability Hosted Services team v8.5.0 labels Oct 27, 2022
@andrewvc andrewvc self-assigned this Oct 27, 2022
@andrewvc andrewvc requested a review from a team as a code owner October 27, 2022 02:18
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 27, 2022

Pinging @elastic/uptime (Team:Uptime)

@botelastic 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 Oct 27, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 27, 2022

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @andrewvc? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 27, 2022 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-10-28T17:13:12.142+0000

  • Duration: 8 min 0 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

colleenmcginnis
colleenmcginnis reviewed Oct 27, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

@andrewvc I left some thoughts below. Feel free to adjust my suggestions as needed!

heartbeat/docs/monitors/monitor-common-options.asciidoc Outdated
Comment on lines +112 to +119
Determines which geographic location to label this monitor as running from. Note, this
is usually better handled by using the top level `heartbeat.run_from` option which
takes the same values, but applies them to every monitor.

Takes two top-level fields: `id` and `geo`, where `id` is a string used to uniquely identify
the geographic location, and indexed as the `observer.name` field, and `geo` which is a map
conforming to https://www.elastic.co/guide/en/ecs/current/ecs-geo.html[ECS geo fields]
and is indexed under `observer.geo`.
Copy link
Copy Markdown
Contributor

@colleenmcginnis colleenmcginnis Oct 27, 2022

Choose a reason for hiding this comment

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

Copy over the changes from above?

@andrewvc
Copy link
Copy Markdown
Contributor Author

andrewvc commented Oct 27, 2022

@colleenmcginnis I've incorporated all your feedback, can you take another look?

colleenmcginnis
colleenmcginnis approved these changes Oct 27, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

Two last suggestions -- we should use the shared attribute for the base path to the ECS docs.

@andrewvc @colleenmcginnis
Apply suggestions from code review
4097a4a 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@andrewvc andrewvc merged commit 95cee09 into elastic:main Oct 28, 2022
@andrewvc andrewvc deleted the add-location-metadata-through-run-from branch October 28, 2022 18:20
@andrewvc andrewvc restored the add-location-metadata-through-run-from branch October 28, 2022 18:20
@andrewvc andrewvc mentioned this pull request Oct 28, 2022
Closed
chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
@andrewvc @colleenmcginnis @chrisberkhout
Add docs on run_from fields (#33466)
140c314 
* Add docs on `run_from` fields

* Apply suggestions from code review

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Incorporate PR feedback

* Apply suggestions from code review

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@colleenmcginnis colleenmcginnis colleenmcginnis approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@andrewvc andrewvc

Labels

docs Heartbeat Team:obs-ds-hosted-services Label for the Observability Hosted Services team v8.5.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@andrewvc @elasticmachine @colleenmcginnis