Document how standalone Elastic Agent input settings map to Beats options - #7734
Draft
bmorelli25 wants to merge 2 commits into
Draft
Document how standalone Elastic Agent input settings map to Beats options#7734bmorelli25 wants to merge 2 commits into
bmorelli25 wants to merge 2 commits into
Conversation
…ions Standalone users had no way to discover settings like period or cpu.metrics that appear in Fleet-exported configs. Agent passes input settings through to the underlying collector unchanged apart from a few reserved fields, but that rule was never stated in the Fleet docs, so finding available options required guesswork. Adds the passthrough rule and the reserved field list, a minimum viable standalone config, and points the Modules comparison row at Metricbeat as well as Filebeat. Also drops two stale 9.0.0-beta1 version qualifiers. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
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. |
bmorelli25
marked this pull request as draft
August 4, 2026 20:43
Contributor
Contributor
✅ Elastic Docs Style Checker (Vale)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. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Mostly clean; two Vale wordiness suggestions ("in order to" → "to", "not possible" → "impossible") in unchanged/pre-existing lines — not blocking. New prose is clear and follows active voice/second person conventions.
- Jargon: No unexplained Elastic-internal jargon introduced in the new sections.
- Frontmatter and applies_to: No frontmatter changes in this PR; Vale's
mapped_pageswarning is pre-existing/unrelated to the diff. - Content type fit: New sections fit the how-to/reference structure of the surrounding pages.
- Parent issue satisfaction: Partially satisfied. The linked issue (elastic/ingest-docs#135) lists five gaps; this PR is explicit that it addresses the remaining four but leaves two open questions unresolved (
data_stream.namespacedefault behavior, and wheredata_stream.typegets documented) — flagged with inline comments where they map to specific lines. PR is marked draft, consistent with these open items.
Notes
- The PR author explicitly calls out two unconfirmed technical claims in the description; I've added inline comments on the corresponding lines so they're visible during review rather than restating them only here.
Generated by Docs review agent for #7734 · sonnet50 · 35 AIC · ⌖ 6.47 AIC · ⊞ 15.6K
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #7794.
The issue listed five problems. One is already fixed:
elastic-agent-inputs-list.mdprovides the list of supported inputs. This PR covers the rest.Background: standalone Agent passes input settings through to the underlying Beat unchanged, apart from
type,id,use_output,log_level, andpolicy.revision. That's documented in the agent repo (docs/agent-policy.md) but not in the Fleet docs, so there was no way to know that settings likeperiodandcpu.metricsare valid inelastic-agent.yml.Changes:
elastic-agent-input-configuration.md: new "Find the settings available for an input" section with the passthrough rule, the reserved field table, and an example settingperiodandcpu.metricson a stream.configure-standalone-elastic-agents.md: new minimum configuration section (one output, one input).beats-agent-comparison.md: the Modules row linked only to Filebeat, implying Metricbeat modules weren't supported. Now links both. Also removed two stale "9.0.0-beta1" qualifiers; version references elsewhere in the repo are at 9.4.0.Two things I need confirmed:
data_stream.namespace. I couldn't confirm from source that it defaults todefault. If it's required, the example needs that line.data_stream.typeis not documented here. I couldn't find where it gets set (not inagent-policy.mdorcomponent-specs.md).