-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update infrastructure monitoring docs about containers (#4186)
* Update infrastructure monitoring docs about containers * Apply changes from review * Revert to 8.15 level info about container metrics * Apply suggestions from code review Fix containerd references. --------- Co-authored-by: Colleen McGinnis <[email protected]> (cherry picked from commit 38b0630)
- Loading branch information
1 parent
f8db6db
commit 7874e91
Showing
10 changed files
with
196 additions
and
26 deletions.
There are no files selected for viewing
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.
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.
71 changes: 71 additions & 0 deletions
71
docs/en/observability/monitor-infra/container-details-partial.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
// This is collapsed by default | ||
[%collapsible] | ||
.*Overview* | ||
==== | ||
|
||
The *Overview* tab displays key metrics about the selected container, such as CPU usage and memory usage. | ||
The metrics shown may vary depending on the type of container you're monitoring. | ||
|
||
Change the time range to view metrics over a specific period of time. | ||
|
||
Expand each section to view more detail related to the selected container, such as metadata, | ||
active alerts, and metrics. | ||
|
||
Hover over a specific time period on a chart to compare the various metrics at that given time. | ||
|
||
Click **Show all** to drill down into related data. | ||
|
||
[role="screenshot"] | ||
image::images/overview-overlay-containers.png[Container overview] | ||
==== | ||
|
||
[%collapsible] | ||
.*Metadata* | ||
==== | ||
|
||
The *Metadata* tab lists all the meta information relating to the container: | ||
|
||
* Host information | ||
* Cloud information | ||
* Agent information | ||
All of this information can help when investigating events—for example, filtering by operating system or architecture. | ||
|
||
[role="screenshot"] | ||
image::images/metadata-overlay-containers.png[Container metadata] | ||
==== | ||
|
||
[%collapsible] | ||
.*Metrics* | ||
==== | ||
|
||
The *Metrics* tab shows container metrics organized by type. | ||
|
||
[role="screenshot"] | ||
image::images/metrics-overlay-containers.png[Metrics] | ||
==== | ||
|
||
[%collapsible] | ||
.*Logs* | ||
==== | ||
|
||
The *Logs* tab displays logs relating to the container that you have selected. By default, the logs tab displays the following columns. | ||
|
||
|=== | ||
|
||
| *Timestamp* | The timestamp of the log entry from the `timestamp` field. | ||
|
||
| *Message* | The message extracted from the document. | ||
The content of this field depends on the type of log message. | ||
If no special log message type is detected, the {ecs-ref}/ecs-base.html[Elastic Common Schema (ECS)] | ||
base field, `message`, is used. | ||
|
||
|=== | ||
|
||
You can customize the logs view by adding a column for an arbitrary field you would like | ||
to filter by. For more information, refer to <<customize-stream-page,Customize Stream>>. | ||
To view the logs in the {logs-app} for a detailed analysis, click *Open in Logs*. | ||
|
||
[role="screenshot"] | ||
image::images/logs-overlay-containers.png[Container logs] | ||
==== |
84 changes: 84 additions & 0 deletions
84
docs/en/observability/monitor-infra/container-metrics.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
[[container-metrics]] | ||
= Container metrics | ||
|
||
Learn about key container metrics displayed in the {infrastructure-app}: | ||
|
||
* <<key-metrics-docker,Docker>> | ||
* <<key-metrics-kubernetes,Kubernetes>> | ||
|
||
[discrete] | ||
[[key-metrics-docker]] | ||
== Docker container metrics | ||
|
||
These are the key metrics displayed for Docker containers. | ||
|
||
[discrete] | ||
[[key-metrics-docker-cpu]] | ||
=== CPU usage metrics | ||
|
||
[options="header"] | ||
|=== | ||
| Metric | Description | ||
|
||
| **CPU Usage (%)** | Average CPU for the container. | ||
|
||
**Field Calculation:** `average(docker.cpu.total.pct)` | ||
|=== | ||
|
||
[discrete] | ||
[[key-metrics-docker-memory]] | ||
=== Memory metrics | ||
|
||
[options="header"] | ||
|=== | ||
| Metric | Description | ||
|
||
|**Memory Usage (%)** | Average memory usage for the container. | ||
|
||
**Field Calculation:** `average(docker.memory.usage.pct)` | ||
|=== | ||
|
||
[discrete] | ||
[[key-metrics-docker-network]] | ||
=== Network metrics | ||
|
||
[options="header"] | ||
|=== | ||
| Metric | Description | ||
|
||
| **Inbound Traffic (RX)** | Derivative of the maximum of `docker.network.in.bytes` scaled to a 1 second rate. | ||
|
||
| **Outbound Traffic (TX)** | Derivative of the maximum of `docker.network.out.bytes` scaled to a 1 second rate. | ||
|=== | ||
|
||
[discrete] | ||
[[key-metrics-kubernetes]] | ||
== Kubernetes container metrics | ||
|
||
These are the key metrics displayed for Kubernetes (containerd) containers. | ||
|
||
[discrete] | ||
[[key-metrics-kubernetes-cpu]] | ||
=== CPU usage metrics | ||
|
||
[options="header"] | ||
|=== | ||
| Metric | Description | ||
|
||
| **CPU Usage (%)** | Average CPU for the container. | ||
|
||
**Field Calculation:** `average(kubernetes.container.cpu.usage.limit.pct)` | ||
|=== | ||
|
||
[discrete] | ||
[[key-metrics-kubernetes-memory]] | ||
=== Memory metrics | ||
|
||
[options="header"] | ||
|=== | ||
| Metric | Description | ||
|
||
|**Memory Usage (%)** | Average memory usage for the container. | ||
|
||
**Field Calculation:** `average(kubernetes.container.memory.usage.limit.pct)` | ||
|=== |
20 changes: 0 additions & 20 deletions
20
docs/en/observability/monitor-infra/docker-container-metrics.asciidoc
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters