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

[Uptime] Add docs for autodiscover hints #14252

Merged
merged 10 commits into from
Nov 13, 2019
Merged

Conversation

andrewvc
Copy link
Contributor

Autodiscover hints were introduced in #13119 but not documented. This adds the docs.

Resolves #14245

Autodiscover hints were introduced in elastic#13119 but not documented. This
adds the docs.

Resolves elastic#14245
@andrewvc andrewvc requested a review from a team as a code owner October 25, 2019 22:19
@andrewvc andrewvc self-assigned this Oct 25, 2019
@andrewvc andrewvc added Team:obs-ds-hosted-services Label for the Observability Hosted Services team docs Heartbeat v7.5.0 labels Oct 25, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/uptime (:uptime)

Copy link
Contributor

@justinkambic justinkambic left a comment

Choose a reason for hiding this comment

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

This seems good to me. By following these directions I configured a Redis container with hints and had Heartbeat autodiscover/monitor it:

image

heartbeat/docs/autodiscover-hints.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

A few minor changes. I'm assuming you built the files and verified the HTML output (don't have time to do that right now, but I don't want to block you).


As an example let's convert the regular syntax heartbeat monitors below into autodiscover hints.

```yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

Use asciidoctor source code block formatting with syntax highlighting here (what you have here is Markdown). See https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#source-code

heartbeat/docs/autodiscover-hints.asciidoc Outdated Show resolved Hide resolved
heartbeat/docs/autodiscover-hints.asciidoc Outdated Show resolved Hide resolved
heartbeat/docs/autodiscover-hints.asciidoc Outdated Show resolved Hide resolved
@andrewvc
Copy link
Contributor Author

@dedemorton I've made all the changes you requested and tested locally.

@andrewvc
Copy link
Contributor Author

@Jenkins retest this please

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

Caught a few more minor issues. Sorry I didn't catch these the first time around.

heartbeat/docs/autodiscover-hints.asciidoc Outdated Show resolved Hide resolved
heartbeat/docs/autodiscover-hints.asciidoc Outdated Show resolved Hide resolved
heartbeat/docs/autodiscover-hints.asciidoc Outdated Show resolved Hide resolved
heartbeat/docs/autodiscover-hints.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

doc changes LGTM

@andrewvc andrewvc merged commit 4eb1711 into elastic:master Nov 13, 2019
@andrewvc andrewvc deleted the hints-docs branch November 13, 2019 18:57
andrewvc added a commit to andrewvc/beats that referenced this pull request Nov 19, 2019
Autodiscover hints were introduced in elastic#13119 but not documented. This adds the docs.

Resolves elastic#14245

(cherry picked from commit 4eb1711)
andrewvc added a commit to andrewvc/beats that referenced this pull request Nov 19, 2019
Autodiscover hints were introduced in elastic#13119 but not documented. This adds the docs.

Resolves elastic#14245

(cherry picked from commit 4eb1711)
andrewvc added a commit that referenced this pull request Nov 25, 2019
Autodiscover hints were introduced in #13119 but not documented. This adds the docs.

Resolves #14245
andrewvc added a commit that referenced this pull request Nov 25, 2019
* [Uptime] Add docs for autodiscover hints (#14252)

Autodiscover hints were introduced in #13119 but not documented. This adds the docs.

Resolves #14245

(cherry picked from commit 4eb1711)

* Fix double include
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
Autodiscover hints were introduced in elastic#13119 but not documented. This adds the docs.

Resolves elastic#14245
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Heartbeat Team:obs-ds-hosted-services Label for the Observability Hosted Services team v7.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Heartbeat] Add docs for hints based autodiscover
4 participants