Deprecate Elasticsearch output options not available for Beat receivers#6217
Deprecate Elasticsearch output options not available for Beat receivers#6217vishaangelova wants to merge 5 commits intomainfrom
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
3ac393f to
f4a14c5
Compare
ee78ed2 to
b582970
Compare
🔍 Preview links for changed docs |
✅ Vale Linting ResultsNo 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. |
|
|
||
| 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Yes but IIRC the deprecation was because we always do this now
There was a problem hiding this comment.
The deprecation is that we will not support escaping html embeddings.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
So we can deprecate it for both use cases and revisit if needed.
There was a problem hiding this comment.
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.
| 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. |
Summary
This PR:
escape_htmlandallow_older_versionsES output options starting from 9.5.0 (these are not applicable when using Beat receivers).pipelineandpipelinesoptions 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
Preview