Skip to content

Fix section-level applies_to for the Harvester metrics heading in filestream input doc#51698

Open
vishaangelova wants to merge 4 commits into
mainfrom
vishaangelova-patch-2
Open

Fix section-level applies_to for the Harvester metrics heading in filestream input doc#51698
vishaangelova wants to merge 4 commits into
mainfrom
vishaangelova-patch-2

Conversation

@vishaangelova

@vishaangelova vishaangelova commented Jul 3, 2026

Copy link
Copy Markdown
Member

Docs

Proposed commit message

Fix the section-level applies_to for the Harvester metrics heading in the filestream input doc. Follow-up to #50963 (comment) .

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works. Where relevant, I have used the stresstest.sh script to run them under stress conditions and race detector to verify their stability.
  • I have added an entry in ./changelog/fragments using the changelog tool.

…he filestream doc

Updated the syntax for the section-level `applies_to` for the Harvester metrics heading.
@vishaangelova vishaangelova requested a review from belimawr July 3, 2026 05:19
@botelastic botelastic Bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jul 3, 2026
@botelastic

botelastic Bot commented Jul 3, 2026

Copy link
Copy Markdown

This pull request doesn't have a Team:<team> label.

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

🤖 GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)
  • /test : Run the Buildkite pipeline.

@mergify

mergify Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @vishaangelova? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@vishaangelova vishaangelova added docs backport-skip Skip notification from the automated backport with mergify skip-changelog labels Jul 3, 2026
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: b043d6f8-f9a2-4fac-a6f1-3514e5714ede

📥 Commits

Reviewing files that changed from the base of the PR and between be145e4 and 2035a22.

📒 Files selected for processing (1)
  • docs/reference/filebeat/filebeat-input-filestream.md

📝 Walkthrough

Walkthrough

This change updates the "Harvester metrics" documentation section in filebeat-input-filestream.md. The heading capitalization was changed from "Harvester Metrics" to "Harvester metrics," and the {applies_to} directive was reformatted from an inline macro to a fenced directive block displaying stack: ga 9.5+. No other content or exported entities were modified.

Changes

Area Change
docs/reference/filebeat/filebeat-input-filestream.md Heading capitalization updated; {applies_to} macro converted to fenced directive block

Possibly related PRs

  • elastic/beats#50963: Modifies the same "Harvester metrics" section formatting in filebeat-input-filestream.md.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch vishaangelova-patch-2
  • 🛠️ Update Documentation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@vishaangelova vishaangelova requested a review from a team July 3, 2026 05:54
@vishaangelova vishaangelova changed the title Fix section-level applies_to for the Harvester metrics heading in the filestream doc Fix section-level applies_to for the Harvester metrics heading in filestream input doc Jul 3, 2026
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

TL;DR

check-docs failed in the check job because go vet ./... no longer compiles metricbeat/mb/module/runner_test.go: line 173 passes a *logp.Logger where module.NewWrapper now expects *beat.Info. Wrap the test logger in &beat.Info{Logger: ...} and rerun the scoped Metricbeat check.

Remediation

  • Update metricbeat/mb/module/runner_test.go:173 from logptest.NewTestingLogger(t, "") to &beat.Info{Logger: logptest.NewTestingLogger(t, "")} in the module.NewWrapper(...) call.
  • Validate with cd metricbeat && go test ./mb/module or the failing CI path cd metricbeat && mage check.
Investigation details

Root Cause

module.NewWrapper is called with the wrong third argument type in metricbeat/mb/module/runner_test.go:173. Nearby calls in the same file already pass &beat.Info{Logger: logptest.NewTestingLogger(t, "")}, and metricbeat/mb/module/wrapper.go:93 defines the parameter as info *beat.Info.

Evidence

2026-07-03T13:45:44.5034650Z >> check: Checking source code for common problems
2026-07-03T13:45:46.3352055Z # github.com/elastic/beats/v7/metricbeat/mb/module_test
2026-07-03T13:45:46.3457026Z ##[error]vet: mb/module/runner_test.go:173:51: cannot use logptest.NewTestingLogger(t, "") (value of type *logp.Logger) as *beat.Info value in argument to module.NewWrapper
2026-07-03T13:45:52.6591860Z Error: failed running go vet, please fix the issues reported: running "go vet ./..." failed with exit code 1

Validation

  • Not run locally; this report is based on the CI log plus source inspection of the failing call and module.NewWrapper signature.

Follow-up

  • This failure is outside the one docs file changed by this PR, so if it came from merging main, the fix likely belongs on the PR branch as a small compatibility fix or should be resolved in main before re-running.

What is this? | From workflow: PR Actions Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-skip Skip notification from the automated backport with mergify docs needs_team Indicates that the issue/PR needs a Team:* label skip-changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant