[Inventory] Create new Inventory docs

[alaudazzi]

Description

This PR adds a new page on Inventory explaining what this feature is and how to use it.

Documentation sets edited in this PR

Check all that apply.

• Stateful (docs/en/observability/*)
• Serverless (docs/en/serverless/*)
• Integrations Developer Guide (docs/en/integrations/*)
• None of the above

Related issues

• [Request]: Create new inventory docs and remove docs for new service inventory #4254
• [Inventory] Remove the new services inventory docs #4342

Checklist

• Initial draft updates
• Product/Engineering Review
• Writer Review

Follow-up tasks

Select one.

• This PR does not need to be ported to another doc set because:
  • The concepts in this PR only apply to one doc set (serverless or stateful)
  • The PR contains edits to both doc sets (serverless and stateful)
• This PR needs to be ported to another doc set:
  • Port to stateful docs: [Inventory] Port #4341 to stateful docs #4348
  • Port to serverless docs: <link to PR or tracking issue>

[github-actions]

A documentation preview will be available soon.

• 🔨 Buildkite builds
• 📚 HTML diff
• 📙 Preview page

Request a new doc build by commenting

• Rebuild this PR: run docs-build
• Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.}

[mergify]

This pull request does not have a backport label. Could you fix it @alaudazzi? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

• backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
  NOTE: backport-skip has been added to this pull request.

[roshan-elastic]

Hey @alaudazzi - looking good!

I have a few suggestions to tweak for now (mainly based on what is available right now):

From there, you can monitor and understand the health of your entities, check what needs attention and start your investigations.

I'm wondering if it's best practice to talk about upcoming functionality that isn't available? The above will be true but just for an iteration. I'll take your lead on this.

but it can scale to support all of your entities.

Same as above. It doesn't yet but it will (we'll start by incrementally adding new entities ourselves, like K8s, but it won't scale to support all entities for a few months).

Is it OK to say that it 'will' scale to support all of your entities?

Hosts: Anything where host.name is set in a metrics-* or logs-* index
Containers: Anything where container.id is set in a metrics-* or logs-* index
Services: Anything where service.name is set in a apm-* or logs-* index

I'm wondering whether it makes sense to put these in a separate entity section (which would be a catalogue of all OOTB entities)? I'm guessing you thought of this but it makes more sense to keep it simple and specify that here for now?

Understand what needs attention by easily seeing what entities are alerting

Same as above. This will come in the next iteration but not yet. Given not many people will read this - I'm OK with keeping it like this if you think it's best practice from a docs POV?

Drill down into any host, container or services with curated entity views to help you understand performance

I'm thinking it might be better to remove 'with curated entity views'? You'll be able to drill down into any entity in the list (all currently have curated views but new entities will likely use dashboards for a while until we can make the curated view a template).

Explore the entities catalog

Do you think we could rename this as 'Explore your entities'? I'm worried users might think the entities catalog is another feature.

[alaudazzi]

Thank you for your feedback, @roshan-elastic!
I'll have a second pass and ping you as soon as the next draft is available. And I'm going to get a working doc preview for you :-)

[alaudazzi]

@roshan-elastic do we need to include these concepts?

• Summary ‘Mode’ vs Performance ‘Mode’
• Indication of entity status, for example: alerts, SLOs, anomalies.

[roshan-elastic]

Hey @alaudazzi - I would only include what we've shipped for now to keep it really light.

[colleenmcginnis]

@alaudazzi can you try these changes? I think that should fix the build.

[elasticdocs]

🚀 Built elastic-dot-co-docs-preview-docs successfully!

• https://elastic-dot-co-docs-production-jgu7qb2lj-elastic-dev.vercel.app

• Built with commit 0b3810e

Issues? Visit #next-docs in Slack

[alaudazzi]

@roshan-elastic
I integrated your comments, and elaborated a bit more on the part related to how the definitions for each entity are detected. This is a doc preview. Other than some minor formatting, please let me know if more changes are required.

[roshan-elastic]

Hey @alaudazzi,

Looking good - just a few tweaks. Hopefully these are straight copy changes if you're OK with that?

In your Observability project, go to Inventory to open the entities catalog.

In your Observability project, go to Inventory to view all of your entities.

If you have Admin privileges, the EEM will be turned on automatically. Otherwise, you need to ask someone with Admin privileges to turn on this feature under Stack Management.

When you open the Inventory for the first time, you will need to enable the Elastic Entity Model in order to use it. Once enabled, the Inventory will be useable for everyone with the correct privileges to access Inventory.

Note that the Inventory feature can be completely disabled using the 'observability:entityCentricExperience' flag in Stack Management.

For each entity, you can either view your data in Discover, or click the entity name and get a detailed view. For example, for an entity of type service, you get the following details:

For each entity, you can either view click the entity name and get a detailed view. For example, for an entity of type service, you get the following details:

Entities are added to the inventory through one of the following approaches:

Add data

Auto-detect logs and metrics Detects hosts (with metrics and logs)
Kubernetes Detects hosts, containers and services
Elastic APM / OpenTelemetry / Synthetic Monitor Detects services

Entities are added to the inventory through one of the following approaches:

Add data
You can add entities using the following onboarding journeys via the left-hand navigation item 'Add data':

• Auto-detect logs and metrics: Detects hosts (with metrics and logs)
• Kubernetes: Detects hosts, containers and services
• Elastic APM / OpenTelemetry / Synthetic Monitor: Detects services

[alaudazzi]

@roshan-elastic
Thank you for your feedback! I integrated your comments and added some more edits.
Here is the latest doc preview.

[roshan-elastic]

LGTM! Thanks @alaudazzi

[mdbirnstiehl]

Just a few suggestions for you to take or leave.

[mdbirnstiehl]

🚀