Fix typos in runtime logs, field metadata, and reference docs#49483
Fix typos in runtime logs, field metadata, and reference docs#49483
Conversation
|
This pull request does not have a backport label.
To fixup this pull request, you need to add the backport labels for the needed
|
… might might, threshhold Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Vale Linting ResultsSummary: 1 suggestion found 💡 Suggestions (1)
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. |
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis 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)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/test |
Use a checked type assertion for log.file.path to satisfy errcheck and safely skip events with non-string values. Made-with: Cursor
This comment has been minimized.
This comment has been minimized.
| source, ok := value.(string) | ||
| if !ok { | ||
| f.logger.Debugf("log.file.path is not a string: %T", value) | ||
| return "" | ||
| } |
There was a problem hiding this comment.
/ai, could you add a test for that?
|
/test |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
/test |
|
/ai can you fix checks |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
|
/test |
|
Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane) |
Made-with: Cursor
|
/test |
… errors Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
TL;DR
Remediation
Investigation detailsRoot CauseThe failing workflow is Evidence
Validation
Follow-up
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>
|
/test |
|
/test |
Fixes several user-facing typo families found by the text auditor across runtime code and documentation.
matchers.go):does not contains→does not contain,uid→UIDAvaliable→Availablenormaly→normallyUkranian→Ukrainianfields.yml+ exported docs):availabe→available,might might→mightfields.yml+ exported docs):threshhold→thresholdOriginal 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_pathSuggested fix:
Error extracting pod UID - source value does not contain matcher's logs_pathWhy: Clear grammar error (
does not contains) in runtime log output.2.
Avaliabletypo 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.
normalytypo 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.
Ukraniantypo 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.
availabeand duplicatedmight mightin system core field descriptionsFiles:
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 LinuxOne core might might execute multiple threads...Suggested fix:
Only available on LinuxOne core might execute multiple threads...Why: Clear spelling and duplicated-word grammar errors in exported field descriptions.
6.
threshholdtypo 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 threshholdSuggested fix:
memory low/high/max thresholdWhy: Clear spelling error repeated across user-facing exported-field text.
Suggested Actions
does not contains->does not contain(anduid->UIDif desired) infilebeat/processor/add_kubernetes_metadata/matchers.go.AvaliablewithAvailablein all Nomad metadata doc occurrences listed above.normalywithnormallyin all SSL doc occurrences listed above.UkranianwithUkrainianin all Filebeat input doc occurrences listed above.availabewithavailableandmight mightwithmightin both source_metaand rendered reference docs.threshholdwiththresholdin both source_metaand rendered reference docs.Duplicate check
Checked
/tmp/previous-findings.jsonand 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.
📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.