-
Notifications
You must be signed in to change notification settings - Fork 152
Fix APM ES config documentation to correctly indicate applicability to both binary and Fleet-managed deployments #3343
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
base: main
Are you sure you want to change the base?
Conversation
… fleet-managed Co-authored-by: carsonip <[email protected]>
🔍 Preview links for changed docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should also be backported to 8.x in observability-docs.
 | ||
|
||
This documentation only applies to APM Server binary users. Fleet-managed users should see [Configure the {{es}} output](/reference/fleet/elasticsearch-output.md). | ||
The configuration options described here apply to both APM Server binary and Fleet-managed users. The YAML configuration examples shown are specific to APM Server binary users. Fleet-managed users should configure these same APM-specific {{es}} output settings through the {{fleet}} UI rather than the general [{{es}} output settings](/reference/fleet/elasticsearch-output.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bit hesitant about the part rather than the general ...
which is a "negative" link to /reference/fleet/elasticsearch-output.md because it wants to call out that Fleet ES config does not apply to ES output if used in APM. This may create confusion, but at the same time clears out some confusion. I think it is fine, unless we have a better way to express that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fleet-managed users should configure these same APM-specific {{es}} output settings through the {{fleet}} UI
When you say it should be configured in the Fleet UI, do you mean it as described here or something else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exactly. Editing the Elasticsearch Output, but put in configs documented in the APM docs inside the Elasticsearch output Advanced YAML config text box.
Problem
The APM Elasticsearch output configuration documentation incorrectly indicated that it only applies to APM Server binary users and not Fleet-managed users. This was misleading because the ES configuration options described are actually applicable to both deployment methods.
Solution
Updated the documentation to correctly reflect that:
Changes Made
observability-binary-yes-fm-no.svg
toobservability-binary-yes-fm-yes.svg
to show support for both deployment methodsImpact
This fix ensures users understand that the valuable APM-specific Elasticsearch output configurations documented in this page are available to all APM users, regardless of their deployment method. Fleet-managed users will no longer be incorrectly directed away from APM-specific settings to general Fleet settings.
Fixes: elastic/apm-server#18937
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.