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

[apm] Improve instructions for monitoring APM on premise #4749

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

colleenmcginnis
Copy link
Contributor

Description

@lucabelluccini shared a few ways we could improve the instructions for monitoring APM on premise:

  • Warn users that if they have already enrolled Elastic Agent, following these instructions will likely cause them to lose the state of the agent.
  • Suggest that users who have already enrolled Elastic Agent, use Fleet UI to change the agent's HTTP monitoring endpoint.
  • Remove username and password from the sample modules.d/beat-xpack.yml.

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4726

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

@colleenmcginnis colleenmcginnis added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Jan 7, 2025
@colleenmcginnis colleenmcginnis self-assigned this Jan 7, 2025
Copy link
Contributor

github-actions bot commented Jan 7, 2025

A documentation preview will be available soon.

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.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review January 7, 2025 20:55
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner January 7, 2025 20:55
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

@eedugon
Copy link
Contributor

eedugon commented Jan 9, 2025

IMO the title Configure Elastic Agent to **send** monitoring data is incorrect and it's probably the reason for the original document to have issues like including a username and a password that shouldn't be there.

The title should be: Configure Elastic Agent to serve monitoring data (instead of serve we can use another word like provide), as that part of the configuration just enables an HTTP endpoint to provide monitoring data to any client, it doesn't send anything.

What do you think @lucabelluccini and @colleenmcginnis ?

@colleenmcginnis , I hope this comment doesn't feel off-topic (I tend to add too many off-topic comments :-D ), as I think it's related with the original issue.

*Only use this option if you have _not_ yet enrolled {agent}.*
If you edit and re-enroll {agent}, you will likely lose the state of the agent.

If you have already enrolled the {agent}, consider using the Fleet UI to change the agent's HTTP monitoring endpoint
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally we would have:

  • For versions pre 8.15 we have to say:
*This procedure works only if you've _not_ yet enrolled {agent}.*
If you've already enrolled {agent}, you'll need to re-enroll {agent} and you'll lose the state of the agent.
  • For version 8.15 and more recent
Use the Fleet UI to change the agent's HTTP monitoring endpoint using {fleet-guide}/agent-policy.html#advanced-agent-monitoring-settings[Advanced agent monitoring settings].

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, I would invite a developer / engineer to test this flow if possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@simitt is someone from your team available to take a look at this recommendation?

Copy link
Contributor

@lucabelluccini lucabelluccini left a comment

Choose a reason for hiding this comment

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

I've left a comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Better / improved instructions for APM Integration monitoring for on-premise
4 participants