Skip to content

Commit 32f7390

Browse files
dedemortondedemorton
authored
Port #4186 to serverless (#4225)
* Port #4186 to serverless * Fix attribute reference
1 parent 6d5601b commit 32f7390

11 files changed

+246
-32
lines changed

‎docs/en/serverless/images/logs-overlay-containers.png‎

155 KB
Loading

‎docs/en/serverless/images/metadata-overlay-containers.png‎

66.3 KB
Loading

‎docs/en/serverless/images/metrics-overlay-containers.png‎

47.9 KB
Loading

‎docs/en/serverless/images/overview-overlay-containers.png‎

73.7 KB
Loading

‎docs/en/serverless/infra-monitoring/analyze-hosts.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tags: [ 'serverless', 'observability', 'how to' ]
88

99
import HostDetails from '../transclusion/host-details.mdx'
1010

11+
import ContainerDetails from '../transclusion/container-details.mdx'
12+
1113
<div id="analyze-hosts"></div>
1214

1315
<DocCallOut template="beta" />

‎docs/en/serverless/infra-monitoring/container-metrics.mdx‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
slug: /serverless/observability/container-metrics
3+
title: Container metrics
4+
description: Learn about key container metrics used for container monitoring.
5+
tags: [ 'serverless', 'observability', 'reference' ]
6+
---
7+
8+
<p><DocBadge template="technical preview" /></p>
9+
10+
<div id="container-metrics"></div>
11+
12+
Learn about key container metrics displayed in the Infrastructure UI:
13+
14+
* <DocLink slug="/serverless/observability/container-metrics" section="key-metrics-docker">Docker</DocLink>
15+
* <DocLink slug="/serverless/observability/container-metrics" section="key-metrics-kubernetes">Kubernetes</DocLink>
16+
17+
18+
<div id="key-metrics-docker"></div>
19+
20+
## Docker container metrics
21+
22+
These are the key metrics displayed for Docker containers.
23+
24+
<div id="key-metrics-docker-cpu"></div>
25+
26+
### CPU usage metrics
27+
28+
<DocTable columns={[
29+
{
30+
"title": "Metric",
31+
"width": "30%"
32+
},
33+
{
34+
"title": "Description",
35+
"width": "70%"
36+
}
37+
]}>
38+
<DocRow>
39+
<DocCell>**CPU Usage (%)**</DocCell>
40+
<DocCell>
41+
Average CPU for the container.
42+
43+
**Field Calculation:** `average(docker.cpu.total.pct)`
44+
</DocCell>
45+
</DocRow>
46+
</DocTable>
47+
48+
<div id="key-metrics-docker-memory"></div>
49+
50+
### Memory metrics
51+
52+
<DocTable columns={[
53+
{
54+
"title": "Metric",
55+
"width": "30%"
56+
},
57+
{
58+
"title": "Description",
59+
"width": "70%"
60+
}
61+
]}>
62+
<DocRow>
63+
<DocCell>**Memory Usage (%)**</DocCell>
64+
<DocCell>
65+
Average memory usage for the container.
66+
67+
**Field Calculation:** `average(docker.memory.usage.pct)`
68+
</DocCell>
69+
</DocRow>
70+
</DocTable>
71+
72+
<div id="key-metrics-docker-network"></div>
73+
74+
### Network metrics
75+
76+
<DocTable columns={[
77+
{
78+
"title": "Metric",
79+
"width": "30%"
80+
},
81+
{
82+
"title": "Description",
83+
"width": "70%"
84+
}
85+
]}>
86+
<DocRow>
87+
<DocCell>**Inbound Traffic (RX)**</DocCell>
88+
<DocCell>Derivative of the maximum of `docker.network.in.bytes` scaled to a 1 second rate.</DocCell>
89+
</DocRow>
90+
<DocRow>
91+
<DocCell>**Outbound Traffic (TX)**</DocCell>
92+
<DocCell>Derivative of the maximum of `docker.network.out.bytes` scaled to a 1 second rate.</DocCell>
93+
</DocRow>
94+
</DocTable>
95+
96+
<div id="key-metrics-kubernetes"></div>
97+
98+
## Kubernetes container metrics
99+
100+
These are the key metrics displayed for Kubernetes (containerd) containers.
101+
102+
<div id="key-metrics-kubernetes-cpu"></div>
103+
104+
### CPU usage metrics
105+
106+
<DocTable columns={[
107+
{
108+
"title": "Metric",
109+
"width": "30%"
110+
},
111+
{
112+
"title": "Description",
113+
"width": "70%"
114+
}
115+
]}>
116+
<DocRow>
117+
<DocCell>**CPU Usage (%)**</DocCell>
118+
<DocCell>
119+
Average CPU for the container.
120+
121+
**Field Calculation:** `average(kubernetes.container.cpu.usage.limit.pct)`
122+
</DocCell>
123+
</DocRow>
124+
</DocTable>
125+
126+
<div id="key-metrics-kubernetes-memory"></div>
127+
128+
### Memory metrics
129+
130+
<DocTable columns={[
131+
{
132+
"title": "Metric",
133+
"width": "30%"
134+
},
135+
{
136+
"title": "Description",
137+
"width": "70%"
138+
}
139+
]}>
140+
<DocRow>
141+
<DocCell>**Memory Usage (%)**</DocCell>
142+
<DocCell>
143+
Average memory usage for the container.
144+
145+
**Field Calculation:** `average(kubernetes.container.memory.usage.limit.pct)`
146+
</DocCell>
147+
</DocRow>
148+
</DocTable>

‎docs/en/serverless/infra-monitoring/docker-container-metrics.mdx‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎docs/en/serverless/infra-monitoring/metrics-reference.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ are calculated.
1414

1515
* <DocLink slug="/serverless/observability/host-metrics">Host metrics</DocLink>
1616
* <DocLink slug="/serverless/observability/kubernetes-pod-metrics">Kubernetes pod metrics</DocLink>
17-
* <DocLink slug="/serverless/observability/docker-container-metrics">Docker container metrics</DocLink>
17+
* <DocLink slug="/serverless/observability/container-metrics">Container metrics</DocLink>
1818
* <DocLink slug="/serverless/observability/aws-metrics">AWS metrics</DocLink>

‎docs/en/serverless/infra-monitoring/view-infrastructure-metrics.mdx‎

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ tags: [ 'serverless', 'observability', 'how to' ]
99

1010
import HostDetails from '../transclusion/host-details.mdx'
1111

12+
import ContainerDetails from '../transclusion/container-details.mdx'
13+
1214
<div id="view-infrastructure-metrics"></div>
1315

1416
The **Inventory** page provides a metrics-driven view of your entire infrastructure grouped by
@@ -39,10 +41,10 @@ Need help getting started? Follow the steps in
3941
To get started with your analysis, select the type of resources you want to show
4042
in the high-level view. From the **Show** menu, select one of the following:
4143

42-
* **Hosts** (the default)
44+
* **Hosts** — the default
4345
* **Kubernetes Pods**
44-
* **Docker Containers**
45-
* **AWS**, which includes EC2 instances, S3 buckets, RDS databases, and SQS queues
46+
* **Docker Containers** — shows _all_ containers, not just Docker
47+
* **AWS** — includes EC2 instances, S3 buckets, RDS databases, and SQS queues
4648

4749
When you hover over each resource in the waffle map, the metrics specific to
4850
that resource are displayed.
@@ -84,6 +86,36 @@ These metrics are also available when viewing hosts on the **Hosts**
8486
page.
8587
</DocCallOut>
8688

89+
<div id="analyze-containers-inventory"></div>
90+
91+
## View container metrics
92+
93+
When you select **Docker containers**, the **Inventory** page displays a waffle map that shows the containers you
94+
are monitoring and the current CPU usage for each container.
95+
Alternatively, you can click the **Table view** icon <DocImage flatImage alt="Table view icon" url="../images/table-view-icon.png" />
96+
to switch to a table view.
97+
98+
Without leaving the **Inventory** page, you can view enhanced metrics relating to each container
99+
running in your infrastructure.
100+
101+
<DocCallOut title="Why do some containers report 0% or null (-) values in the waffle map?">
102+
The waffle map shows _all_ monitored containers, including containerd,
103+
provided that the data collected from the container has the `container.id` field.
104+
However, the waffle map currently only displays metrics for Docker fields.
105+
This display problem will be resolved in a future release.
106+
</DocCallOut>
107+
108+
On the waffle map, select a container to display the container details
109+
overlay.
110+
111+
<DocCallOut title="Tip">
112+
To expand the overlay and view more detail, click **Open as page** in the upper-right corner.
113+
</DocCallOut>
114+
115+
The container details overlay contains the following tabs:
116+
117+
<ContainerDetails />
118+
87119
<div id="analyze-resource-metrics"></div>
88120

89121
## View metrics for other resources

‎docs/en/serverless/serverless-observability.docnav.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -391,12 +391,12 @@
391391
"classic-sources": ["enObservabilityHostMetrics"]
392392
},
393393
{
394-
"slug": "/serverless/observability/kubernetes-pod-metrics",
395-
"classic-sources": ["enObservabilityKubernetesPodMetrics"]
394+
"slug": "/serverless/observability/container-metrics",
395+
"classic-sources": ["enObservabilityDockerContainerMetrics"]
396396
},
397397
{
398-
"slug": "/serverless/observability/docker-container-metrics",
399-
"classic-sources": ["enObservabilityDockerContainerMetrics"]
398+
"slug": "/serverless/observability/kubernetes-pod-metrics",
399+
"classic-sources": ["enObservabilityKubernetesPodMetrics"]
400400
},
401401
{
402402
"slug": "/serverless/observability/aws-metrics",

0 commit comments

Comments
 (0)