Skip to content

Deprecate Elasticsearch output options not available for Beat receivers#6217

Open
vishaangelova wants to merge 5 commits intomainfrom
47537-deprecate-output-parameters
Open

Deprecate Elasticsearch output options not available for Beat receivers#6217
vishaangelova wants to merge 5 commits intomainfrom
47537-deprecate-output-parameters

Conversation

@vishaangelova
Copy link
Copy Markdown
Member

@vishaangelova vishaangelova commented Apr 30, 2026

Summary

This PR:

  • Deprecates the escape_html and allow_older_versions ES output options starting from 9.5.0 (these are not applicable when using Beat receivers).
  • Removes the pipeline and pipelines options as, based on this discussion, they have never worked for standalone Elastic Agents (@khushijain21 to confirm; UPDATE: confirmed).

Contributes to elastic/beats#47537
Related PR: elastic/beats#50543

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Preview

@github-actions
Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@vishaangelova vishaangelova force-pushed the 47537-deprecate-output-parameters branch from 3ac393f to f4a14c5 Compare April 30, 2026 08:38
@vishaangelova vishaangelova force-pushed the 47537-deprecate-output-parameters branch from ee78ed2 to b582970 Compare April 30, 2026 09:25
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 2026

✅ Vale Linting Results

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

Comment thread reference/fleet/elasticsearch-output.md Outdated

Starting with version 9.3, {{agent}} uses [Beat receivers](/reference/fleet/elastic-agent-as-otel-collector.md#beat-receivers) to run Beat inputs within an embedded OpenTelemetry Collector. Some {{es}} output parameters are not supported when using Beat receivers:

* `escape_html`: Not supported.
Copy link
Copy Markdown
Contributor

@khushijain21 khushijain21 Apr 30, 2026

Choose a reason for hiding this comment

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

I think what we want here is to deprecateescape_html field entirely irrespective of it is running as beats input or beatreceivers.

cc: @cmacknz. If I am right - should we include the deprecation notice in 9.4?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes but IIRC the deprecation was because we always do this now

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The deprecation is that we will not support escaping html embeddings.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Right I found the internal reference, it came from elastic/beats#2581 9 years ago. If people are still using this deprecating it is a way to find out.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So we can deprecate it for both use cases and revisit if needed.

Copy link
Copy Markdown
Member Author

@vishaangelova vishaangelova May 7, 2026

Choose a reason for hiding this comment

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

I’ve removed the notes & the new section, and updated the PR in 4cec52f as it seemed based on your feedback that we can just use an {applies_to}`stack: deprecated 9.4+` here to mark the two settings as deprecated from 9.4+. Let me know if that works.

Comment thread reference/fleet/elasticsearch-output.md Outdated
Starting with version 9.3, {{agent}} uses [Beat receivers](/reference/fleet/elastic-agent-as-otel-collector.md#beat-receivers) to run Beat inputs within an embedded OpenTelemetry Collector. Some {{es}} output parameters are not supported when using Beat receivers:

* `escape_html`: Not supported.
* `allow_older_versions`: Not applicable. Beat receivers always allow connections to older {{es}} versions.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same as above.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Addressed in 4cec52f

@vishaangelova vishaangelova marked this pull request as ready for review May 7, 2026 11:26
@vishaangelova vishaangelova requested a review from a team as a code owner May 7, 2026 11:26
@vishaangelova vishaangelova changed the title Add notices to Elasticsearch output options not available for Beat receivers Deprecates the Elasticsearch output options not available for Beat receivers May 7, 2026
Comment thread reference/fleet/elasticsearch-output.md Outdated
@vishaangelova vishaangelova changed the title Deprecates the Elasticsearch output options not available for Beat receivers Deprecate Elasticsearch output options not available for Beat receivers May 7, 2026
@cmacknz cmacknz requested a review from nimarezainia May 7, 2026 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[beatreceivers] Document unuspported/deprecated output parameters

3 participants