Skip to content

Fix typos in runtime logs, field metadata, and reference docs#49483

Closed
Copilot wants to merge 11 commits intomainfrom
copilot/text-auditor-fix-typo-errors
Closed

Fix typos in runtime logs, field metadata, and reference docs#49483
Copilot wants to merge 11 commits intomainfrom
copilot/text-auditor-fix-typo-errors

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 14, 2026

Fixes several user-facing typo families found by the text auditor across runtime code and documentation.

  • Runtime log grammar (matchers.go): does not containsdoes not contain, uidUID
  • Nomad metadata docs (7 files): AvaliableAvailable
  • SSL docs (6 files): normalynormally
  • Filebeat input docs (4 files): UkranianUkrainian
  • System core field metadata (fields.yml + exported docs): availabeavailable, might mightmight
  • System process cgroup field metadata (fields.yml + exported docs): threshholdthreshold
Original prompt

This section details on the original issue you should resolve

<issue_title>[text-auditor] Fix several clear user-facing typo families in runtime and reference text</issue_title>
<issue_description>## Text Improvements

The following user-facing text issues were found in the repository. Each is a low-effort fix.

1. Grammar error in runtime Kubernetes matcher error log

File: filebeat/processor/add_kubernetes_metadata/matchers.go (line 131)
Current text: Error extracting pod uid - source value does not contains matcher's logs_path
Suggested fix: Error extracting pod UID - source value does not contain matcher's logs_path
Why: Clear grammar error (does not contains) in runtime log output.

2. Avaliable typo in Nomad metadata docs (7 occurrences)

Files:

  • x-pack/libbeat/processors/add_nomad_metadata/docs/add_nomad_metadata.asciidoc (line 89)
  • docs/reference/auditbeat/add-nomad-metadata.md (line 88)
  • docs/reference/filebeat/add-nomad-metadata.md (line 88)
  • docs/reference/heartbeat/add-nomad-metadata.md (line 88)
  • docs/reference/metricbeat/add-nomad-metadata.md (line 88)
  • docs/reference/packetbeat/add-nomad-metadata.md (line 88)
  • docs/reference/winlogbeat/add-nomad-metadata.md (line 88)

Current text: Avaliable indexers are:
Suggested fix: Available indexers are:
Why: Clear spelling error repeated across user-facing docs.

3. normaly typo in SSL docs (6 occurrences)

Files:

  • docs/reference/auditbeat/configuration-ssl.md (line 269)
  • docs/reference/filebeat/configuration-ssl.md (line 269)
  • docs/reference/heartbeat/configuration-ssl.md (line 282)
  • docs/reference/metricbeat/configuration-ssl.md (line 284)
  • docs/reference/packetbeat/configuration-ssl.md (line 269)
  • docs/reference/winlogbeat/configuration-ssl.md (line 269)

Current text: ...the handshake will continue normaly.
Suggested fix: ...the handshake will continue normally.
Why: Clear spelling error in user-facing TLS behavior description.

4. Ukranian typo in Filebeat input docs (4 occurrences)

Files:

  • docs/reference/filebeat/filebeat-input-container.md (line 123)
  • docs/reference/filebeat/filebeat-input-filestream.md (line 953)
  • docs/reference/filebeat/filebeat-input-log.md (line 161)
  • docs/reference/filebeat/filebeat-input-stdin.md (line 70)

Current text: koi8u: KOI8-U, Ukranian (Cyrillic)
Suggested fix: koi8u: KOI8-U, Ukrainian (Cyrillic)
Why: Clear spelling error in user-facing encoding descriptions.

5. availabe and duplicated might might in system core field descriptions

Files:

  • metricbeat/module/system/core/_meta/fields.yml (lines 114, 119, 124, 129, 130, 135)
  • docs/reference/metricbeat/exported-fields-system.md (lines 182, 188, 194, 200, 206)

Current text:

  • Only availabe on Linux
  • One core might might execute multiple threads...

Suggested fix:

  • Only available on Linux
  • One core might execute multiple threads...

Why: Clear spelling and duplicated-word grammar errors in exported field descriptions.

6. threshhold typo in process cgroup memory field descriptions (12 occurrences)

Files:

  • metricbeat/module/system/process/_meta/fields.yml (lines 457, 461, 465, 515, 519, 523)
  • docs/reference/metricbeat/exported-fields-system.md (lines 1572, 1580, 1588, 1660, 1668, 1676)

Current text: memory low/high/max threshhold
Suggested fix: memory low/high/max threshold
Why: Clear spelling error repeated across user-facing exported-field text.

Suggested Actions

  • Fix does not contains -> does not contain (and uid -> UID if desired) in filebeat/processor/add_kubernetes_metadata/matchers.go.
  • Replace Avaliable with Available in all Nomad metadata doc occurrences listed above.
  • Replace normaly with normally in all SSL doc occurrences listed above.
  • Replace Ukranian with Ukrainian in all Filebeat input doc occurrences listed above.
  • Replace availabe with available and might might with might in both source _meta and rendered reference docs.
  • Replace threshhold with threshold in both source _meta and rendered reference docs.

Duplicate check

Checked /tmp/previous-findings.json and current open [text-auditor] issues; these typo families were not already tracked in open issues.


What is this? | From workflow: Text Auditor

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

  • expires on Mar 20, 2026, 1:38 PM UTC

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

@botelastic botelastic Bot added the needs_team Indicates that the issue/PR needs a Team:* label label Mar 14, 2026
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Mar 14, 2026

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @Copilot? 🙏.
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.

… might might, threshhold

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] [text-auditor] Fix several user-facing typo families in text Fix typos in runtime logs, field metadata, and reference docs Mar 14, 2026
Copilot AI requested a review from strawgate March 14, 2026 00:58
@strawgate strawgate marked this pull request as ready for review March 14, 2026 03:43
@strawgate strawgate requested review from a team as code owners March 14, 2026 03:43
@strawgate strawgate requested a review from AndersonQ March 14, 2026 03:43
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 14, 2026

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)
File Line Rule Message
docs/reference/metricbeat/exported-fields-system.md 200 Elastic.WordChoice Consider using 'run, start' instead of 'execute', unless the term is in the UI.

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

coderabbitai Bot commented Mar 14, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This pull request fixes spelling and grammar across documentation and one runtime source file. Changes include: "Avaliable" → "Available" in Nomad metadata docs (7 files), "normaly" → "normally" in SSL docs (6 files), "Ukranian" → "Ukrainian" in Filebeat input encodings (4 files), "availabe" → "available" and duplicate "might might" → "might" in system core field descriptions, "threshhold" → "threshold" in process memory field descriptions, and a runtime log correction in filebeat/processor/add_kubernetes_metadata/matchers.go ("does not contains" → "does not contain", "uid" → "UID").

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed All coding-related objectives from issue #49470 are met: runtime log grammar fixed in matchers.go, and all typos corrected across documentation and field metadata files.
Out of Scope Changes check ✅ Passed All changes are in scope—they directly address typos and grammar errors specified in issue #49470 across documentation, field metadata, and runtime logs.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch copilot/text-auditor-fix-typo-errors
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

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

@strawgate
Copy link
Copy Markdown
Contributor

/test

Use a checked type assertion for log.file.path to satisfy errcheck and safely skip events with non-string values.

Made-with: Cursor
@github-actions

This comment has been minimized.

Comment on lines +91 to +95
source, ok := value.(string)
if !ok {
f.logger.Debugf("log.file.path is not a string: %T", value)
return ""
}
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.

/ai, could you add a test for that?

@AndersonQ
Copy link
Copy Markdown
Member

/test

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@strawgate
Copy link
Copy Markdown
Contributor

/test

@strawgate
Copy link
Copy Markdown
Contributor

/ai can you fix checks

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions

This comment has been minimized.

@pierrehilbert
Copy link
Copy Markdown
Contributor

/test

@pierrehilbert pierrehilbert added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Mar 17, 2026
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@botelastic botelastic Bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Mar 17, 2026
@AndersonQ
Copy link
Copy Markdown
Member

/test

@github-actions
Copy link
Copy Markdown
Contributor

TL;DR

golangci-lint is still failing on all three runners, but now the only remaining errors are two unchecked testConfig.SetString(...) return values in matchers_test.go. Add error assertions for those calls and re-run /test.

Remediation

  • In filebeat/processor/add_kubernetes_metadata/matchers_test.go, check the return values at the two failing calls (line 235 and line 239 in current CI output), e.g. require.NoError(t, testConfig.SetString(...)).
  • Re-run /test to confirm golangci-lint passes for ubuntu-latest, macos-latest, and windows-latest.
Investigation details

Root Cause

The failing workflow is golangci-lint, and all matrix jobs fail in the same golangci-lint step due to errcheck findings in one file. Unlike the prior detective report, this run no longer shows the testifylint assert.Empty violation; only unchecked SetString returns remain.

Evidence

filebeat/processor/add_kubernetes_metadata/matchers_test.go:235:23: Error return value of `testConfig.SetString` is not checked (errcheck)
filebeat/processor/add_kubernetes_metadata/matchers_test.go:239:23: Error return value of `testConfig.SetString` is not checked (errcheck)
* errcheck: 2

Validation

  • Checked workflow run metadata and confirmed associated PR: #49483.
  • Reviewed failed job logs for all 3 failed jobs in run 23356868618.
  • Local tests not run (read-only detective analysis).

Follow-up

  • After adding NoError/require.NoError checks for both calls, trigger /test and verify golangci-lint is green across all OS variants.

What is this? | From workflow: PR Actions Detective

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

errcheck flagged two pre-existing bare SetString calls in the helper
function that became visible to golangci-lint when the test file was
modified by this PR.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@AndersonQ
Copy link
Copy Markdown
Member

/test

@strawgate
Copy link
Copy Markdown
Contributor

/test

@strawgate
Copy link
Copy Markdown
Contributor

Closing in favour of a restructured set of PRs that minimise the number of codeowner teams per PR, making approval more tractable. Replacements: #49638 #49639 #49640 #49641 #49642 #49643 #49644

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

Labels

skip-changelog Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[text-auditor] Fix several clear user-facing typo families in runtime and reference text

6 participants