Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Inventory] Update EEM docs to reflect new inventory #4340

Merged
merged 4 commits into from
Oct 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/en/serverless/elastic-entity-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,24 @@ The Elastic Entity Model consists of:
- an Entity Discovery Framework, which consists of [transforms](((ref))/transforms.html) and [Ingest pipelines](((ref))/ingest.html) that read from signal indices and write data to entity indices
- a set of management APIs that empower entity-centric Elastic solution features and workflows

In the context of Elastic Observability,
In Elastic Observability,
an _entity_ is an object of interest that can be associated with produced telemetry and identified as unique.
Note that this definition is intentionally closely aligned to the work of the [OpenTelemetry Entities SIG](https://github.com/open-telemetry/oteps/blob/main/text/entities/0256-entities-data-model.md#data-model).
Examples of entities include (but are not limited to) services, hosts, and containers.

The concept of an entity is important as a means to unify observability signals based on the underlying entity that the signals describe.

<DocCallOut title="Notes">
- The Elastic Entity Model currently supports the <DocLink slug="/serverless/observability/new-experience-services">new service inventory experience</DocLink> limited to service-based entities (as identified by `service.name`) located in data identified by `logs-*` and `filebeat*` index patterns
- During Technical Preview, Entity Discovery Framework components are not enabled by default
- The Elastic Entity Model currently supports the <DocLink slug="/serverless/observability/inventory">new inventory experience</DocLink> limited to service, host, and container entities.
- During Technical Preview, Entity Discovery Framework components are not enabled by default.
</DocCallOut>

## Enable the Elastic Entity Model

<Roles role="Admin" goal="enable the Elastic Entity Model" />

During Technical Preview,
the Elastic Entity Model is enabled when you turn on the entity-centric service inventory described in <DocLink slug="/serverless/observability/new-experience-services" />.
You can enable the Elastic Entity Model from the new <DocLink slug="/serverless/observability/inventory">Inventory</DocLink>. If already enabled, you will not be prompted to enable the Elastic Entity Model.


## Disable the Elastic Entity Model

Expand Down
Loading