1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
from datetime import timedelta
import numpy as np
import pydantic as pd
from robusta_krr.core.abstract.strategies import (
BaseStrategy,
K8sWorkload,
MetricsPodData,
PodsTimeData,
ResourceRecommendation,
ResourceType,
RunResult,
StrategySettings,
)
from robusta_krr.core.integrations.prometheus.metrics import (
CPUAmountLoader,
MaxMemoryLoader,
MemoryAmountLoader,
PercentileCPULoader,
PrometheusMetric,
MaxOOMKilledMemoryLoader,
)
class SimpleStrategySettings(StrategySettings):
cpu_percentile: float = pd.Field(99, gt=0, le=100, description="The percentile to use for the CPU recommendation.")
memory_buffer_percentage: float = pd.Field(
15, gt=0, description="The percentage of added buffer to the peak memory usage for memory recommendation."
)
points_required: int = pd.Field(
100, ge=1, description="The number of data points required to make a recommendation for a resource."
)
allow_hpa: bool = pd.Field(
False,
description="Whether to calculate recommendations even when there is an HPA scaler defined on that resource.",
)
use_oomkill_data: bool = pd.Field(
False,
description="Whether to bump the memory when OOMKills are detected (experimental).",
)
oom_memory_buffer_percentage: float = pd.Field(
25, gt=0, description="What percentage to increase the memory when there are OOMKill events."
)
def calculate_memory_proposal(self, data: PodsTimeData, max_oomkill: float = 0) -> float:
data_ = [np.max(values[:, 1]) for values in data.values()]
if len(data_) == 0:
return float("NaN")
return max(
np.max(data_) * (1 + self.memory_buffer_percentage / 100),
max_oomkill * (1 + self.oom_memory_buffer_percentage / 100),
)
def calculate_cpu_proposal(self, data: PodsTimeData) -> float:
if len(data) == 0:
return float("NaN")
if len(data) > 1:
data_ = np.concatenate([values[:, 1] for values in data.values()])
else:
data_ = list(data.values())[0][:, 1]
return np.max(data_)
def history_range_enough(self, history_range: tuple[timedelta, timedelta]) -> bool:
start, end = history_range
return (end - start) >= timedelta(hours=3)
class SimpleStrategy(BaseStrategy[SimpleStrategySettings]):
"""
CPU request: {cpu_percentile}% percentile, limit: unset
Memory request: max + {memory_buffer_percentage}%, limit: max + {memory_buffer_percentage}%
History: {history_duration} hours
Step: {timeframe_duration} minutes
All parameters can be customized. For example: `krr simple --cpu_percentile=90 --memory_buffer_percentage=15 --history_duration=24 --timeframe_duration=0.5`
This strategy does not work with objects with HPA defined (Horizontal Pod Autoscaler).
If HPA is defined for CPU or Memory, the strategy will return "?" for that resource.
You can override this behaviour by passing the --allow-hpa flag
Learn more: [underline]https://github.com/robusta-dev/krr#algorithm[/underline]
"""
display_name = "simple"
rich_console = True
@property
def metrics(self) -> list[type[PrometheusMetric]]:
metrics = [
PercentileCPULoader(self.settings.cpu_percentile),
MaxMemoryLoader,
CPUAmountLoader,
MemoryAmountLoader,
]
if self.settings.use_oomkill_data:
metrics.append(MaxOOMKilledMemoryLoader)
return metrics
def __calculate_cpu_proposal(
self, history_data: MetricsPodData, object_data: K8sWorkload
) -> ResourceRecommendation:
data = history_data["PercentileCPULoader"]
if len(data) == 0:
return ResourceRecommendation.undefined(info="No data")
# NOTE: metrics for each pod are returned as list[values] where values is [timestamp, value]
# As CPUAmountLoader returns only the last value (1 point), [0, 1] is used to get the value
# So each pod is string with pod name, and values is numpy array of shape (N, 2)
data_count = {pod: values[0, 1] for pod, values in history_data["CPUAmountLoader"].items()}
total_points_count = sum(data_count.values())
if total_points_count < self.settings.points_required:
return ResourceRecommendation.undefined(info="Not enough data")
if (
object_data.hpa is not None
and object_data.hpa.target_cpu_utilization_percentage is not None
and not self.settings.allow_hpa
):
return ResourceRecommendation.undefined(info="HPA detected")
cpu_usage = self.settings.calculate_cpu_proposal(data)
return ResourceRecommendation(request=cpu_usage, limit=None)
def __calculate_memory_proposal(
self, history_data: MetricsPodData, object_data: K8sWorkload
) -> ResourceRecommendation:
data = history_data["MaxMemoryLoader"]
oomkill_detected = False
if self.settings.use_oomkill_data:
max_oomkill_data = history_data["MaxOOMKilledMemoryLoader"]
# NOTE: metrics for each pod are returned as list[values] where values is [timestamp, value]
# As MaxOOMKilledMemoryLoader returns only the last value (1 point), [0, 1] is used to get the value
# So each value is numpy array of shape (N, 2)
max_oomkill_value = (
np.max([values[0, 1] for values in max_oomkill_data.values()]) if len(max_oomkill_data) > 0 else 0
)
if max_oomkill_value != 0:
oomkill_detected = True
else:
max_oomkill_value = 0
if len(data) == 0:
return ResourceRecommendation.undefined(info="No data")
# NOTE: metrics for each pod are returned as list[values] where values is [timestamp, value]
# As MemoryAmountLoader returns only the last value (1 point), [0, 1] is used to get the value
# So each pod is string with pod name, and values is numpy array of shape (N, 2)
data_count = {pod: values[0, 1] for pod, values in history_data["MemoryAmountLoader"].items()}
total_points_count = sum(data_count.values())
if total_points_count < self.settings.points_required:
return ResourceRecommendation.undefined(info="Not enough data")
if (
object_data.hpa is not None
and object_data.hpa.target_memory_utilization_percentage is not None
and not self.settings.allow_hpa
):
return ResourceRecommendation.undefined(info="HPA detected")
memory_usage = self.settings.calculate_memory_proposal(data, max_oomkill_value)
return ResourceRecommendation(
request=memory_usage, limit=memory_usage, info="OOMKill detected" if oomkill_detected else None
)
def run(self, history_data: MetricsPodData, object_data: K8sWorkload) -> RunResult:
return {
ResourceType.CPU: self.__calculate_cpu_proposal(history_data, object_data),
ResourceType.Memory: self.__calculate_memory_proposal(history_data, object_data),
}
|
