Skip to content

Add container_spec_memory_limit_bytes metric #9140

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 24, 2025
Merged

Add container_spec_memory_limit_bytes metric #9140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb9223f
Add container_spec_memory_limit_bytes metric
Apr 23, 2025
68fe193
Remove unused imports
Apr 23, 2025
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
5 changes: 5 additions & 0 deletions internal/lib/stats/descriptors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ var (
Help: "Container swap usage in bytes.",
LabelKeys: baseLabelKeys,
}
containerSpecMemoryLimitBytes = &types.MetricDescriptor{
Name: "container_spec_memory_limit_bytes",
Help: "Memory limit for the container in bytes.",
LabelKeys: baseLabelKeys,
}
containerMemoryFailcnt = &types.MetricDescriptor{
Name: "container_memory_failcnt",
Help: "Number of memory usage hits limits",
Expand Down
17 changes: 17 additions & 0 deletions internal/lib/stats/memory_metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ import (
"github.com/cri-o/cri-o/internal/oci"
)

// Size after which we consider memory to be "unlimited". This is not
// MaxInt64 due to rounding by the kernel.
const maxMemorySize = uint64(1 << 62)

func generateSandboxMemoryMetrics(sb *sandbox.Sandbox, mem *cgmgr.MemoryStats) []*types.Metric {
memoryMetrics := []*containerMetric{
{
Expand Down Expand Up @@ -40,6 +44,19 @@ func generateSandboxMemoryMetrics(sb *sandbox.Sandbox, mem *cgmgr.MemoryStats) [
return metricValues{{value: mem.SwapUsage, metricType: types.MetricType_GAUGE}}
},
},
{
desc: containerSpecMemoryLimitBytes,
valueFunc: func() metricValues {
// For consistency with cAdvisor and Kubernetes, consider memory to be "unlimited"
// when above a certain threshold (2^62) and report it as 0 in the metrics.
// This approach is more useful for monitoring tools than reporting the physical limit.
limit := mem.Limit
if limit > maxMemorySize {
return metricValues{{value: 0, metricType: types.MetricType_GAUGE}}
}
return metricValues{{value: limit, metricType: types.MetricType_GAUGE}}
},
},
{
desc: containerMemoryFailcnt,
valueFunc: func() metricValues {
Expand Down
1 change: 1 addition & 0 deletions internal/lib/stats/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ func (ss *StatsServer) PopulateMetricDescriptors(includedKeys []string) map[stri
containerMemoryKernelUsage,
containerMemoryMappedFile,
containerMemorySwap,
containerSpecMemoryLimitBytes,
containerMemoryFailcnt,
containerMemoryUsageBytes,
containerMemoryMaxUsageBytes,
Expand Down