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

[8.x](backport #4438) Port #4341 to stateful docs: Add new page on inventory #4457

Merged
merged 1 commit into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ To get started with the Applications UI:
<<apm-machine-learning-integration,machine learning>>.

include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/ui-overview/index.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/inventory.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/drill-down/index.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/filter-and-search/index.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/interpret/index.asciidoc[leveloffset=+1]
Expand Down
90 changes: 90 additions & 0 deletions docs/en/observability/apm/view-and-analyze/inventory.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
[[inventory]]
= Inventory

++++
<titleabbrev>Inventory</titleabbrev>
++++

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.

NOTE: The new Inventory requires the Elastic Entity Model (EEM). To learn more, refer to <<elastic-entity-model>>.

[role="screenshot"]
image::./images/inventory-catalog.png[Inventory catalog]

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

[float]
[[explore-your-entities]]
== Explore your entities

. In your Observability project, go to **Inventory** to view all of your entities.
+
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**.

. 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

[role="screenshot"]
image::./images/inventory-entity-detailed-view.png[Inventory detailed view]

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.

[float]
[[add-entities-to-inventory]]
== Add entities to the Inventory

You can add entities to the Inventory through one of the following approaches: **Add data** or **Associate existing service logs**.

[float]
[[add-data-entities]]
== Add data

To add entities, select **Add data** from the left-hand navigation and choose one of the following onboarding journeys:

- **Auto-detect logs and metrics**
Detects hosts (with metrics and logs)

- **Kubernetes**
Detects hosts, containers, and services

- **Elastic APM / OpenTelemetry / Synthetic Monitor**
Detects services
Associate existing service logs

To learn how, refer to <<add-logs-service-name>>.