elastic / observability-docs

Elastic Observability Documentation
Other
33 stars 161 forks source link

[Request]: Update Container Documentation #3862

Open roshan-elastic opened 5 months ago

roshan-elastic commented 5 months ago

Description

Placeholder : Please don't start yet - we need to confirm that we can rename 'Docker Containers' as 'Containers' in our UI before we make this change

This issue is to update our documentation to reflect that our UI is showing 'Containers' and there are two different types of containers...Docker and K8s.

Docker Container Metrics Inventory Inventory Alert Rules (doesn't specifically refer to types of Inventory so changes may not be needed here)

Context

We are migrating our container views from an older template (example) to the same one Hosts uses (example).

However, we have found that references to 'Docker Container' in our UI are actually showing Kubernetes containers too (we show both and then conditionally show the right metric depending on which type of container it is). For example:

'Docker Containers' in Inventory

image

'Docker Container' Inventory Rules

image

Therefore, we may rename 'Docker Containers' in our UI to 'Containers' and want to update the documentation for 'Docker Containers' to reflect metrics for 'Docker Containers' and 'Kubernetes Containers' in the same docs:

https://www.elastic.co/guide/en/observability/current/docker-container-metrics.html

Additionally...as part of migrating these views to the new template we will also need to explain to users what the 'dotted lines' mean in these views:

image

In hosts, we link to https://ela.st/docs-infra-why-dotted to explain this. However, this is housed within Host-specific documentation. We probably need to refer to this in a more generic way (we don't want to repeat this guidance for every type of resource as we start to migrate other things, e.g. K8s pods, to the new template, which will all need dotted lines explaining).

Resources

This is the epic for the work:

Which documentation set does this change impact?

Stateful and Serverless

Feature differences

The feature is identical in serverless and stateful

What release is this request related to?

N/A

Collaboration model

The documentation team

Point of contact.

Main contact: @roshan-elastic @MiriamAparicio @jennypavlova

Stakeholders:

bmorelli25 commented 4 months ago

Putting in the backlog for now based on https://github.com/elastic/observability-dev/issues/3313#issuecomment-2117224012.