Skip to content

Conversation

@uri-weisman
Copy link

@uri-weisman uri-weisman commented Nov 11, 2025

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.type
Changed guidance to allow entity fields at the root of events (previously not expected)
Added entity.target to 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.type

4. 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.type
Changed guidance to allow entity fields at the root of events (previously not expected)
Added entity.target to allow entity fields to be nested under themselves.

@uri-weisman uri-weisman requested a review from a team as a code owner November 11, 2025 09:04
@github-actions
Copy link

Documentation changes preview: https://docs-v3-preview.elastic.dev/elastic/ecs/pull/2567/reference/

@github-actions
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@github-actions
Copy link

github-actions bot commented Nov 11, 2025

🔍 Preview links for changed docs

Copilot finished reviewing on behalf of uri-weisman November 11, 2025 09:07
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 cloud and orchestrator as new allowed values for entity.type
  • Changed guidance to allow entity fields at the root of events (previously not expected)
  • Added entity.target to 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.

* `service.entity`
* `user.entity`

Note also that the `entity` fields are not expected to be used directly at the root of the events.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this needs to be removed

action taken.
root: false
reusable:
top_level: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also this should be true

@uri-weisman
Copy link
Author

@trisch-me - feels like a lot of auto generated files, let me know if that's expected.

Copy link
Contributor

@trisch-me trisch-me left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm except small refinement

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants