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

Add information about elastic agent diagnostics flow #789

Merged
merged 2 commits into from
Jan 4, 2024

Conversation

philippkahr
Copy link
Contributor

@philippkahr philippkahr commented Jan 4, 2024

I think we should mention how the data is flowing. Otherwise it can be confusing. How will be the elastic agent diagnostics be retrieved, if no Elasticsearch output is defined because logstash is used.

Maybe we can add a simplified version of the flow chart: https://user-images.githubusercontent.com/6766512/190254026-75cc900f-08c6-48c7-8789-56bd8304d933.png from https://github.com/elastic/ingest-dev/issues/1224

thanks to @ckauf for digging the things up.

@philippkahr philippkahr requested a review from a team as a code owner January 4, 2024 12:27
Copy link

github-actions bot commented Jan 4, 2024

A documentation preview will be available soon.

Help us out by validating the Buildkite preview and reporting issues here.
Please also be sure to double check all images to ensure they are correct in the preview.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link

mergify bot commented Jan 4, 2024

This pull request does not have a backport label. Could you fix it @philippkahr? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip label Jan 4, 2024
kilfoyle
kilfoyle previously approved these changes Jan 4, 2024
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for fixing this @philippkahr
I added just one suggestion for the text.

Also, if we need a flow chart I would suggest creating a separate issue for that as it's considerable effort to design and add complex graphics into the docs. Personally, I'd suggest that the troubleshooting information is clear as is.

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM!

@kilfoyle
Copy link
Contributor

kilfoyle commented Jan 4, 2024

I'll merge this and make sure the backports go through.

@kilfoyle kilfoyle merged commit 858e99f into elastic:main Jan 4, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request Jan 4, 2024
* Add information about diagnostics flow

* Update troubleshooting.asciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>

---------

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit 858e99f)
mergify bot pushed a commit that referenced this pull request Jan 4, 2024
* Add information about diagnostics flow

* Update troubleshooting.asciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>

---------

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit 858e99f)
kilfoyle pushed a commit that referenced this pull request Jan 4, 2024
* Add information about diagnostics flow

* Update troubleshooting.asciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>

---------

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit 858e99f)

Co-authored-by: Philipp Kahr <philipp.kahr@elastic.co>
kilfoyle pushed a commit that referenced this pull request Jan 4, 2024
* Add information about diagnostics flow

* Update troubleshooting.asciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>

---------

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit 858e99f)

Co-authored-by: Philipp Kahr <philipp.kahr@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants