diff --git a/redirects.yml b/redirects.yml index deed1417a6..d7f1e1ab41 100644 --- a/redirects.yml +++ b/redirects.yml @@ -46,7 +46,6 @@ redirects: 'solutions/observability/apps/service-map.md': 'solutions/observability/apm/service-map.md' 'solutions/observability/apps/service-overview.md': 'solutions/observability/apm/service-overview.md' 'solutions/observability/apps/mobile-service-overview.md': 'solutions/observability/apm/mobile-service-overview.md' - 'solutions/observability/apps/inventory.md': 'solutions/observability/apm/inventory.md' 'solutions/observability/apps/drill-down-into-data.md': 'solutions/observability/apm/drill-down-into-data.md' 'solutions/observability/apps/transactions-2.md': 'solutions/observability/apm/transactions-ui.md' 'solutions/observability/apps/trace-sample-timeline.md': 'solutions/observability/apm/trace-sample-timeline.md' diff --git a/reference/observability/elastic-entity-model.md b/reference/observability/elastic-entity-model.md deleted file mode 100644 index b49b58e0f7..0000000000 --- a/reference/observability/elastic-entity-model.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/observability/current/elastic-entity-model.html - - https://www.elastic.co/guide/en/serverless/current/observability-elastic-entity-model.html -products: - - id: observability - - id: cloud-serverless ---- - -# Elastic Entity Model [elastic-entity-model] - -::::{warning} -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -:::: - -The Elastic Entity Model consists of: - -* a data model and related entity indices -* an Entity Discovery Framework, which consists of [transforms](/explore-analyze/transforms.md) and [Ingest pipelines](/manage-data/ingest/transform-enrich/ingest-pipelines.md) 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, 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. - -::::{note} -* The Elastic Entity Model currently supports the [new Inventory experience](/solutions/observability/apm/inventory.md) limited to service, host, and container entities. -* During Technical Preview, Entity Discovery Framework components are not enabled by default. - -:::: - - - -## Enable the Elastic Entity Model [_enable_the_elastic_entity_model] - -You can enable the Elastic Entity Model from the new [Inventory](/solutions/observability/apm/inventory.md). If already enabled, you will not be prompted to enable the Elastic Entity Model. - -The following {{es}} privileges are required: - -| | | -| --- | --- | -| **Index privileges** | names: [`.entities*`], privileges: [`create_index`, `index`, `create_doc`, `auto_configure`, `read`]
names: [`logs-*`, `filebeat*`, `metrics-*`, `metricbeat*`, `traces-*`, `.entities*`], privileges: [`read`, `view_index_metadata`] | -| **Cluster privileges** | `manage_transform`, `manage_ingest_pipelines`, `manage_index_templates` | -| **Application privileges** | application: `kibana-.kibana`, privileges: [`saved_object:entity-definition/*`, `saved_object:entity-discovery-api-key/*`], resources: [*] | - -For more information, refer to [Security privileges](elasticsearch://reference/elasticsearch/security-privileges.md) in the {{es}} documentation. - - -## Disable the Elastic Entity Model [_disable_the_elastic_entity_model] - -From the Dev Console, run the command: `DELETE kbn:/internal/entities/managed/enablement` - -The following {{es}} privileges are required to delete {{es}} resources: - -| | | -| --- | --- | -| **Index privileges** | names: [`.entities*`], privileges: [`delete_index`] | -| **Cluster privileges** | `manage_transform`, `manage_ingest_pipelines`, `manage_index_templates` | -| **Application privileges** | application: `kibana-.kibana`, privileges: [`saved_object:entity-definition/delete`, `saved_object:entity-discovery-api-key/delete`], resources: [*] | - - -## Limitations [elastic-entity-model-limitations] - -* [Cross-cluster search (CCS)](/solutions/search/cross-cluster-search.md) is not supported. EEM cannot leverage data stored on a remote cluster. -* Services are only detected from documents where `service.name` is detected in index patterns that match either `logs-*` or `apm-*`. diff --git a/reference/observability/toc.yml b/reference/observability/toc.yml index 27b7ec4f93..c728690f3c 100644 --- a/reference/observability/toc.yml +++ b/reference/observability/toc.yml @@ -1,4 +1,3 @@ toc: - file: index.md - - file: fields-and-object-schemas.md - - hidden: elastic-entity-model.md \ No newline at end of file + - file: fields-and-object-schemas.md \ No newline at end of file diff --git a/solutions/observability/apm/inventory.md b/solutions/observability/apm/inventory.md deleted file mode 100644 index 3138e56c72..0000000000 --- a/solutions/observability/apm/inventory.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -navigation_title: Inventory -mapped_pages: - - https://www.elastic.co/guide/en/observability/current/inventory.html - - https://www.elastic.co/guide/en/serverless/current/observability-inventory.html -applies_to: - stack: - serverless: -products: - - id: observability - - id: apm - - id: cloud-serverless ---- - -# Inventory [inventory] - -::::{note} -The new Inventory requires the Elastic Entity Model (EEM). To learn more, refer to [Elastic Entity Model](/reference/observability/elastic-entity-model.md). -:::: - -Inventory provides a single place to observe the status of your entire ecosystem of hosts, containers, and services at a glance, even just from logs. From there, you can monitor and understand the health of your entities, check what needs attention, and start your investigations. - -:::{image} /solutions/images/observability-inventory-catalog.png -:alt: Inventory catalog -:screenshot: -::: - -Inventory is currently available for hosts, containers, and services, but it will scale to support all of your entities. - -The EEM currently supports the inventory experience (as identified by `host.name`, `service.name`, and `container.id`) located in data identified by the following index patterns: - -**Hosts** - -Where `host.name` is set in `metrics-*`, `logs-*`, `filebeat-*`, and `metricbeat-*` - -**Services** - -Where `service.name` is set in `filebeat*`, `logs-*`, `metrics-apm.service_transaction.1m*`, and `metrics-apm.service_summary.1m*` - -**Containers** - -Where `container.id` is set in `metrics-*`, `logs-*`, `filebeat-*`, and `metricbeat-*` - -Inventory allows you to: - -* Filter for your entities to provide a high-level view of what you have leveraging your own tags and labels -* Drill down into any host, container, or service to help you understand performance -* Debug resource bottlenecks with your service caused by their containers and the hosts they run on. -* Easily discover all entities related to the host, container or service you are viewing by leveraging your tags and labels - -## Explore your entities [explore-your-entities] - -1. To view all your entities, find **Inventory** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). - - When you open the Inventory for the first time, you’ll be asked to enable the EEM. Once enabled, the Inventory will be accessible to anyone with the appropriate privileges. - - ::::{note} - The Inventory feature can be completely disabled using the `observability:entityCentricExperience` flag in **Stack Management**. - :::: - -2. In the search bar, search for your entities by name or type, for example `entity.type:service`. - -For each entity, you can click the entity name and get a detailed view. For example, for an entity of type service, you get the following details: - -* Overview -* Transactions -* Dependencies -* Errors -* Metrics -* Infrastructure -* Service Map -* Logs -* Alerts -* Dashboards - -:::{image} /solutions/images/observability-inventory-entity-detailed-view.png -:alt: Inventory detailed view -:screenshot: -::: - -If you open an entity of type `host` or `container` that does not have infrastructure data, some of the visualizations will be blank and some features on the page will not be fully populated. - -## Add entities to the Inventory [add-entities-to-inventory] - -You can add entities to the Inventory through one of the following approaches: **Add data** or **Associate existing service logs**. - -## Add data [add-data-entities] - -To add entities, select **Add data** and choose one of the following onboarding journeys: - -* **Host** Detects hosts (with metrics and logs) -* **Kubernetes** Detects hosts, containers, and services -* **Application** Detects services -* **Cloud** Ingests telemetry data from the Cloud - -## Associate existing service logs [associate-existing-service-logs] - -To learn how, refer to [Add a service name to logs](../logs/add-service-name-to-logs.md). diff --git a/solutions/toc.yml b/solutions/toc.yml index c8dfae1cba..c35b004329 100644 --- a/solutions/toc.yml +++ b/solutions/toc.yml @@ -152,7 +152,6 @@ toc: - file: observability/apm/service-map.md - file: observability/apm/service-overview.md - file: observability/apm/mobile-service-overview.md - - hidden: observability/apm/inventory.md - file: observability/apm/drill-down-into-data.md children: - file: observability/apm/transactions-ui.md