[aws, blacklens, github, microsoft_sentinel] Resolve conflicting event.kind values in constant_keyword fields#18143
Conversation
|
Pinging @elastic/security-service-integrations (Team:Security-Service Integrations) |
Vale Linting ResultsSummary: 15 warnings, 27 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/aws/docs/securityhub.md | 1384 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
| packages/aws/docs/securityhub.md | 1385 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/aws/docs/securityhub.md | 1387 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/github/docs/README.md | 233 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
| packages/github/docs/README.md | 234 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/github/docs/README.md | 236 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/github/docs/README.md | 412 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
| packages/github/docs/README.md | 413 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/github/docs/README.md | 415 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/github/docs/README.md | 568 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
| packages/github/docs/README.md | 569 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/github/docs/README.md | 571 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/github/docs/README.md | 801 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
| packages/github/docs/README.md | 802 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/github/docs/README.md | 804 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
💡 Suggestions (27)
| File | Line | Rule | Message |
|---|---|---|---|
| packages/aws/docs/securityhub.md | 1386 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/aws/docs/securityhub.md | 1386 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/aws/docs/securityhub.md | 1386 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/blacklens/docs/README.md | 148 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/blacklens/docs/README.md | 148 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/blacklens/docs/README.md | 148 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/github/docs/README.md | 235 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/github/docs/README.md | 235 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/github/docs/README.md | 235 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/github/docs/README.md | 414 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/github/docs/README.md | 414 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/github/docs/README.md | 414 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/github/docs/README.md | 570 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/github/docs/README.md | 570 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/github/docs/README.md | 570 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/github/docs/README.md | 803 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/github/docs/README.md | 803 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/github/docs/README.md | 803 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/microsoft_sentinel/docs/README.md | 191 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/microsoft_sentinel/docs/README.md | 191 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/microsoft_sentinel/docs/README.md | 191 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/microsoft_sentinel/docs/README.md | 253 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/microsoft_sentinel/docs/README.md | 253 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/microsoft_sentinel/docs/README.md | 253 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/microsoft_sentinel/docs/README.md | 434 | Elastic.Wordiness | Consider using 'tell' instead of 'inform'. |
| packages/microsoft_sentinel/docs/README.md | 434 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/microsoft_sentinel/docs/README.md | 434 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', 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.
…event-kind-constant_keyword-issue
| - name: event.kind | ||
| type: constant_keyword | ||
| value: alert | ||
| type: keyword |
There was a problem hiding this comment.
event.kind is an ECS field and should be defined using external: ecs rather than type: keyword.
fwiw You can detect and fix (add -fix) this class of issue automatically using
go run github.com/andrewkroh/fydler@main -a useecs packages/blacklens/data_stream/alerts/fields/ecs.yml
There was a problem hiding this comment.
Updated all occurrences of event.kind to be defined using external: ecs.
🚀 Benchmarks reportTo see the full report comment with |
💚 Build Succeeded
History
|
|
Package aws - 6.4.3 containing this change is available at https://epr.elastic.co/package/aws/6.4.3/ |
|
Package blacklens - 1.0.1 containing this change is available at https://epr.elastic.co/package/blacklens/1.0.1/ |
|
Package github - 2.22.1 containing this change is available at https://epr.elastic.co/package/github/2.22.1/ |
|
Package microsoft_sentinel - 1.3.1 containing this change is available at https://epr.elastic.co/package/microsoft_sentinel/1.3.1/ |
Proposed commit message
Checklist
changelog.ymlfile.How to test this PR locally
Replace the <integration_name> with the actual name of integration.
Related issues