Conversation
|
Documentation changes preview: https://docs-v3-preview.elastic.dev/elastic/ecs/pull/2567/reference/ |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
🔍 Preview links for changed docs |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Entity field set documentation to add two new entity types (cloud and orchestrator), enable usage at the root level of events, and introduce self-nesting via entity.target.
Key changes:
- Added
cloudandorchestratoras new allowed values forentity.type - Changed guidance to allow entity fields at the root of events (previously not expected)
- Added
entity.targetto allow entity fields to be nested under themselves
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/reference/ecs-entity.md | Updates field reuse locations, allows root-level usage, and adds entity.target nesting section |
| docs/reference/ecs-allowed-values-entity-type.md | Adds documentation for two new entity.type values: cloud and orchestrator |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…d entity.target self-nesting
docs/reference/ecs-entity.md
Outdated
| * `service.entity` | ||
| * `user.entity` | ||
|
|
||
| Note also that the `entity` fields are not expected to be used directly at the root of the events. |
There was a problem hiding this comment.
this needs to be removed
schemas/entity.yml
Outdated
| action taken. | ||
| root: false | ||
| reusable: | ||
| top_level: false |
There was a problem hiding this comment.
also this should be true
|
@trisch-me - feels like a lot of auto generated files, let me know if that's expected. |
trisch-me
left a comment
There was a problem hiding this comment.
lgtm except small refinement
Co-authored-by: Alexandra Konrad <alexandra.konrad@elastic.co>
1. What does this PR do?
This PR updates the Entity field set documentation to add two new entity types (cloud and orchestrator), enable usage at the root level of events, and introduce self-nesting via
entity.target.2. Which ECS fields are affected/introduced?
Added cloud and orchestrator as new allowed values for
entity.typeChanged guidance to allow entity fields at the root of events (previously not expected)
Added
entity.targetto allow entity fields to be nested under themselves.3. Why is this change necessary?
Clarify the nested target use.
Adds new supported types to
entity.type4. Have you added/updated documentation?
YES
5. Have you built ECS and committed any newly generated files?
YES
6. Have you run the ECS validation tests locally?
YES
7. Anything else for the reviewers?
Commit Message
Added cloud and orchestrator as new allowed values for
entity.typeChanged guidance to allow entity fields at the root of events (previously not expected)
Added
entity.targetto allow entity fields to be nested under themselves.