Skip to content

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Oct 6, 2025

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:

  • The configuration options apply to both APM Server binary and Fleet-managed users
  • The YAML configuration examples are specific to binary users
  • Fleet-managed users should configure these same APM-specific ES output settings through the Fleet UI
  • These APM-specific settings are distinct from the general Fleet ES output settings

Changes Made

  1. Updated deployment indicator: Changed from observability-binary-yes-fm-no.svg to observability-binary-yes-fm-yes.svg to show support for both deployment methods
  2. Revised note text: Clarified that while the configs apply to both methods, the configuration approach differs:
    • Binary users: Configure via YAML (as shown in examples)
    • Fleet-managed users: Configure via Fleet UI (not the general Fleet ES output settings)

Impact

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

This section details on the original issue you should resolve

<issue_title>[Internal]: APM ES config incorrectly labeled as not applicable to fleet-managed APM</issue_title>
<issue_description>### Description

Mirrors issue elastic/apm-server#18937

In https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output ,

This documentation only applies to APM Server binary users. Fleet-managed users should see Configure the Elasticsearch output.

but this is not accurate. The ES configs listed in APM ES output docs are applicable to both standalone and fleet-managed, but the way to configure them through yaml is specific to standalone. Fleet-managed APM needs to configure the APM ES output configs (not Fleet ES output configs) via fleet UI

Resources

https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output

Which documentation set does this change impact?

Elastic On-Prem and Cloud (all)

Feature differences

Applies to both on-prem and cloud

What release is this request related to?

9.2

Serverless release

NA

Collaboration model

The documentation team

Point of contact.

Main contact: @carsonip

Stakeholders:
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #3342

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Copilot Copilot AI changed the title [WIP] [Internal]: APM ES config incorrectly labeled as not applicable to fleet-managed APM Fix APM ES config documentation to correctly indicate applicability to both binary and Fleet-managed deployments Oct 6, 2025
@Copilot Copilot AI requested a review from carsonip October 6, 2025 14:30
Copilot finished work on behalf of carsonip October 6, 2025 14:30
Copy link

github-actions bot commented Oct 6, 2025

🔍 Preview links for changed docs

@carsonip carsonip marked this pull request as ready for review October 6, 2025 14:38
@carsonip carsonip requested a review from a team as a code owner October 6, 2025 14:38
Copy link
Member

@carsonip carsonip left a 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.

![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "")

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).
Copy link
Member

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.

Copy link
Contributor

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?

Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants