Skip to content

Update agent/common-problems.md #1920

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jun 26, 2025
Merged

Update agent/common-problems.md #1920

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6949d8c
Update agent/common-problems.md
stefnestor Jun 25, 2025
84774de
feedback
stefnestor Jun 25, 2025
a5a215e
feedback 🙏
stefnestor Jun 26, 2025
c249f54
Merge branch 'main' into stefnestor-patch-2
bmorelli25 Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion troubleshoot/ingest/fleet/common-problems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ The ZIP archive containing diagnostics information will include the raw events o

**Get the diagnostics bundle using the CLI**

Run the following command to generate a zip archive containing diagnostics information that the Elastic team can use for debugging cases.
Run the following [Agent command](https://www.elastic.co/docs/reference/fleet/agent-command-reference#elastic-agent-diagnostics-command) to generate a zip archive containing diagnostics information that the Elastic team can use for debugging cases.
Copy link
Member

Choose a reason for hiding this comment

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

Thank you! A few thoughts:

  • Even though we're already in the Elastic Agent docs, we should use the full name, "Elastic Agent" to distinguish between Elastic Agent and APM Agents.
  • Because the page you're linking to is in the same repo, you should use one of our two internal link syntaxes.
  • I would change the link to be the name of the command to give more context as to where the user is being linked off to.
Suggested change
Run the following [Agent command](https://www.elastic.co/docs/reference/fleet/agent-command-reference#elastic-agent-diagnostics-command) to generate a zip archive containing diagnostics information that the Elastic team can use for debugging cases.
Run the [`diagnostics` command](/reference/fleet/agent-command-reference#elastic-agent-diagnostics-command) to generate a zip archive containing diagnostics information that the Elastic team can use for debugging cases:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, @bmorelli25 ! (And the link to know how to do this myself in the future!)

Your change doesn't pass pipeline:
image

FWIW I need the sub-# not just the base file. I may be missing the obvious, but I don't see cross-page anchors listed in your linked guide.

Copy link
Member

@bmorelli25 bmorelli25 Jun 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Your change doesn't pass pipeline:

Sorry! See comment below.

I may be missing the obvious, but I don't see cross-page anchors listed in your linked guide.

This is good feedback. It is not obvious in the docs that you can do this with internal links. There is (kind of) an example wayyy down the page but it's in a different section. Let me add a better example into these docs.

Copy link
Member

Choose a reason for hiding this comment

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

Clarified in elastic/docs-builder#1447


```shell
elastic-agent diagnostics
Expand Down
Loading