2
0

aggregation.go 82 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254
  1. package costmodel
  2. import (
  3. "fmt"
  4. "math"
  5. "net/http"
  6. "regexp"
  7. "sort"
  8. "strconv"
  9. "strings"
  10. "time"
  11. "github.com/kubecost/cost-model/pkg/util/timeutil"
  12. "github.com/julienschmidt/httprouter"
  13. "github.com/kubecost/cost-model/pkg/cloud"
  14. "github.com/kubecost/cost-model/pkg/env"
  15. "github.com/kubecost/cost-model/pkg/errors"
  16. "github.com/kubecost/cost-model/pkg/kubecost"
  17. "github.com/kubecost/cost-model/pkg/log"
  18. "github.com/kubecost/cost-model/pkg/prom"
  19. "github.com/kubecost/cost-model/pkg/thanos"
  20. "github.com/kubecost/cost-model/pkg/util"
  21. "github.com/kubecost/cost-model/pkg/util/json"
  22. "github.com/patrickmn/go-cache"
  23. prometheusClient "github.com/prometheus/client_golang/api"
  24. "k8s.io/klog"
  25. )
  26. const (
  27. // SplitTypeWeighted signals that shared costs should be shared
  28. // proportionally, rather than evenly
  29. SplitTypeWeighted = "weighted"
  30. // UnallocatedSubfield indicates an allocation datum that does not have the
  31. // chosen Aggregator; e.g. during aggregation by some label, there may be
  32. // cost data that do not have the given label.
  33. UnallocatedSubfield = "__unallocated__"
  34. clusterCostsCacheMinutes = 5.0
  35. )
  36. // Aggregation describes aggregated cost data, containing cumulative cost and
  37. // allocation data per resource, vectors of rate data per resource, efficiency
  38. // data, and metadata describing the type of aggregation operation.
  39. type Aggregation struct {
  40. Aggregator string `json:"aggregation"`
  41. Subfields []string `json:"subfields,omitempty"`
  42. Environment string `json:"environment"`
  43. Cluster string `json:"cluster,omitempty"`
  44. Properties *kubecost.AllocationProperties `json:"-"`
  45. Start time.Time `json:"-"`
  46. End time.Time `json:"-"`
  47. CPUAllocationHourlyAverage float64 `json:"cpuAllocationAverage"`
  48. CPUAllocationVectors []*util.Vector `json:"-"`
  49. CPUAllocationTotal float64 `json:"-"`
  50. CPUCost float64 `json:"cpuCost"`
  51. CPUCostVector []*util.Vector `json:"cpuCostVector,omitempty"`
  52. CPUEfficiency float64 `json:"cpuEfficiency"`
  53. CPURequestedVectors []*util.Vector `json:"-"`
  54. CPUUsedVectors []*util.Vector `json:"-"`
  55. Efficiency float64 `json:"efficiency"`
  56. GPUAllocationHourlyAverage float64 `json:"gpuAllocationAverage"`
  57. GPUAllocationVectors []*util.Vector `json:"-"`
  58. GPUCost float64 `json:"gpuCost"`
  59. GPUCostVector []*util.Vector `json:"gpuCostVector,omitempty"`
  60. GPUAllocationTotal float64 `json:"-"`
  61. RAMAllocationHourlyAverage float64 `json:"ramAllocationAverage"`
  62. RAMAllocationVectors []*util.Vector `json:"-"`
  63. RAMAllocationTotal float64 `json:"-"`
  64. RAMCost float64 `json:"ramCost"`
  65. RAMCostVector []*util.Vector `json:"ramCostVector,omitempty"`
  66. RAMEfficiency float64 `json:"ramEfficiency"`
  67. RAMRequestedVectors []*util.Vector `json:"-"`
  68. RAMUsedVectors []*util.Vector `json:"-"`
  69. PVAllocationHourlyAverage float64 `json:"pvAllocationAverage"`
  70. PVAllocationVectors []*util.Vector `json:"-"`
  71. PVAllocationTotal float64 `json:"-"`
  72. PVCost float64 `json:"pvCost"`
  73. PVCostVector []*util.Vector `json:"pvCostVector,omitempty"`
  74. NetworkCost float64 `json:"networkCost"`
  75. NetworkCostVector []*util.Vector `json:"networkCostVector,omitempty"`
  76. SharedCost float64 `json:"sharedCost"`
  77. TotalCost float64 `json:"totalCost"`
  78. TotalCostVector []*util.Vector `json:"totalCostVector,omitempty"`
  79. }
  80. // TotalHours determines the amount of hours the Aggregation covers, as a
  81. // function of the cost vectors and the resolution of those vectors' data
  82. func (a *Aggregation) TotalHours(resolutionHours float64) float64 {
  83. length := 1
  84. if length < len(a.CPUCostVector) {
  85. length = len(a.CPUCostVector)
  86. }
  87. if length < len(a.RAMCostVector) {
  88. length = len(a.RAMCostVector)
  89. }
  90. if length < len(a.PVCostVector) {
  91. length = len(a.PVCostVector)
  92. }
  93. if length < len(a.GPUCostVector) {
  94. length = len(a.GPUCostVector)
  95. }
  96. if length < len(a.NetworkCostVector) {
  97. length = len(a.NetworkCostVector)
  98. }
  99. return float64(length) * resolutionHours
  100. }
  101. // RateCoefficient computes the coefficient by which the total cost needs to be
  102. // multiplied in order to convert totals costs into per-rate costs.
  103. func (a *Aggregation) RateCoefficient(rateStr string, resolutionHours float64) float64 {
  104. // monthly rate = (730.0)*(total cost)/(total hours)
  105. // daily rate = (24.0)*(total cost)/(total hours)
  106. // hourly rate = (1.0)*(total cost)/(total hours)
  107. // default to hourly rate
  108. coeff := 1.0
  109. switch rateStr {
  110. case "daily":
  111. coeff = timeutil.HoursPerDay
  112. case "monthly":
  113. coeff = timeutil.HoursPerMonth
  114. }
  115. return coeff / a.TotalHours(resolutionHours)
  116. }
  117. type SharedResourceInfo struct {
  118. ShareResources bool
  119. SharedNamespace map[string]bool
  120. LabelSelectors map[string]map[string]bool
  121. }
  122. type SharedCostInfo struct {
  123. Name string
  124. Cost float64
  125. ShareType string
  126. }
  127. func (s *SharedResourceInfo) IsSharedResource(costDatum *CostData) bool {
  128. // exists in a shared namespace
  129. if _, ok := s.SharedNamespace[costDatum.Namespace]; ok {
  130. return true
  131. }
  132. // has at least one shared label (OR, not AND in the case of multiple labels)
  133. for labelName, labelValues := range s.LabelSelectors {
  134. if val, ok := costDatum.Labels[labelName]; ok && labelValues[val] {
  135. return true
  136. }
  137. }
  138. return false
  139. }
  140. func NewSharedResourceInfo(shareResources bool, sharedNamespaces []string, labelNames []string, labelValues []string) *SharedResourceInfo {
  141. sr := &SharedResourceInfo{
  142. ShareResources: shareResources,
  143. SharedNamespace: make(map[string]bool),
  144. LabelSelectors: make(map[string]map[string]bool),
  145. }
  146. for _, ns := range sharedNamespaces {
  147. sr.SharedNamespace[strings.Trim(ns, " ")] = true
  148. }
  149. // Creating a map of label name to label value, but only if
  150. // the cardinality matches
  151. if len(labelNames) == len(labelValues) {
  152. for i := range labelNames {
  153. cleanedLname := prom.SanitizeLabelName(strings.Trim(labelNames[i], " "))
  154. if values, ok := sr.LabelSelectors[cleanedLname]; ok {
  155. values[strings.Trim(labelValues[i], " ")] = true
  156. } else {
  157. sr.LabelSelectors[cleanedLname] = map[string]bool{strings.Trim(labelValues[i], " "): true}
  158. }
  159. }
  160. }
  161. return sr
  162. }
  163. func GetTotalContainerCost(costData map[string]*CostData, rate string, cp cloud.Provider, discount float64, customDiscount float64, idleCoefficients map[string]float64) float64 {
  164. totalContainerCost := 0.0
  165. for _, costDatum := range costData {
  166. clusterID := costDatum.ClusterID
  167. cpuv, ramv, gpuv, pvvs, netv := getPriceVectors(cp, costDatum, rate, discount, customDiscount, idleCoefficients[clusterID])
  168. totalContainerCost += totalVectors(cpuv)
  169. totalContainerCost += totalVectors(ramv)
  170. totalContainerCost += totalVectors(gpuv)
  171. for _, pv := range pvvs {
  172. totalContainerCost += totalVectors(pv)
  173. }
  174. totalContainerCost += totalVectors(netv)
  175. }
  176. return totalContainerCost
  177. }
  178. func (a *Accesses) ComputeIdleCoefficient(costData map[string]*CostData, cli prometheusClient.Client, cp cloud.Provider, discount float64, customDiscount float64, window, offset time.Duration) (map[string]float64, error) {
  179. coefficients := make(map[string]float64)
  180. profileName := "ComputeIdleCoefficient: ComputeClusterCosts"
  181. profileStart := time.Now()
  182. var clusterCosts map[string]*ClusterCosts
  183. var err error
  184. fmtWindow, fmtOffset := timeutil.DurationOffsetStrings(window, offset)
  185. key := fmt.Sprintf("%s:%s", fmtWindow, fmtOffset)
  186. if data, valid := a.ClusterCostsCache.Get(key); valid {
  187. clusterCosts = data.(map[string]*ClusterCosts)
  188. } else {
  189. clusterCosts, err = a.ComputeClusterCosts(cli, cp, window, offset, false)
  190. if err != nil {
  191. return nil, err
  192. }
  193. }
  194. measureTime(profileStart, profileThreshold, profileName)
  195. for cid, costs := range clusterCosts {
  196. if costs.CPUCumulative == 0 && costs.RAMCumulative == 0 && costs.StorageCumulative == 0 {
  197. klog.V(1).Infof("[Warning] No ClusterCosts data for cluster '%s'. Is it emitting data?", cid)
  198. coefficients[cid] = 1.0
  199. continue
  200. }
  201. if costs.TotalCumulative == 0 {
  202. return nil, fmt.Errorf("TotalCumulative cluster cost for cluster '%s' returned 0 over window '%s' offset '%s'", cid, fmtWindow, fmtOffset)
  203. }
  204. totalContainerCost := 0.0
  205. for _, costDatum := range costData {
  206. if costDatum.ClusterID == cid {
  207. cpuv, ramv, gpuv, pvvs, _ := getPriceVectors(cp, costDatum, "", discount, customDiscount, 1)
  208. totalContainerCost += totalVectors(cpuv)
  209. totalContainerCost += totalVectors(ramv)
  210. totalContainerCost += totalVectors(gpuv)
  211. for _, pv := range pvvs {
  212. totalContainerCost += totalVectors(pv)
  213. }
  214. }
  215. }
  216. coeff := totalContainerCost / costs.TotalCumulative
  217. coefficients[cid] = coeff
  218. }
  219. return coefficients, nil
  220. }
  221. // AggregationOptions provides optional parameters to AggregateCostData, allowing callers to perform more complex operations
  222. type AggregationOptions struct {
  223. Discount float64 // percent by which to discount CPU, RAM, and GPU cost
  224. CustomDiscount float64 // additional custom discount applied to all prices
  225. IdleCoefficients map[string]float64 // scales costs by amount of idle resources on a per-cluster basis
  226. IncludeEfficiency bool // set to true to receive efficiency/usage data
  227. IncludeTimeSeries bool // set to true to receive time series data
  228. Rate string // set to "hourly", "daily", or "monthly" to receive cost rate, rather than cumulative cost
  229. ResolutionHours float64
  230. SharedResourceInfo *SharedResourceInfo
  231. SharedCosts map[string]*SharedCostInfo
  232. FilteredContainerCount int
  233. FilteredEnvironments map[string]int
  234. SharedSplit string
  235. TotalContainerCost float64
  236. }
  237. // Helper method to test request/usgae values against allocation averages for efficiency scores. Generate a warning log if
  238. // clamp is required
  239. func clampAverage(requestsAvg float64, usedAverage float64, allocationAvg float64, resource string) (float64, float64) {
  240. rAvg := requestsAvg
  241. if rAvg > allocationAvg {
  242. klog.V(4).Infof("[Warning] Average %s Requested (%f) > Average %s Allocated (%f). Clamping.", resource, rAvg, resource, allocationAvg)
  243. rAvg = allocationAvg
  244. }
  245. uAvg := usedAverage
  246. if uAvg > allocationAvg {
  247. klog.V(4).Infof("[Warning]: Average %s Used (%f) > Average %s Allocated (%f). Clamping.", resource, uAvg, resource, allocationAvg)
  248. uAvg = allocationAvg
  249. }
  250. return rAvg, uAvg
  251. }
  252. // AggregateCostData aggregates raw cost data by field; e.g. namespace, cluster, service, or label. In the case of label, callers
  253. // must pass a slice of subfields indicating the labels by which to group. Provider is used to define custom resource pricing.
  254. // See AggregationOptions for optional parameters.
  255. func AggregateCostData(costData map[string]*CostData, field string, subfields []string, cp cloud.Provider, opts *AggregationOptions) map[string]*Aggregation {
  256. discount := opts.Discount
  257. customDiscount := opts.CustomDiscount
  258. idleCoefficients := opts.IdleCoefficients
  259. includeTimeSeries := opts.IncludeTimeSeries
  260. includeEfficiency := opts.IncludeEfficiency
  261. rate := opts.Rate
  262. sr := opts.SharedResourceInfo
  263. resolutionHours := 1.0
  264. if opts.ResolutionHours > 0.0 {
  265. resolutionHours = opts.ResolutionHours
  266. }
  267. if idleCoefficients == nil {
  268. idleCoefficients = make(map[string]float64)
  269. }
  270. // aggregations collects key-value pairs of resource group-to-aggregated data
  271. // e.g. namespace-to-data or label-value-to-data
  272. aggregations := make(map[string]*Aggregation)
  273. // sharedResourceCost is the running total cost of resources that should be reported
  274. // as shared across all other resources, rather than reported as a stand-alone category
  275. sharedResourceCost := 0.0
  276. for _, costDatum := range costData {
  277. idleCoefficient, ok := idleCoefficients[costDatum.ClusterID]
  278. if !ok {
  279. idleCoefficient = 1.0
  280. }
  281. if sr != nil && sr.ShareResources && sr.IsSharedResource(costDatum) {
  282. cpuv, ramv, gpuv, pvvs, netv := getPriceVectors(cp, costDatum, rate, discount, customDiscount, idleCoefficient)
  283. sharedResourceCost += totalVectors(cpuv)
  284. sharedResourceCost += totalVectors(ramv)
  285. sharedResourceCost += totalVectors(gpuv)
  286. sharedResourceCost += totalVectors(netv)
  287. for _, pv := range pvvs {
  288. sharedResourceCost += totalVectors(pv)
  289. }
  290. } else {
  291. if field == "cluster" {
  292. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, costDatum.ClusterID, discount, customDiscount, idleCoefficient, false)
  293. } else if field == "node" {
  294. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, costDatum.NodeName, discount, customDiscount, idleCoefficient, false)
  295. } else if field == "namespace" {
  296. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, costDatum.Namespace, discount, customDiscount, idleCoefficient, false)
  297. } else if field == "service" {
  298. if len(costDatum.Services) > 0 {
  299. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, costDatum.Namespace+"/"+costDatum.Services[0], discount, customDiscount, idleCoefficient, false)
  300. } else {
  301. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, UnallocatedSubfield, discount, customDiscount, idleCoefficient, false)
  302. }
  303. } else if field == "deployment" {
  304. if len(costDatum.Deployments) > 0 {
  305. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, costDatum.Namespace+"/"+costDatum.Deployments[0], discount, customDiscount, idleCoefficient, false)
  306. } else {
  307. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, UnallocatedSubfield, discount, customDiscount, idleCoefficient, false)
  308. }
  309. } else if field == "statefulset" {
  310. if len(costDatum.Statefulsets) > 0 {
  311. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, costDatum.Namespace+"/"+costDatum.Statefulsets[0], discount, customDiscount, idleCoefficient, false)
  312. } else {
  313. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, UnallocatedSubfield, discount, customDiscount, idleCoefficient, false)
  314. }
  315. } else if field == "daemonset" {
  316. if len(costDatum.Daemonsets) > 0 {
  317. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, costDatum.Namespace+"/"+costDatum.Daemonsets[0], discount, customDiscount, idleCoefficient, false)
  318. } else {
  319. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, UnallocatedSubfield, discount, customDiscount, idleCoefficient, false)
  320. }
  321. } else if field == "controller" {
  322. if controller, kind, hasController := costDatum.GetController(); hasController {
  323. key := fmt.Sprintf("%s/%s:%s", costDatum.Namespace, kind, controller)
  324. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, key, discount, customDiscount, idleCoefficient, false)
  325. } else {
  326. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, UnallocatedSubfield, discount, customDiscount, idleCoefficient, false)
  327. }
  328. } else if field == "label" {
  329. found := false
  330. if costDatum.Labels != nil {
  331. for _, sf := range subfields {
  332. if subfieldName, ok := costDatum.Labels[sf]; ok {
  333. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, subfieldName, discount, customDiscount, idleCoefficient, false)
  334. found = true
  335. break
  336. }
  337. }
  338. }
  339. if !found {
  340. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, UnallocatedSubfield, discount, customDiscount, idleCoefficient, false)
  341. }
  342. } else if field == "annotation" {
  343. found := false
  344. if costDatum.Annotations != nil {
  345. for _, sf := range subfields {
  346. if subfieldName, ok := costDatum.Annotations[sf]; ok {
  347. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, subfieldName, discount, customDiscount, idleCoefficient, false)
  348. found = true
  349. break
  350. }
  351. }
  352. }
  353. if !found {
  354. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, UnallocatedSubfield, discount, customDiscount, idleCoefficient, false)
  355. }
  356. } else if field == "pod" {
  357. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, costDatum.Namespace+"/"+costDatum.PodName, discount, customDiscount, idleCoefficient, false)
  358. } else if field == "container" {
  359. key := fmt.Sprintf("%s/%s/%s/%s", costDatum.ClusterID, costDatum.Namespace, costDatum.PodName, costDatum.Name)
  360. aggregateDatum(cp, aggregations, costDatum, field, subfields, rate, key, discount, customDiscount, idleCoefficient, true)
  361. }
  362. }
  363. }
  364. for key, agg := range aggregations {
  365. sharedCoefficient := 1 / float64(len(opts.FilteredEnvironments)+len(aggregations))
  366. agg.CPUCost = totalVectors(agg.CPUCostVector)
  367. agg.RAMCost = totalVectors(agg.RAMCostVector)
  368. agg.GPUCost = totalVectors(agg.GPUCostVector)
  369. agg.PVCost = totalVectors(agg.PVCostVector)
  370. agg.NetworkCost = totalVectors(agg.NetworkCostVector)
  371. if opts.SharedSplit == SplitTypeWeighted {
  372. d := opts.TotalContainerCost - sharedResourceCost
  373. if d == 0 {
  374. klog.V(1).Infof("[Warning] Total container cost '%f' and shared resource cost '%f are the same'. Setting sharedCoefficient to 1", opts.TotalContainerCost, sharedResourceCost)
  375. sharedCoefficient = 1.0
  376. } else {
  377. sharedCoefficient = (agg.CPUCost + agg.RAMCost + agg.GPUCost + agg.PVCost + agg.NetworkCost) / d
  378. }
  379. }
  380. agg.SharedCost = sharedResourceCost * sharedCoefficient
  381. for _, v := range opts.SharedCosts {
  382. agg.SharedCost += v.Cost * sharedCoefficient
  383. }
  384. if rate != "" {
  385. rateCoeff := agg.RateCoefficient(rate, resolutionHours)
  386. agg.CPUCost *= rateCoeff
  387. agg.RAMCost *= rateCoeff
  388. agg.GPUCost *= rateCoeff
  389. agg.PVCost *= rateCoeff
  390. agg.NetworkCost *= rateCoeff
  391. agg.SharedCost *= rateCoeff
  392. }
  393. agg.TotalCost = agg.CPUCost + agg.RAMCost + agg.GPUCost + agg.PVCost + agg.NetworkCost + agg.SharedCost
  394. // Evicted and Completed Pods can still show up here, but have 0 cost.
  395. // Filter these by default. Any reason to keep them?
  396. if agg.TotalCost == 0 {
  397. delete(aggregations, key)
  398. continue
  399. }
  400. // CPU, RAM, and PV allocation are cumulative per-datum, whereas GPU is rate per-datum
  401. agg.CPUAllocationHourlyAverage = totalVectors(agg.CPUAllocationVectors) / agg.TotalHours(resolutionHours)
  402. agg.RAMAllocationHourlyAverage = totalVectors(agg.RAMAllocationVectors) / agg.TotalHours(resolutionHours)
  403. agg.GPUAllocationHourlyAverage = averageVectors(agg.GPUAllocationVectors)
  404. agg.PVAllocationHourlyAverage = totalVectors(agg.PVAllocationVectors) / agg.TotalHours(resolutionHours)
  405. // TODO niko/etl does this check out for GPU data? Do we need to rewrite GPU queries to be
  406. // culumative?
  407. agg.CPUAllocationTotal = totalVectors(agg.CPUAllocationVectors)
  408. agg.GPUAllocationTotal = totalVectors(agg.GPUAllocationVectors)
  409. agg.PVAllocationTotal = totalVectors(agg.PVAllocationVectors)
  410. agg.RAMAllocationTotal = totalVectors(agg.RAMAllocationVectors)
  411. if includeEfficiency {
  412. // Default both RAM and CPU to 0% efficiency so that a 0-requested, 0-allocated, 0-used situation
  413. // returns 0% efficiency, which should be a red-flag.
  414. //
  415. // If non-zero numbers are available, then efficiency is defined as:
  416. // idlePercentage = (requested - used) / allocated
  417. // efficiency = (1.0 - idlePercentage)
  418. //
  419. // It is possible to score > 100% efficiency, which is meant to be interpreted as a red flag.
  420. // It is not possible to score < 0% efficiency.
  421. agg.CPUEfficiency = 0.0
  422. CPUIdle := 0.0
  423. if agg.CPUAllocationHourlyAverage > 0.0 {
  424. avgCPURequested := averageVectors(agg.CPURequestedVectors)
  425. avgCPUUsed := averageVectors(agg.CPUUsedVectors)
  426. // Clamp averages, log range violations
  427. avgCPURequested, avgCPUUsed = clampAverage(avgCPURequested, avgCPUUsed, agg.CPUAllocationHourlyAverage, "CPU")
  428. CPUIdle = ((avgCPURequested - avgCPUUsed) / agg.CPUAllocationHourlyAverage)
  429. agg.CPUEfficiency = 1.0 - CPUIdle
  430. }
  431. agg.RAMEfficiency = 0.0
  432. RAMIdle := 0.0
  433. if agg.RAMAllocationHourlyAverage > 0.0 {
  434. avgRAMRequested := averageVectors(agg.RAMRequestedVectors)
  435. avgRAMUsed := averageVectors(agg.RAMUsedVectors)
  436. // Clamp averages, log range violations
  437. avgRAMRequested, avgRAMUsed = clampAverage(avgRAMRequested, avgRAMUsed, agg.RAMAllocationHourlyAverage, "RAM")
  438. RAMIdle = ((avgRAMRequested - avgRAMUsed) / agg.RAMAllocationHourlyAverage)
  439. agg.RAMEfficiency = 1.0 - RAMIdle
  440. }
  441. // Score total efficiency by the sum of CPU and RAM efficiency, weighted by their
  442. // respective total costs.
  443. agg.Efficiency = 0.0
  444. if (agg.CPUCost + agg.RAMCost) > 0 {
  445. agg.Efficiency = ((agg.CPUCost * agg.CPUEfficiency) + (agg.RAMCost * agg.RAMEfficiency)) / (agg.CPUCost + agg.RAMCost)
  446. }
  447. }
  448. // convert RAM from bytes to GiB
  449. agg.RAMAllocationHourlyAverage = agg.RAMAllocationHourlyAverage / 1024 / 1024 / 1024
  450. // convert storage from bytes to GiB
  451. agg.PVAllocationHourlyAverage = agg.PVAllocationHourlyAverage / 1024 / 1024 / 1024
  452. // remove time series data if it is not explicitly requested
  453. if !includeTimeSeries {
  454. agg.CPUCostVector = nil
  455. agg.RAMCostVector = nil
  456. agg.GPUCostVector = nil
  457. agg.PVCostVector = nil
  458. agg.NetworkCostVector = nil
  459. agg.TotalCostVector = nil
  460. } else { // otherwise compute a totalcostvector
  461. v1 := addVectors(agg.CPUCostVector, agg.RAMCostVector)
  462. v2 := addVectors(v1, agg.GPUCostVector)
  463. v3 := addVectors(v2, agg.PVCostVector)
  464. v4 := addVectors(v3, agg.NetworkCostVector)
  465. agg.TotalCostVector = v4
  466. }
  467. // Typesafety checks
  468. if math.IsNaN(agg.CPUAllocationHourlyAverage) || math.IsInf(agg.CPUAllocationHourlyAverage, 0) {
  469. klog.V(1).Infof("[Warning] CPUAllocationHourlyAverage is %f for '%s: %s/%s'", agg.CPUAllocationHourlyAverage, agg.Cluster, agg.Aggregator, agg.Environment)
  470. agg.CPUAllocationHourlyAverage = 0
  471. }
  472. if math.IsNaN(agg.CPUCost) || math.IsInf(agg.CPUCost, 0) {
  473. klog.V(1).Infof("[Warning] CPUCost is %f for '%s: %s/%s'", agg.CPUCost, agg.Cluster, agg.Aggregator, agg.Environment)
  474. agg.CPUCost = 0
  475. }
  476. if math.IsNaN(agg.CPUEfficiency) || math.IsInf(agg.CPUEfficiency, 0) {
  477. klog.V(1).Infof("[Warning] CPUEfficiency is %f for '%s: %s/%s'", agg.CPUEfficiency, agg.Cluster, agg.Aggregator, agg.Environment)
  478. agg.CPUEfficiency = 0
  479. }
  480. if math.IsNaN(agg.Efficiency) || math.IsInf(agg.Efficiency, 0) {
  481. klog.V(1).Infof("[Warning] Efficiency is %f for '%s: %s/%s'", agg.Efficiency, agg.Cluster, agg.Aggregator, agg.Environment)
  482. agg.Efficiency = 0
  483. }
  484. if math.IsNaN(agg.GPUAllocationHourlyAverage) || math.IsInf(agg.GPUAllocationHourlyAverage, 0) {
  485. klog.V(1).Infof("[Warning] GPUAllocationHourlyAverage is %f for '%s: %s/%s'", agg.GPUAllocationHourlyAverage, agg.Cluster, agg.Aggregator, agg.Environment)
  486. agg.GPUAllocationHourlyAverage = 0
  487. }
  488. if math.IsNaN(agg.GPUCost) || math.IsInf(agg.GPUCost, 0) {
  489. klog.V(1).Infof("[Warning] GPUCost is %f for '%s: %s/%s'", agg.GPUCost, agg.Cluster, agg.Aggregator, agg.Environment)
  490. agg.GPUCost = 0
  491. }
  492. if math.IsNaN(agg.RAMAllocationHourlyAverage) || math.IsInf(agg.RAMAllocationHourlyAverage, 0) {
  493. klog.V(1).Infof("[Warning] RAMAllocationHourlyAverage is %f for '%s: %s/%s'", agg.RAMAllocationHourlyAverage, agg.Cluster, agg.Aggregator, agg.Environment)
  494. agg.RAMAllocationHourlyAverage = 0
  495. }
  496. if math.IsNaN(agg.RAMCost) || math.IsInf(agg.RAMCost, 0) {
  497. klog.V(1).Infof("[Warning] RAMCost is %f for '%s: %s/%s'", agg.RAMCost, agg.Cluster, agg.Aggregator, agg.Environment)
  498. agg.RAMCost = 0
  499. }
  500. if math.IsNaN(agg.RAMEfficiency) || math.IsInf(agg.RAMEfficiency, 0) {
  501. klog.V(1).Infof("[Warning] RAMEfficiency is %f for '%s: %s/%s'", agg.RAMEfficiency, agg.Cluster, agg.Aggregator, agg.Environment)
  502. agg.RAMEfficiency = 0
  503. }
  504. if math.IsNaN(agg.PVAllocationHourlyAverage) || math.IsInf(agg.PVAllocationHourlyAverage, 0) {
  505. klog.V(1).Infof("[Warning] PVAllocationHourlyAverage is %f for '%s: %s/%s'", agg.PVAllocationHourlyAverage, agg.Cluster, agg.Aggregator, agg.Environment)
  506. agg.PVAllocationHourlyAverage = 0
  507. }
  508. if math.IsNaN(agg.PVCost) || math.IsInf(agg.PVCost, 0) {
  509. klog.V(1).Infof("[Warning] PVCost is %f for '%s: %s/%s'", agg.PVCost, agg.Cluster, agg.Aggregator, agg.Environment)
  510. agg.PVCost = 0
  511. }
  512. if math.IsNaN(agg.NetworkCost) || math.IsInf(agg.NetworkCost, 0) {
  513. klog.V(1).Infof("[Warning] NetworkCost is %f for '%s: %s/%s'", agg.NetworkCost, agg.Cluster, agg.Aggregator, agg.Environment)
  514. agg.NetworkCost = 0
  515. }
  516. if math.IsNaN(agg.SharedCost) || math.IsInf(agg.SharedCost, 0) {
  517. klog.V(1).Infof("[Warning] SharedCost is %f for '%s: %s/%s'", agg.SharedCost, agg.Cluster, agg.Aggregator, agg.Environment)
  518. agg.SharedCost = 0
  519. }
  520. if math.IsNaN(agg.TotalCost) || math.IsInf(agg.TotalCost, 0) {
  521. klog.V(1).Infof("[Warning] TotalCost is %f for '%s: %s/%s'", agg.TotalCost, agg.Cluster, agg.Aggregator, agg.Environment)
  522. agg.TotalCost = 0
  523. }
  524. }
  525. return aggregations
  526. }
  527. func aggregateDatum(cp cloud.Provider, aggregations map[string]*Aggregation, costDatum *CostData, field string, subfields []string, rate string, key string, discount float64, customDiscount float64, idleCoefficient float64, includeProperties bool) {
  528. // add new entry to aggregation results if a new key is encountered
  529. if _, ok := aggregations[key]; !ok {
  530. agg := &Aggregation{
  531. Aggregator: field,
  532. Environment: key,
  533. }
  534. if len(subfields) > 0 {
  535. agg.Subfields = subfields
  536. }
  537. if includeProperties {
  538. props := &kubecost.AllocationProperties{}
  539. props.Cluster = costDatum.ClusterID
  540. props.Node = costDatum.NodeName
  541. if controller, kind, hasController := costDatum.GetController(); hasController {
  542. props.Controller = controller
  543. props.ControllerKind = kind
  544. }
  545. props.Labels = costDatum.Labels
  546. props.Annotations = costDatum.Annotations
  547. props.Namespace = costDatum.Namespace
  548. props.Pod = costDatum.PodName
  549. props.Services = costDatum.Services
  550. props.Container = costDatum.Name
  551. agg.Properties = props
  552. }
  553. aggregations[key] = agg
  554. }
  555. mergeVectors(cp, costDatum, aggregations[key], rate, discount, customDiscount, idleCoefficient)
  556. }
  557. func mergeVectors(cp cloud.Provider, costDatum *CostData, aggregation *Aggregation, rate string, discount float64, customDiscount float64, idleCoefficient float64) {
  558. aggregation.CPUAllocationVectors = addVectors(costDatum.CPUAllocation, aggregation.CPUAllocationVectors)
  559. aggregation.CPURequestedVectors = addVectors(costDatum.CPUReq, aggregation.CPURequestedVectors)
  560. aggregation.CPUUsedVectors = addVectors(costDatum.CPUUsed, aggregation.CPUUsedVectors)
  561. aggregation.RAMAllocationVectors = addVectors(costDatum.RAMAllocation, aggregation.RAMAllocationVectors)
  562. aggregation.RAMRequestedVectors = addVectors(costDatum.RAMReq, aggregation.RAMRequestedVectors)
  563. aggregation.RAMUsedVectors = addVectors(costDatum.RAMUsed, aggregation.RAMUsedVectors)
  564. aggregation.GPUAllocationVectors = addVectors(costDatum.GPUReq, aggregation.GPUAllocationVectors)
  565. for _, pvcd := range costDatum.PVCData {
  566. aggregation.PVAllocationVectors = addVectors(pvcd.Values, aggregation.PVAllocationVectors)
  567. }
  568. cpuv, ramv, gpuv, pvvs, netv := getPriceVectors(cp, costDatum, rate, discount, customDiscount, idleCoefficient)
  569. aggregation.CPUCostVector = addVectors(cpuv, aggregation.CPUCostVector)
  570. aggregation.RAMCostVector = addVectors(ramv, aggregation.RAMCostVector)
  571. aggregation.GPUCostVector = addVectors(gpuv, aggregation.GPUCostVector)
  572. aggregation.NetworkCostVector = addVectors(netv, aggregation.NetworkCostVector)
  573. for _, vectorList := range pvvs {
  574. aggregation.PVCostVector = addVectors(aggregation.PVCostVector, vectorList)
  575. }
  576. }
  577. // Returns the blended discounts applied to the node as a result of global discounts and reserved instance
  578. // discounts
  579. func getDiscounts(costDatum *CostData, cpuCost float64, ramCost float64, discount float64) (float64, float64) {
  580. if costDatum.NodeData == nil {
  581. return discount, discount
  582. }
  583. if costDatum.NodeData.IsSpot() {
  584. return 0, 0
  585. }
  586. reserved := costDatum.NodeData.Reserved
  587. // blended discounts
  588. blendedCPUDiscount := discount
  589. blendedRAMDiscount := discount
  590. if reserved != nil && reserved.CPUCost > 0 && reserved.RAMCost > 0 {
  591. reservedCPUDiscount := 0.0
  592. if cpuCost == 0 {
  593. klog.V(1).Infof("[Warning] No cpu cost found for cluster '%s' node '%s'", costDatum.ClusterID, costDatum.NodeName)
  594. } else {
  595. reservedCPUDiscount = 1.0 - (reserved.CPUCost / cpuCost)
  596. }
  597. reservedRAMDiscount := 0.0
  598. if ramCost == 0 {
  599. klog.V(1).Infof("[Warning] No ram cost found for cluster '%s' node '%s'", costDatum.ClusterID, costDatum.NodeName)
  600. } else {
  601. reservedRAMDiscount = 1.0 - (reserved.RAMCost / ramCost)
  602. }
  603. // AWS passes the # of reserved CPU and RAM as -1 to represent "All"
  604. if reserved.ReservedCPU < 0 && reserved.ReservedRAM < 0 {
  605. blendedCPUDiscount = reservedCPUDiscount
  606. blendedRAMDiscount = reservedRAMDiscount
  607. } else {
  608. nodeCPU, ierr := strconv.ParseInt(costDatum.NodeData.VCPU, 10, 64)
  609. nodeRAM, ferr := strconv.ParseFloat(costDatum.NodeData.RAMBytes, 64)
  610. if ierr == nil && ferr == nil {
  611. nodeRAMGB := nodeRAM / 1024 / 1024 / 1024
  612. reservedRAMGB := float64(reserved.ReservedRAM) / 1024 / 1024 / 1024
  613. nonReservedCPU := nodeCPU - reserved.ReservedCPU
  614. nonReservedRAM := nodeRAMGB - reservedRAMGB
  615. if nonReservedCPU == 0 {
  616. blendedCPUDiscount = reservedCPUDiscount
  617. } else {
  618. if nodeCPU == 0 {
  619. klog.V(1).Infof("[Warning] No ram found for cluster '%s' node '%s'", costDatum.ClusterID, costDatum.NodeName)
  620. } else {
  621. blendedCPUDiscount = (float64(reserved.ReservedCPU) * reservedCPUDiscount) + (float64(nonReservedCPU)*discount)/float64(nodeCPU)
  622. }
  623. }
  624. if nonReservedRAM == 0 {
  625. blendedRAMDiscount = reservedRAMDiscount
  626. } else {
  627. if nodeRAMGB == 0 {
  628. klog.V(1).Infof("[Warning] No ram found for cluster '%s' node '%s'", costDatum.ClusterID, costDatum.NodeName)
  629. } else {
  630. blendedRAMDiscount = (reservedRAMGB * reservedRAMDiscount) + (nonReservedRAM*discount)/nodeRAMGB
  631. }
  632. }
  633. }
  634. }
  635. }
  636. return blendedCPUDiscount, blendedRAMDiscount
  637. }
  638. func parseVectorPricing(cfg *cloud.CustomPricing, costDatum *CostData, cpuCostStr, ramCostStr, gpuCostStr, pvCostStr string) (float64, float64, float64, float64, bool) {
  639. usesCustom := false
  640. cpuCost, err := strconv.ParseFloat(cpuCostStr, 64)
  641. if err != nil || math.IsNaN(cpuCost) || math.IsInf(cpuCost, 0) || cpuCost == 0 {
  642. cpuCost, err = strconv.ParseFloat(cfg.CPU, 64)
  643. usesCustom = true
  644. if err != nil || math.IsNaN(cpuCost) || math.IsInf(cpuCost, 0) {
  645. cpuCost = 0
  646. }
  647. }
  648. ramCost, err := strconv.ParseFloat(ramCostStr, 64)
  649. if err != nil || math.IsNaN(ramCost) || math.IsInf(ramCost, 0) || ramCost == 0 {
  650. ramCost, err = strconv.ParseFloat(cfg.RAM, 64)
  651. usesCustom = true
  652. if err != nil || math.IsNaN(ramCost) || math.IsInf(ramCost, 0) {
  653. ramCost = 0
  654. }
  655. }
  656. gpuCost, err := strconv.ParseFloat(gpuCostStr, 64)
  657. if err != nil || math.IsNaN(gpuCost) || math.IsInf(gpuCost, 0) {
  658. gpuCost, err = strconv.ParseFloat(cfg.GPU, 64)
  659. if err != nil || math.IsNaN(gpuCost) || math.IsInf(gpuCost, 0) {
  660. gpuCost = 0
  661. }
  662. }
  663. pvCost, err := strconv.ParseFloat(pvCostStr, 64)
  664. if err != nil || math.IsNaN(cpuCost) || math.IsInf(cpuCost, 0) {
  665. pvCost, err = strconv.ParseFloat(cfg.Storage, 64)
  666. if err != nil || math.IsNaN(pvCost) || math.IsInf(pvCost, 0) {
  667. pvCost = 0
  668. }
  669. }
  670. return cpuCost, ramCost, gpuCost, pvCost, usesCustom
  671. }
  672. func getPriceVectors(cp cloud.Provider, costDatum *CostData, rate string, discount float64, customDiscount float64, idleCoefficient float64) ([]*util.Vector, []*util.Vector, []*util.Vector, [][]*util.Vector, []*util.Vector) {
  673. var cpuCost float64
  674. var ramCost float64
  675. var gpuCost float64
  676. var pvCost float64
  677. var usesCustom bool
  678. // If custom pricing is enabled and can be retrieved, replace
  679. // default cost values with custom values
  680. customPricing, err := cp.GetConfig()
  681. if err != nil {
  682. klog.Errorf("failed to load custom pricing: %s", err)
  683. }
  684. if cloud.CustomPricesEnabled(cp) && err == nil {
  685. var cpuCostStr string
  686. var ramCostStr string
  687. var gpuCostStr string
  688. var pvCostStr string
  689. if costDatum.NodeData.IsSpot() {
  690. cpuCostStr = customPricing.SpotCPU
  691. ramCostStr = customPricing.SpotRAM
  692. gpuCostStr = customPricing.SpotGPU
  693. } else {
  694. cpuCostStr = customPricing.CPU
  695. ramCostStr = customPricing.RAM
  696. gpuCostStr = customPricing.GPU
  697. }
  698. pvCostStr = customPricing.Storage
  699. cpuCost, ramCost, gpuCost, pvCost, usesCustom = parseVectorPricing(customPricing, costDatum, cpuCostStr, ramCostStr, gpuCostStr, pvCostStr)
  700. } else if costDatum.NodeData == nil && err == nil {
  701. cpuCostStr := customPricing.CPU
  702. ramCostStr := customPricing.RAM
  703. gpuCostStr := customPricing.GPU
  704. pvCostStr := customPricing.Storage
  705. cpuCost, ramCost, gpuCost, pvCost, usesCustom = parseVectorPricing(customPricing, costDatum, cpuCostStr, ramCostStr, gpuCostStr, pvCostStr)
  706. } else {
  707. cpuCostStr := costDatum.NodeData.VCPUCost
  708. ramCostStr := costDatum.NodeData.RAMCost
  709. gpuCostStr := costDatum.NodeData.GPUCost
  710. pvCostStr := costDatum.NodeData.StorageCost
  711. cpuCost, ramCost, gpuCost, pvCost, usesCustom = parseVectorPricing(customPricing, costDatum, cpuCostStr, ramCostStr, gpuCostStr, pvCostStr)
  712. }
  713. if usesCustom {
  714. log.DedupedWarningf(5, "No pricing data found for node `%s` , using custom pricing", costDatum.NodeName)
  715. }
  716. cpuDiscount, ramDiscount := getDiscounts(costDatum, cpuCost, ramCost, discount)
  717. klog.V(4).Infof("Node Name: %s", costDatum.NodeName)
  718. klog.V(4).Infof("Blended CPU Discount: %f", cpuDiscount)
  719. klog.V(4).Infof("Blended RAM Discount: %f", ramDiscount)
  720. // TODO should we try to apply the rate coefficient here or leave it as a totals-only metric?
  721. rateCoeff := 1.0
  722. if idleCoefficient == 0 {
  723. idleCoefficient = 1.0
  724. }
  725. cpuv := make([]*util.Vector, 0, len(costDatum.CPUAllocation))
  726. for _, val := range costDatum.CPUAllocation {
  727. cpuv = append(cpuv, &util.Vector{
  728. Timestamp: math.Round(val.Timestamp/10) * 10,
  729. Value: (val.Value * cpuCost * (1 - cpuDiscount) * (1 - customDiscount) / idleCoefficient) * rateCoeff,
  730. })
  731. }
  732. ramv := make([]*util.Vector, 0, len(costDatum.RAMAllocation))
  733. for _, val := range costDatum.RAMAllocation {
  734. ramv = append(ramv, &util.Vector{
  735. Timestamp: math.Round(val.Timestamp/10) * 10,
  736. Value: ((val.Value / 1024 / 1024 / 1024) * ramCost * (1 - ramDiscount) * (1 - customDiscount) / idleCoefficient) * rateCoeff,
  737. })
  738. }
  739. gpuv := make([]*util.Vector, 0, len(costDatum.GPUReq))
  740. for _, val := range costDatum.GPUReq {
  741. gpuv = append(gpuv, &util.Vector{
  742. Timestamp: math.Round(val.Timestamp/10) * 10,
  743. Value: (val.Value * gpuCost * (1 - discount) * (1 - customDiscount) / idleCoefficient) * rateCoeff,
  744. })
  745. }
  746. pvvs := make([][]*util.Vector, 0, len(costDatum.PVCData))
  747. for _, pvcData := range costDatum.PVCData {
  748. pvv := make([]*util.Vector, 0, len(pvcData.Values))
  749. if pvcData.Volume != nil {
  750. cost, _ := strconv.ParseFloat(pvcData.Volume.Cost, 64)
  751. // override with custom pricing if enabled
  752. if cloud.CustomPricesEnabled(cp) {
  753. cost = pvCost
  754. }
  755. for _, val := range pvcData.Values {
  756. pvv = append(pvv, &util.Vector{
  757. Timestamp: math.Round(val.Timestamp/10) * 10,
  758. Value: ((val.Value / 1024 / 1024 / 1024) * cost * (1 - customDiscount) / idleCoefficient) * rateCoeff,
  759. })
  760. }
  761. pvvs = append(pvvs, pvv)
  762. }
  763. }
  764. netv := make([]*util.Vector, 0, len(costDatum.NetworkData))
  765. for _, val := range costDatum.NetworkData {
  766. netv = append(netv, &util.Vector{
  767. Timestamp: math.Round(val.Timestamp/10) * 10,
  768. Value: val.Value,
  769. })
  770. }
  771. return cpuv, ramv, gpuv, pvvs, netv
  772. }
  773. func averageVectors(vectors []*util.Vector) float64 {
  774. if len(vectors) == 0 {
  775. return 0.0
  776. }
  777. return totalVectors(vectors) / float64(len(vectors))
  778. }
  779. func totalVectors(vectors []*util.Vector) float64 {
  780. total := 0.0
  781. for _, vector := range vectors {
  782. total += vector.Value
  783. }
  784. return total
  785. }
  786. // addVectors adds two slices of Vectors. Vector timestamps are rounded to the
  787. // nearest ten seconds to allow matching of Vectors within a delta allowance.
  788. // Matching Vectors are summed, while unmatched Vectors are passed through.
  789. // e.g. [(t=1, 1), (t=2, 2)] + [(t=2, 2), (t=3, 3)] = [(t=1, 1), (t=2, 4), (t=3, 3)]
  790. func addVectors(xvs []*util.Vector, yvs []*util.Vector) []*util.Vector {
  791. sumOp := func(result *util.Vector, x *float64, y *float64) bool {
  792. if x != nil && y != nil {
  793. result.Value = *x + *y
  794. } else if y != nil {
  795. result.Value = *y
  796. } else if x != nil {
  797. result.Value = *x
  798. }
  799. return true
  800. }
  801. return util.ApplyVectorOp(xvs, yvs, sumOp)
  802. }
  803. // minCostDataLength sets the minimum number of time series data required to
  804. // cache both raw and aggregated cost data
  805. const minCostDataLength = 2
  806. // EmptyDataError describes an error caused by empty cost data for some
  807. // defined interval
  808. type EmptyDataError struct {
  809. err error
  810. window kubecost.Window
  811. }
  812. // Error implements the error interface
  813. func (ede *EmptyDataError) Error() string {
  814. err := fmt.Sprintf("empty data for range: %s", ede.window)
  815. if ede.err != nil {
  816. err += fmt.Sprintf(": %s", ede.err)
  817. }
  818. return err
  819. }
  820. func costDataTimeSeriesLength(costData map[string]*CostData) int {
  821. l := 0
  822. for _, cd := range costData {
  823. if l < len(cd.RAMAllocation) {
  824. l = len(cd.RAMAllocation)
  825. }
  826. if l < len(cd.CPUAllocation) {
  827. l = len(cd.CPUAllocation)
  828. }
  829. }
  830. return l
  831. }
  832. // ScaleHourlyCostData converts per-hour cost data to per-resolution data. If the target resolution is higher (i.e. < 1.0h)
  833. // then we can do simple multiplication by the fraction-of-an-hour and retain accuracy. If the target resolution is
  834. // lower (i.e. > 1.0h) then we sum groups of hourly data by resolution to maintain fidelity.
  835. // e.g. (100 hours of per-hour hourly data, resolutionHours=10) => 10 data points, grouped and summed by 10-hour window
  836. // e.g. (20 minutes of per-minute hourly data, resolutionHours=1/60) => 20 data points, scaled down by a factor of 60
  837. func ScaleHourlyCostData(data map[string]*CostData, resolutionHours float64) map[string]*CostData {
  838. scaled := map[string]*CostData{}
  839. for key, datum := range data {
  840. datum.RAMReq = scaleVectorSeries(datum.RAMReq, resolutionHours)
  841. datum.RAMUsed = scaleVectorSeries(datum.RAMUsed, resolutionHours)
  842. datum.RAMAllocation = scaleVectorSeries(datum.RAMAllocation, resolutionHours)
  843. datum.CPUReq = scaleVectorSeries(datum.CPUReq, resolutionHours)
  844. datum.CPUUsed = scaleVectorSeries(datum.CPUUsed, resolutionHours)
  845. datum.CPUAllocation = scaleVectorSeries(datum.CPUAllocation, resolutionHours)
  846. datum.GPUReq = scaleVectorSeries(datum.GPUReq, resolutionHours)
  847. datum.NetworkData = scaleVectorSeries(datum.NetworkData, resolutionHours)
  848. for _, pvcDatum := range datum.PVCData {
  849. pvcDatum.Values = scaleVectorSeries(pvcDatum.Values, resolutionHours)
  850. }
  851. scaled[key] = datum
  852. }
  853. return scaled
  854. }
  855. func scaleVectorSeries(vs []*util.Vector, resolutionHours float64) []*util.Vector {
  856. // if scaling to a lower resolution, compress the hourly data for maximum accuracy
  857. if resolutionHours > 1.0 {
  858. return compressVectorSeries(vs, resolutionHours)
  859. }
  860. // if scaling to a higher resolution, simply scale each value down by the fraction of an hour
  861. for _, v := range vs {
  862. v.Value *= resolutionHours
  863. }
  864. return vs
  865. }
  866. func compressVectorSeries(vs []*util.Vector, resolutionHours float64) []*util.Vector {
  867. if len(vs) == 0 {
  868. return vs
  869. }
  870. compressed := []*util.Vector{}
  871. threshold := float64(60 * 60 * resolutionHours)
  872. var acc *util.Vector
  873. for i, v := range vs {
  874. if acc == nil {
  875. // start a new accumulation from current datum
  876. acc = &util.Vector{
  877. Value: vs[i].Value,
  878. Timestamp: vs[i].Timestamp,
  879. }
  880. continue
  881. }
  882. if v.Timestamp-acc.Timestamp < threshold {
  883. // v should be accumulated in current datum
  884. acc.Value += v.Value
  885. } else {
  886. // v falls outside current datum's threshold; append and start a new one
  887. compressed = append(compressed, acc)
  888. acc = &util.Vector{
  889. Value: vs[i].Value,
  890. Timestamp: vs[i].Timestamp,
  891. }
  892. }
  893. }
  894. // append any remaining, incomplete accumulation
  895. if acc != nil {
  896. compressed = append(compressed, acc)
  897. }
  898. return compressed
  899. }
  900. type AggregateQueryOpts struct {
  901. Rate string
  902. Filters map[string]string
  903. SharedResources *SharedResourceInfo
  904. ShareSplit string
  905. AllocateIdle bool
  906. IncludeTimeSeries bool
  907. IncludeEfficiency bool
  908. DisableCache bool
  909. ClearCache bool
  910. NoCache bool
  911. NoExpireCache bool
  912. RemoteEnabled bool
  913. DisableSharedOverhead bool
  914. UseETLAdapter bool
  915. }
  916. func DefaultAggregateQueryOpts() *AggregateQueryOpts {
  917. return &AggregateQueryOpts{
  918. Rate: "",
  919. Filters: map[string]string{},
  920. SharedResources: nil,
  921. ShareSplit: SplitTypeWeighted,
  922. AllocateIdle: false,
  923. IncludeTimeSeries: true,
  924. IncludeEfficiency: true,
  925. DisableCache: false,
  926. ClearCache: false,
  927. NoCache: false,
  928. NoExpireCache: false,
  929. RemoteEnabled: env.IsRemoteEnabled(),
  930. DisableSharedOverhead: false,
  931. UseETLAdapter: false,
  932. }
  933. }
  934. // ComputeAggregateCostModel computes cost data for the given window, then aggregates it by the given fields.
  935. // Data is cached on two levels: the aggregation is cached as well as the underlying cost data.
  936. func (a *Accesses) ComputeAggregateCostModel(promClient prometheusClient.Client, window kubecost.Window, field string, subfields []string, opts *AggregateQueryOpts) (map[string]*Aggregation, string, error) {
  937. // Window is the range of the query, i.e. (start, end)
  938. // It must be closed, i.e. neither start nor end can be nil
  939. if window.IsOpen() {
  940. return nil, "", fmt.Errorf("illegal window: %s", window)
  941. }
  942. // Resolution is the duration of each datum in the cost model range query,
  943. // which corresponds to both the step size given to Prometheus query_range
  944. // and to the window passed to the range queries.
  945. // i.e. by default, we support 1h resolution for queries of windows defined
  946. // in terms of days or integer multiples of hours (e.g. 1d, 12h)
  947. resolution := time.Hour
  948. // Determine resolution by size of duration and divisibility of window.
  949. // By default, resolution is 1hr. If the window is smaller than 1hr, then
  950. // resolution goes down to 1m. If the window is not a multiple of 1hr, then
  951. // resolution goes down to 1m. If the window is greater than 1d, then
  952. // resolution gets scaled up to improve performance by reducing the amount
  953. // of data being computed.
  954. durMins := int64(math.Trunc(window.Minutes()))
  955. if durMins < 24*60 { // less than 1d
  956. // TODO should we have additional options for going by
  957. // e.g. 30m? 10m? 5m?
  958. if durMins%60 != 0 || durMins < 3*60 { // not divisible by 1h or less than 3h
  959. resolution = time.Minute
  960. }
  961. } else { // greater than 1d
  962. if durMins >= 7*24*60 { // greater than (or equal to) 7 days
  963. resolution = 24.0 * time.Hour
  964. } else if durMins >= 2*24*60 { // greater than (or equal to) 2 days
  965. resolution = 2.0 * time.Hour
  966. }
  967. }
  968. // Parse options
  969. if opts == nil {
  970. opts = DefaultAggregateQueryOpts()
  971. }
  972. rate := opts.Rate
  973. filters := opts.Filters
  974. sri := opts.SharedResources
  975. shared := opts.ShareSplit
  976. allocateIdle := opts.AllocateIdle
  977. includeTimeSeries := opts.IncludeTimeSeries
  978. includeEfficiency := opts.IncludeEfficiency
  979. disableCache := opts.DisableCache
  980. clearCache := opts.ClearCache
  981. noCache := opts.NoCache
  982. noExpireCache := opts.NoExpireCache
  983. remoteEnabled := opts.RemoteEnabled
  984. disableSharedOverhead := opts.DisableSharedOverhead
  985. // retainFuncs override filterFuncs. Make sure shared resources do not
  986. // get filtered out.
  987. retainFuncs := []FilterFunc{}
  988. retainFuncs = append(retainFuncs, func(cd *CostData) (bool, string) {
  989. if sri != nil {
  990. return sri.IsSharedResource(cd), ""
  991. }
  992. return false, ""
  993. })
  994. // Parse cost data filters into FilterFuncs
  995. filterFuncs := []FilterFunc{}
  996. aggregateEnvironment := func(costDatum *CostData) string {
  997. if field == "cluster" {
  998. return costDatum.ClusterID
  999. } else if field == "node" {
  1000. return costDatum.NodeName
  1001. } else if field == "namespace" {
  1002. return costDatum.Namespace
  1003. } else if field == "service" {
  1004. if len(costDatum.Services) > 0 {
  1005. return costDatum.Namespace + "/" + costDatum.Services[0]
  1006. }
  1007. } else if field == "deployment" {
  1008. if len(costDatum.Deployments) > 0 {
  1009. return costDatum.Namespace + "/" + costDatum.Deployments[0]
  1010. }
  1011. } else if field == "daemonset" {
  1012. if len(costDatum.Daemonsets) > 0 {
  1013. return costDatum.Namespace + "/" + costDatum.Daemonsets[0]
  1014. }
  1015. } else if field == "statefulset" {
  1016. if len(costDatum.Statefulsets) > 0 {
  1017. return costDatum.Namespace + "/" + costDatum.Statefulsets[0]
  1018. }
  1019. } else if field == "label" {
  1020. if costDatum.Labels != nil {
  1021. for _, sf := range subfields {
  1022. if subfieldName, ok := costDatum.Labels[sf]; ok {
  1023. return fmt.Sprintf("%s=%s", sf, subfieldName)
  1024. }
  1025. }
  1026. }
  1027. } else if field == "annotation" {
  1028. if costDatum.Annotations != nil {
  1029. for _, sf := range subfields {
  1030. if subfieldName, ok := costDatum.Annotations[sf]; ok {
  1031. return fmt.Sprintf("%s=%s", sf, subfieldName)
  1032. }
  1033. }
  1034. }
  1035. } else if field == "pod" {
  1036. return costDatum.Namespace + "/" + costDatum.PodName
  1037. } else if field == "container" {
  1038. return costDatum.Namespace + "/" + costDatum.PodName + "/" + costDatum.Name
  1039. }
  1040. return ""
  1041. }
  1042. if filters["podprefix"] != "" {
  1043. pps := []string{}
  1044. for _, fp := range strings.Split(filters["podprefix"], ",") {
  1045. if fp != "" {
  1046. cleanedFilter := strings.TrimSpace(fp)
  1047. pps = append(pps, cleanedFilter)
  1048. }
  1049. }
  1050. filterFuncs = append(filterFuncs, func(cd *CostData) (bool, string) {
  1051. aggEnv := aggregateEnvironment(cd)
  1052. for _, pp := range pps {
  1053. cleanedFilter := strings.TrimSpace(pp)
  1054. if strings.HasPrefix(cd.PodName, cleanedFilter) {
  1055. return true, aggEnv
  1056. }
  1057. }
  1058. return false, aggEnv
  1059. })
  1060. }
  1061. if filters["namespace"] != "" {
  1062. // namespaces may be comma-separated, e.g. kubecost,default
  1063. // multiple namespaces are evaluated as an OR relationship
  1064. nss := strings.Split(filters["namespace"], ",")
  1065. filterFuncs = append(filterFuncs, func(cd *CostData) (bool, string) {
  1066. aggEnv := aggregateEnvironment(cd)
  1067. for _, ns := range nss {
  1068. nsTrim := strings.TrimSpace(ns)
  1069. if cd.Namespace == nsTrim {
  1070. return true, aggEnv
  1071. } else if strings.HasSuffix(nsTrim, "*") { // trigger wildcard prefix filtering
  1072. nsTrimAsterisk := strings.TrimSuffix(nsTrim, "*")
  1073. if strings.HasPrefix(cd.Namespace, nsTrimAsterisk) {
  1074. return true, aggEnv
  1075. }
  1076. }
  1077. }
  1078. return false, aggEnv
  1079. })
  1080. }
  1081. if filters["node"] != "" {
  1082. // nodes may be comma-separated, e.g. aws-node-1,aws-node-2
  1083. // multiple nodes are evaluated as an OR relationship
  1084. nodes := strings.Split(filters["node"], ",")
  1085. filterFuncs = append(filterFuncs, func(cd *CostData) (bool, string) {
  1086. aggEnv := aggregateEnvironment(cd)
  1087. for _, node := range nodes {
  1088. nodeTrim := strings.TrimSpace(node)
  1089. if cd.NodeName == nodeTrim {
  1090. return true, aggEnv
  1091. } else if strings.HasSuffix(nodeTrim, "*") { // trigger wildcard prefix filtering
  1092. nodeTrimAsterisk := strings.TrimSuffix(nodeTrim, "*")
  1093. if strings.HasPrefix(cd.NodeName, nodeTrimAsterisk) {
  1094. return true, aggEnv
  1095. }
  1096. }
  1097. }
  1098. return false, aggEnv
  1099. })
  1100. }
  1101. if filters["cluster"] != "" {
  1102. // clusters may be comma-separated, e.g. cluster-one,cluster-two
  1103. // multiple clusters are evaluated as an OR relationship
  1104. cs := strings.Split(filters["cluster"], ",")
  1105. filterFuncs = append(filterFuncs, func(cd *CostData) (bool, string) {
  1106. aggEnv := aggregateEnvironment(cd)
  1107. for _, c := range cs {
  1108. cTrim := strings.TrimSpace(c)
  1109. id, name := cd.ClusterID, cd.ClusterName
  1110. if id == cTrim || name == cTrim {
  1111. return true, aggEnv
  1112. } else if strings.HasSuffix(cTrim, "*") { // trigger wildcard prefix filtering
  1113. cTrimAsterisk := strings.TrimSuffix(cTrim, "*")
  1114. if strings.HasPrefix(id, cTrimAsterisk) || strings.HasPrefix(name, cTrimAsterisk) {
  1115. return true, aggEnv
  1116. }
  1117. }
  1118. }
  1119. return false, aggEnv
  1120. })
  1121. }
  1122. if filters["labels"] != "" {
  1123. // labels are expected to be comma-separated and to take the form key=value
  1124. // e.g. app=cost-analyzer,app.kubernetes.io/instance=kubecost
  1125. // each different label will be applied as an AND
  1126. // multiple values for a single label will be evaluated as an OR
  1127. labelValues := map[string][]string{}
  1128. ls := strings.Split(filters["labels"], ",")
  1129. for _, l := range ls {
  1130. lTrim := strings.TrimSpace(l)
  1131. label := strings.Split(lTrim, "=")
  1132. if len(label) == 2 {
  1133. ln := prom.SanitizeLabelName(strings.TrimSpace(label[0]))
  1134. lv := strings.TrimSpace(label[1])
  1135. labelValues[ln] = append(labelValues[ln], lv)
  1136. } else {
  1137. // label is not of the form name=value, so log it and move on
  1138. log.Warningf("ComputeAggregateCostModel: skipping illegal label filter: %s", l)
  1139. }
  1140. }
  1141. // Generate FilterFunc for each set of label filters by invoking a function instead of accessing
  1142. // values by closure to prevent reference-type looping bug.
  1143. // (see https://github.com/golang/go/wiki/CommonMistakes#using-reference-to-loop-iterator-variable)
  1144. for label, values := range labelValues {
  1145. ff := (func(l string, vs []string) FilterFunc {
  1146. return func(cd *CostData) (bool, string) {
  1147. ae := aggregateEnvironment(cd)
  1148. for _, v := range vs {
  1149. if v == "__unallocated__" { // Special case. __unallocated__ means return all pods without the attached label
  1150. if _, ok := cd.Labels[l]; !ok {
  1151. return true, ae
  1152. }
  1153. }
  1154. if cd.Labels[l] == v {
  1155. return true, ae
  1156. } else if strings.HasSuffix(v, "*") { // trigger wildcard prefix filtering
  1157. vTrim := strings.TrimSuffix(v, "*")
  1158. if strings.HasPrefix(cd.Labels[l], vTrim) {
  1159. return true, ae
  1160. }
  1161. }
  1162. }
  1163. return false, ae
  1164. }
  1165. })(label, values)
  1166. filterFuncs = append(filterFuncs, ff)
  1167. }
  1168. }
  1169. if filters["annotations"] != "" {
  1170. // annotations are expected to be comma-separated and to take the form key=value
  1171. // e.g. app=cost-analyzer,app.kubernetes.io/instance=kubecost
  1172. // each different annotation will be applied as an AND
  1173. // multiple values for a single annotation will be evaluated as an OR
  1174. annotationValues := map[string][]string{}
  1175. as := strings.Split(filters["annotations"], ",")
  1176. for _, annot := range as {
  1177. aTrim := strings.TrimSpace(annot)
  1178. annotation := strings.Split(aTrim, "=")
  1179. if len(annotation) == 2 {
  1180. an := prom.SanitizeLabelName(strings.TrimSpace(annotation[0]))
  1181. av := strings.TrimSpace(annotation[1])
  1182. annotationValues[an] = append(annotationValues[an], av)
  1183. } else {
  1184. // annotation is not of the form name=value, so log it and move on
  1185. log.Warningf("ComputeAggregateCostModel: skipping illegal annotation filter: %s", annot)
  1186. }
  1187. }
  1188. // Generate FilterFunc for each set of annotation filters by invoking a function instead of accessing
  1189. // values by closure to prevent reference-type looping bug.
  1190. // (see https://github.com/golang/go/wiki/CommonMistakes#using-reference-to-loop-iterator-variable)
  1191. for annotation, values := range annotationValues {
  1192. ff := (func(l string, vs []string) FilterFunc {
  1193. return func(cd *CostData) (bool, string) {
  1194. ae := aggregateEnvironment(cd)
  1195. for _, v := range vs {
  1196. if v == "__unallocated__" { // Special case. __unallocated__ means return all pods without the attached label
  1197. if _, ok := cd.Annotations[l]; !ok {
  1198. return true, ae
  1199. }
  1200. }
  1201. if cd.Annotations[l] == v {
  1202. return true, ae
  1203. } else if strings.HasSuffix(v, "*") { // trigger wildcard prefix filtering
  1204. vTrim := strings.TrimSuffix(v, "*")
  1205. if strings.HasPrefix(cd.Annotations[l], vTrim) {
  1206. return true, ae
  1207. }
  1208. }
  1209. }
  1210. return false, ae
  1211. }
  1212. })(annotation, values)
  1213. filterFuncs = append(filterFuncs, ff)
  1214. }
  1215. }
  1216. // clear cache prior to checking the cache so that a clearCache=true
  1217. // request always returns a freshly computed value
  1218. if clearCache {
  1219. a.AggregateCache.Flush()
  1220. a.CostDataCache.Flush()
  1221. }
  1222. cacheExpiry := a.GetCacheExpiration(window.Duration())
  1223. if noExpireCache {
  1224. cacheExpiry = cache.NoExpiration
  1225. }
  1226. // parametrize cache key by all request parameters
  1227. aggKey := GenerateAggKey(window, field, subfields, opts)
  1228. thanosOffset := time.Now().Add(-thanos.OffsetDuration())
  1229. if a.ThanosClient != nil && window.End().After(thanosOffset) {
  1230. log.Infof("ComputeAggregateCostModel: setting end time backwards to first present data")
  1231. // Apply offsets to both end and start times to maintain correct time range
  1232. deltaDuration := window.End().Sub(thanosOffset)
  1233. s := window.Start().Add(-1 * deltaDuration)
  1234. e := time.Now().Add(-thanos.OffsetDuration())
  1235. window.Set(&s, &e)
  1236. }
  1237. dur, off := window.DurationOffsetStrings()
  1238. key := fmt.Sprintf(`%s:%s:%fh:%t`, dur, off, resolution.Hours(), remoteEnabled)
  1239. // report message about which of the two caches hit. by default report a miss
  1240. cacheMessage := fmt.Sprintf("ComputeAggregateCostModel: L1 cache miss: %s L2 cache miss: %s", aggKey, key)
  1241. // check the cache for aggregated response; if cache is hit and not disabled, return response
  1242. if value, found := a.AggregateCache.Get(aggKey); found && !disableCache && !noCache {
  1243. result, ok := value.(map[string]*Aggregation)
  1244. if !ok {
  1245. // disable cache and recompute if type cast fails
  1246. log.Errorf("ComputeAggregateCostModel: caching error: failed to cast aggregate data to struct: %s", aggKey)
  1247. return a.ComputeAggregateCostModel(promClient, window, field, subfields, opts)
  1248. }
  1249. return result, fmt.Sprintf("aggregate cache hit: %s", aggKey), nil
  1250. }
  1251. if window.Hours() >= 1.0 {
  1252. // exclude the last window of the time frame to match Prometheus definitions of range, offset, and resolution
  1253. start := window.Start().Add(resolution)
  1254. window.Set(&start, window.End())
  1255. } else {
  1256. // don't cache requests for durations of less than one hour
  1257. disableCache = true
  1258. }
  1259. // attempt to retrieve cost data from cache
  1260. var costData map[string]*CostData
  1261. var err error
  1262. cacheData, found := a.CostDataCache.Get(key)
  1263. if found && !disableCache && !noCache {
  1264. ok := false
  1265. costData, ok = cacheData.(map[string]*CostData)
  1266. cacheMessage = fmt.Sprintf("ComputeAggregateCostModel: L1 cache miss: %s, L2 cost data cache hit: %s", aggKey, key)
  1267. if !ok {
  1268. log.Errorf("ComputeAggregateCostModel: caching error: failed to cast cost data to struct: %s", key)
  1269. }
  1270. } else {
  1271. log.Infof("ComputeAggregateCostModel: missed cache: %s (found %t, disableCache %t, noCache %t)", key, found, disableCache, noCache)
  1272. costData, err = a.Model.ComputeCostDataRange(promClient, a.CloudProvider, window, resolution, "", "", remoteEnabled)
  1273. if err != nil {
  1274. if prom.IsErrorCollection(err) {
  1275. return nil, "", err
  1276. }
  1277. if pce, ok := err.(prom.CommError); ok {
  1278. return nil, "", pce
  1279. }
  1280. if strings.Contains(err.Error(), "data is empty") {
  1281. return nil, "", &EmptyDataError{err: err, window: window}
  1282. }
  1283. return nil, "", err
  1284. }
  1285. // compute length of the time series in the cost data and only compute
  1286. // aggregates and cache if the length is sufficiently high
  1287. costDataLen := costDataTimeSeriesLength(costData)
  1288. if costDataLen == 0 {
  1289. return nil, "", &EmptyDataError{window: window}
  1290. }
  1291. if costDataLen >= minCostDataLength && !noCache {
  1292. log.Infof("ComputeAggregateCostModel: setting L2 cache: %s", key)
  1293. a.CostDataCache.Set(key, costData, cacheExpiry)
  1294. }
  1295. }
  1296. c, err := a.CloudProvider.GetConfig()
  1297. if err != nil {
  1298. return nil, "", err
  1299. }
  1300. discount, err := ParsePercentString(c.Discount)
  1301. if err != nil {
  1302. return nil, "", err
  1303. }
  1304. customDiscount, err := ParsePercentString(c.NegotiatedDiscount)
  1305. if err != nil {
  1306. return nil, "", err
  1307. }
  1308. sc := make(map[string]*SharedCostInfo)
  1309. if !disableSharedOverhead {
  1310. overheadVal := c.SharedOverhead
  1311. cost, err := strconv.ParseFloat(overheadVal, 64)
  1312. durationCoefficient := window.Hours() / timeutil.HoursPerMonth
  1313. if err != nil {
  1314. return nil, "", fmt.Errorf("unable to parse shared cost %s: %s", overheadVal, err)
  1315. }
  1316. sc["total"] = &SharedCostInfo{
  1317. Name: "total",
  1318. Cost: cost * durationCoefficient,
  1319. }
  1320. }
  1321. idleCoefficients := make(map[string]float64)
  1322. if allocateIdle {
  1323. dur, off, err := window.DurationOffset()
  1324. if err != nil {
  1325. log.Errorf("ComputeAggregateCostModel: error computing idle coefficient: illegal window: %s (%s)", window, err)
  1326. return nil, "", err
  1327. }
  1328. if a.ThanosClient != nil && off < thanos.OffsetDuration() {
  1329. // Determine difference between the Thanos offset and the requested
  1330. // offset; e.g. off=1h, thanosOffsetDuration=3h => diff=2h
  1331. diff := thanos.OffsetDuration() - off
  1332. // Reduce duration by difference and increase offset by difference
  1333. // e.g. 24h offset 0h => 21h offset 3h
  1334. dur = dur - diff
  1335. off = thanos.OffsetDuration()
  1336. log.Infof("ComputeAggregateCostModel: setting duration, offset to %s, %s due to Thanos", dur, off)
  1337. // Idle computation cannot be fulfilled for some windows, specifically
  1338. // those with sum(duration, offset) < Thanos offset, because there is
  1339. // no data within that window.
  1340. if dur <= 0 {
  1341. return nil, "", fmt.Errorf("requested idle coefficients from Thanos for illegal duration, offset: %s, %s (original window %s)", dur, off, window)
  1342. }
  1343. }
  1344. idleCoefficients, err = a.ComputeIdleCoefficient(costData, promClient, a.CloudProvider, discount, customDiscount, dur, off)
  1345. if err != nil {
  1346. durStr, offStr := timeutil.DurationOffsetStrings(dur, off)
  1347. log.Errorf("ComputeAggregateCostModel: error computing idle coefficient: duration=%s, offset=%s, err=%s", durStr, offStr, err)
  1348. return nil, "", err
  1349. }
  1350. }
  1351. totalContainerCost := 0.0
  1352. if shared == SplitTypeWeighted {
  1353. totalContainerCost = GetTotalContainerCost(costData, rate, a.CloudProvider, discount, customDiscount, idleCoefficients)
  1354. }
  1355. // filter cost data by namespace and cluster after caching for maximal cache hits
  1356. costData, filteredContainerCount, filteredEnvironments := FilterCostData(costData, retainFuncs, filterFuncs)
  1357. // aggregate cost model data by given fields and cache the result for the default expiration
  1358. aggOpts := &AggregationOptions{
  1359. Discount: discount,
  1360. CustomDiscount: customDiscount,
  1361. IdleCoefficients: idleCoefficients,
  1362. IncludeEfficiency: includeEfficiency,
  1363. IncludeTimeSeries: includeTimeSeries,
  1364. Rate: rate,
  1365. ResolutionHours: resolution.Hours(),
  1366. SharedResourceInfo: sri,
  1367. SharedCosts: sc,
  1368. FilteredContainerCount: filteredContainerCount,
  1369. FilteredEnvironments: filteredEnvironments,
  1370. TotalContainerCost: totalContainerCost,
  1371. SharedSplit: shared,
  1372. }
  1373. result := AggregateCostData(costData, field, subfields, a.CloudProvider, aggOpts)
  1374. // If sending time series data back, switch scale back to hourly data. At this point,
  1375. // resolutionHours may have converted our hourly data to more- or less-than hourly data.
  1376. if includeTimeSeries {
  1377. for _, aggs := range result {
  1378. ScaleAggregationTimeSeries(aggs, resolution.Hours())
  1379. }
  1380. }
  1381. // compute length of the time series in the cost data and only cache
  1382. // aggregation results if the length is sufficiently high
  1383. costDataLen := costDataTimeSeriesLength(costData)
  1384. if costDataLen >= minCostDataLength && window.Hours() > 1.0 && !noCache {
  1385. // Set the result map (rather than a pointer to it) because map is a reference type
  1386. log.Infof("ComputeAggregateCostModel: setting aggregate cache: %s", aggKey)
  1387. a.AggregateCache.Set(aggKey, result, cacheExpiry)
  1388. } else {
  1389. log.Infof("ComputeAggregateCostModel: not setting aggregate cache: %s (not enough data: %t; duration less than 1h: %t; noCache: %t)", key, costDataLen < minCostDataLength, window.Hours() < 1, noCache)
  1390. }
  1391. return result, cacheMessage, nil
  1392. }
  1393. // ScaleAggregationTimeSeries reverses the scaling done by ScaleHourlyCostData, returning
  1394. // the aggregation's time series to hourly data.
  1395. func ScaleAggregationTimeSeries(aggregation *Aggregation, resolutionHours float64) {
  1396. for _, v := range aggregation.CPUCostVector {
  1397. v.Value /= resolutionHours
  1398. }
  1399. for _, v := range aggregation.GPUCostVector {
  1400. v.Value /= resolutionHours
  1401. }
  1402. for _, v := range aggregation.RAMCostVector {
  1403. v.Value /= resolutionHours
  1404. }
  1405. for _, v := range aggregation.PVCostVector {
  1406. v.Value /= resolutionHours
  1407. }
  1408. for _, v := range aggregation.NetworkCostVector {
  1409. v.Value /= resolutionHours
  1410. }
  1411. for _, v := range aggregation.TotalCostVector {
  1412. v.Value /= resolutionHours
  1413. }
  1414. return
  1415. }
  1416. // String returns a string representation of the encapsulated shared resources, which
  1417. // can be used to uniquely identify a set of shared resources. Sorting sets of shared
  1418. // resources ensures that strings representing permutations of the same combination match.
  1419. func (s *SharedResourceInfo) String() string {
  1420. if s == nil {
  1421. return ""
  1422. }
  1423. nss := []string{}
  1424. for ns := range s.SharedNamespace {
  1425. nss = append(nss, ns)
  1426. }
  1427. sort.Strings(nss)
  1428. nsStr := strings.Join(nss, ",")
  1429. labels := []string{}
  1430. for lbl, vals := range s.LabelSelectors {
  1431. for val := range vals {
  1432. if lbl != "" && val != "" {
  1433. labels = append(labels, fmt.Sprintf("%s=%s", lbl, val))
  1434. }
  1435. }
  1436. }
  1437. sort.Strings(labels)
  1438. labelStr := strings.Join(labels, ",")
  1439. return fmt.Sprintf("%s:%s", nsStr, labelStr)
  1440. }
  1441. type aggKeyParams struct {
  1442. duration string
  1443. offset string
  1444. filters map[string]string
  1445. field string
  1446. subfields []string
  1447. rate string
  1448. sri *SharedResourceInfo
  1449. shareType string
  1450. idle bool
  1451. timeSeries bool
  1452. efficiency bool
  1453. }
  1454. // GenerateAggKey generates a parameter-unique key for caching the aggregate cost model
  1455. func GenerateAggKey(window kubecost.Window, field string, subfields []string, opts *AggregateQueryOpts) string {
  1456. if opts == nil {
  1457. opts = DefaultAggregateQueryOpts()
  1458. }
  1459. // Covert to duration, offset so that cache hits occur, even when timestamps have
  1460. // shifted slightly.
  1461. duration, offset := window.DurationOffsetStrings()
  1462. // parse, trim, and sort podprefix filters
  1463. podPrefixFilters := []string{}
  1464. if ppfs, ok := opts.Filters["podprefix"]; ok && ppfs != "" {
  1465. for _, psf := range strings.Split(ppfs, ",") {
  1466. podPrefixFilters = append(podPrefixFilters, strings.TrimSpace(psf))
  1467. }
  1468. }
  1469. sort.Strings(podPrefixFilters)
  1470. podPrefixFiltersStr := strings.Join(podPrefixFilters, ",")
  1471. // parse, trim, and sort namespace filters
  1472. nsFilters := []string{}
  1473. if nsfs, ok := opts.Filters["namespace"]; ok && nsfs != "" {
  1474. for _, nsf := range strings.Split(nsfs, ",") {
  1475. nsFilters = append(nsFilters, strings.TrimSpace(nsf))
  1476. }
  1477. }
  1478. sort.Strings(nsFilters)
  1479. nsFilterStr := strings.Join(nsFilters, ",")
  1480. // parse, trim, and sort node filters
  1481. nodeFilters := []string{}
  1482. if nodefs, ok := opts.Filters["node"]; ok && nodefs != "" {
  1483. for _, nodef := range strings.Split(nodefs, ",") {
  1484. nodeFilters = append(nodeFilters, strings.TrimSpace(nodef))
  1485. }
  1486. }
  1487. sort.Strings(nodeFilters)
  1488. nodeFilterStr := strings.Join(nodeFilters, ",")
  1489. // parse, trim, and sort cluster filters
  1490. cFilters := []string{}
  1491. if cfs, ok := opts.Filters["cluster"]; ok && cfs != "" {
  1492. for _, cf := range strings.Split(cfs, ",") {
  1493. cFilters = append(cFilters, strings.TrimSpace(cf))
  1494. }
  1495. }
  1496. sort.Strings(cFilters)
  1497. cFilterStr := strings.Join(cFilters, ",")
  1498. // parse, trim, and sort label filters
  1499. lFilters := []string{}
  1500. if lfs, ok := opts.Filters["labels"]; ok && lfs != "" {
  1501. for _, lf := range strings.Split(lfs, ",") {
  1502. // trim whitespace from the label name and the label value
  1503. // of each label name/value pair, then reconstruct
  1504. // e.g. "tier = frontend, app = kubecost" == "app=kubecost,tier=frontend"
  1505. lfa := strings.Split(lf, "=")
  1506. if len(lfa) == 2 {
  1507. lfn := strings.TrimSpace(lfa[0])
  1508. lfv := strings.TrimSpace(lfa[1])
  1509. lFilters = append(lFilters, fmt.Sprintf("%s=%s", lfn, lfv))
  1510. } else {
  1511. // label is not of the form name=value, so log it and move on
  1512. klog.V(2).Infof("[Warning] GenerateAggKey: skipping illegal label filter: %s", lf)
  1513. }
  1514. }
  1515. }
  1516. sort.Strings(lFilters)
  1517. lFilterStr := strings.Join(lFilters, ",")
  1518. // parse, trim, and sort annotation filters
  1519. aFilters := []string{}
  1520. if afs, ok := opts.Filters["annotations"]; ok && afs != "" {
  1521. for _, af := range strings.Split(afs, ",") {
  1522. // trim whitespace from the annotation name and the annotation value
  1523. // of each annotation name/value pair, then reconstruct
  1524. // e.g. "tier = frontend, app = kubecost" == "app=kubecost,tier=frontend"
  1525. afa := strings.Split(af, "=")
  1526. if len(afa) == 2 {
  1527. afn := strings.TrimSpace(afa[0])
  1528. afv := strings.TrimSpace(afa[1])
  1529. aFilters = append(aFilters, fmt.Sprintf("%s=%s", afn, afv))
  1530. } else {
  1531. // annotation is not of the form name=value, so log it and move on
  1532. klog.V(2).Infof("[Warning] GenerateAggKey: skipping illegal annotation filter: %s", af)
  1533. }
  1534. }
  1535. }
  1536. sort.Strings(aFilters)
  1537. aFilterStr := strings.Join(aFilters, ",")
  1538. filterStr := fmt.Sprintf("%s:%s:%s:%s:%s:%s", nsFilterStr, nodeFilterStr, cFilterStr, lFilterStr, aFilterStr, podPrefixFiltersStr)
  1539. sort.Strings(subfields)
  1540. fieldStr := fmt.Sprintf("%s:%s", field, strings.Join(subfields, ","))
  1541. if offset == "1m" {
  1542. offset = ""
  1543. }
  1544. return fmt.Sprintf("%s:%s:%s:%s:%s:%s:%s:%t:%t:%t", duration, offset, filterStr, fieldStr, opts.Rate,
  1545. opts.SharedResources, opts.ShareSplit, opts.AllocateIdle, opts.IncludeTimeSeries,
  1546. opts.IncludeEfficiency)
  1547. }
  1548. // Aggregator is capable of computing the aggregated cost model. This is
  1549. // a brutal interface, which should be cleaned up, but it's necessary for
  1550. // being able to swap in an ETL-backed implementation.
  1551. type Aggregator interface {
  1552. ComputeAggregateCostModel(promClient prometheusClient.Client, window kubecost.Window, field string, subfields []string, opts *AggregateQueryOpts) (map[string]*Aggregation, string, error)
  1553. }
  1554. func (a *Accesses) warmAggregateCostModelCache() {
  1555. // Only allow one concurrent cache-warming operation
  1556. sem := util.NewSemaphore(1)
  1557. // Set default values, pulling them from application settings where applicable, and warm the cache
  1558. // for the given duration. Cache is intentionally set to expire (i.e. noExpireCache=false) so that
  1559. // if the default parameters change, the old cached defaults with eventually expire. Thus, the
  1560. // timing of the cache expiry/refresh is the only mechanism ensuring 100% cache warmth.
  1561. warmFunc := func(duration, offset time.Duration, cacheEfficiencyData bool) (error, error) {
  1562. if a.ThanosClient != nil {
  1563. duration = thanos.OffsetDuration()
  1564. log.Infof("Setting Offset to %s", duration)
  1565. }
  1566. fmtDuration, fmtOffset := timeutil.DurationOffsetStrings(duration, offset)
  1567. durationHrs, err := timeutil.FormatDurationStringDaysToHours(fmtDuration)
  1568. promClient := a.GetPrometheusClient(true)
  1569. windowStr := fmt.Sprintf("%s offset %s", fmtDuration, fmtOffset)
  1570. window, err := kubecost.ParseWindowUTC(windowStr)
  1571. if err != nil {
  1572. return nil, fmt.Errorf("invalid window from window string: %s", windowStr)
  1573. }
  1574. field := "namespace"
  1575. subfields := []string{}
  1576. aggOpts := DefaultAggregateQueryOpts()
  1577. aggOpts.Rate = ""
  1578. aggOpts.Filters = map[string]string{}
  1579. aggOpts.IncludeTimeSeries = false
  1580. aggOpts.IncludeEfficiency = true
  1581. aggOpts.DisableCache = true
  1582. aggOpts.ClearCache = false
  1583. aggOpts.NoCache = false
  1584. aggOpts.NoExpireCache = false
  1585. aggOpts.ShareSplit = SplitTypeWeighted
  1586. aggOpts.RemoteEnabled = env.IsRemoteEnabled()
  1587. aggOpts.AllocateIdle = cloud.AllocateIdleByDefault(a.CloudProvider)
  1588. sharedNamespaces := cloud.SharedNamespaces(a.CloudProvider)
  1589. sharedLabelNames, sharedLabelValues := cloud.SharedLabels(a.CloudProvider)
  1590. if len(sharedNamespaces) > 0 || len(sharedLabelNames) > 0 {
  1591. aggOpts.SharedResources = NewSharedResourceInfo(true, sharedNamespaces, sharedLabelNames, sharedLabelValues)
  1592. }
  1593. aggKey := GenerateAggKey(window, field, subfields, aggOpts)
  1594. log.Infof("aggregation: cache warming defaults: %s", aggKey)
  1595. key := fmt.Sprintf("%s:%s", durationHrs, fmtOffset)
  1596. _, _, aggErr := a.ComputeAggregateCostModel(promClient, window, field, subfields, aggOpts)
  1597. if aggErr != nil {
  1598. log.Infof("Error building cache %s: %s", window, aggErr)
  1599. }
  1600. totals, err := a.ComputeClusterCosts(promClient, a.CloudProvider, duration, offset, cacheEfficiencyData)
  1601. if err != nil {
  1602. log.Infof("Error building cluster costs cache %s", key)
  1603. }
  1604. maxMinutesWithData := 0.0
  1605. for _, cluster := range totals {
  1606. if cluster.DataMinutes > maxMinutesWithData {
  1607. maxMinutesWithData = cluster.DataMinutes
  1608. }
  1609. }
  1610. if len(totals) > 0 && maxMinutesWithData > clusterCostsCacheMinutes {
  1611. a.ClusterCostsCache.Set(key, totals, a.GetCacheExpiration(window.Duration()))
  1612. log.Infof("caching %s cluster costs for %s", fmtDuration, a.GetCacheExpiration(window.Duration()))
  1613. } else {
  1614. log.Warningf("not caching %s cluster costs: no data or less than %f minutes data ", fmtDuration, clusterCostsCacheMinutes)
  1615. }
  1616. return aggErr, err
  1617. }
  1618. // 1 day
  1619. go func(sem *util.Semaphore) {
  1620. defer errors.HandlePanic()
  1621. offset := time.Minute
  1622. duration := 24 * time.Hour
  1623. for {
  1624. sem.Acquire()
  1625. warmFunc(duration, offset, true)
  1626. sem.Return()
  1627. log.Infof("aggregation: warm cache: %s", timeutil.DurationString(duration))
  1628. time.Sleep(a.GetCacheRefresh(duration))
  1629. }
  1630. }(sem)
  1631. if !env.IsETLEnabled() {
  1632. // 2 day
  1633. go func(sem *util.Semaphore) {
  1634. defer errors.HandlePanic()
  1635. offset := time.Minute
  1636. duration := 2 * 24 * time.Hour
  1637. for {
  1638. sem.Acquire()
  1639. warmFunc(duration, offset, false)
  1640. sem.Return()
  1641. log.Infof("aggregation: warm cache: %s", timeutil.DurationString(duration))
  1642. time.Sleep(a.GetCacheRefresh(duration))
  1643. }
  1644. }(sem)
  1645. // 7 day
  1646. go func(sem *util.Semaphore) {
  1647. defer errors.HandlePanic()
  1648. offset := time.Minute
  1649. duration := 7 * 24 * time.Hour
  1650. for {
  1651. sem.Acquire()
  1652. aggErr, err := warmFunc(duration, offset, false)
  1653. sem.Return()
  1654. log.Infof("aggregation: warm cache: %s", timeutil.DurationString(duration))
  1655. if aggErr == nil && err == nil {
  1656. time.Sleep(a.GetCacheRefresh(duration))
  1657. } else {
  1658. time.Sleep(5 * time.Minute)
  1659. }
  1660. }
  1661. }(sem)
  1662. // 30 day
  1663. go func(sem *util.Semaphore) {
  1664. defer errors.HandlePanic()
  1665. for {
  1666. offset := time.Minute
  1667. duration := 30 * 24 * time.Hour
  1668. sem.Acquire()
  1669. aggErr, err := warmFunc(duration, offset, false)
  1670. sem.Return()
  1671. if aggErr == nil && err == nil {
  1672. time.Sleep(a.GetCacheRefresh(duration))
  1673. } else {
  1674. time.Sleep(5 * time.Minute)
  1675. }
  1676. }
  1677. }(sem)
  1678. }
  1679. }
  1680. // AggregateCostModelHandler handles requests to the aggregated cost model API. See
  1681. // ComputeAggregateCostModel for details.
  1682. func (a *Accesses) AggregateCostModelHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
  1683. w.Header().Set("Content-Type", "application/json")
  1684. windowStr := r.URL.Query().Get("window")
  1685. // Convert UTC-RFC3339 pairs to configured UTC offset
  1686. // e.g. with UTC offset of -0600, 2020-07-01T00:00:00Z becomes
  1687. // 2020-07-01T06:00:00Z == 2020-07-01T00:00:00-0600
  1688. // TODO niko/etl fix the frontend because this is confusing if you're
  1689. // actually asking for UTC time (...Z) and we swap that "Z" out for the
  1690. // configured UTC offset without asking
  1691. rfc3339 := `\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ`
  1692. regex := regexp.MustCompile(fmt.Sprintf(`(%s),(%s)`, rfc3339, rfc3339))
  1693. match := regex.FindStringSubmatch(windowStr)
  1694. if match != nil {
  1695. start, _ := time.Parse(time.RFC3339, match[1])
  1696. start = start.Add(-env.GetParsedUTCOffset()).In(time.UTC)
  1697. end, _ := time.Parse(time.RFC3339, match[2])
  1698. end = end.Add(-env.GetParsedUTCOffset()).In(time.UTC)
  1699. windowStr = fmt.Sprintf("%sZ,%sZ", start.Format("2006-01-02T15:04:05"), end.Format("2006-01-02T15:04:05Z"))
  1700. }
  1701. // determine duration and offset from query parameters
  1702. window, err := kubecost.ParseWindowWithOffset(windowStr, env.GetParsedUTCOffset())
  1703. if err != nil || window.Start() == nil {
  1704. WriteError(w, BadRequest(fmt.Sprintf("invalid window: %s", err)))
  1705. return
  1706. }
  1707. durRegex := regexp.MustCompile(`^(\d+)(m|h|d|s)$`)
  1708. isDurationStr := durRegex.MatchString(windowStr)
  1709. // legacy offset option should override window offset
  1710. if r.URL.Query().Get("offset") != "" {
  1711. offset := r.URL.Query().Get("offset")
  1712. // Shift window by offset, but only when manually set with separate
  1713. // parameter and window was provided as a duration string. Otherwise,
  1714. // do not alter the (duration, offset) from ParseWindowWithOffset.
  1715. if offset != "1m" && isDurationStr {
  1716. match := durRegex.FindStringSubmatch(offset)
  1717. if match != nil && len(match) == 3 {
  1718. dur := time.Minute
  1719. if match[2] == "h" {
  1720. dur = time.Hour
  1721. }
  1722. if match[2] == "d" {
  1723. dur = 24 * time.Hour
  1724. }
  1725. if match[2] == "s" {
  1726. dur = time.Second
  1727. }
  1728. num, _ := strconv.ParseInt(match[1], 10, 64)
  1729. window = window.Shift(-time.Duration(num) * dur)
  1730. }
  1731. }
  1732. }
  1733. opts := DefaultAggregateQueryOpts()
  1734. // parse remaining query parameters
  1735. namespace := r.URL.Query().Get("namespace")
  1736. cluster := r.URL.Query().Get("cluster")
  1737. labels := r.URL.Query().Get("labels")
  1738. annotations := r.URL.Query().Get("annotations")
  1739. podprefix := r.URL.Query().Get("podprefix")
  1740. field := r.URL.Query().Get("aggregation")
  1741. sharedNamespaces := r.URL.Query().Get("sharedNamespaces")
  1742. sharedLabelNames := r.URL.Query().Get("sharedLabelNames")
  1743. sharedLabelValues := r.URL.Query().Get("sharedLabelValues")
  1744. remote := r.URL.Query().Get("remote") != "false"
  1745. subfieldStr := r.URL.Query().Get("aggregationSubfield")
  1746. subfields := []string{}
  1747. if len(subfieldStr) > 0 {
  1748. s := strings.Split(r.URL.Query().Get("aggregationSubfield"), ",")
  1749. for _, rawLabel := range s {
  1750. subfields = append(subfields, prom.SanitizeLabelName(rawLabel))
  1751. }
  1752. }
  1753. idleFlag := r.URL.Query().Get("allocateIdle")
  1754. if idleFlag == "default" {
  1755. c, _ := a.CloudProvider.GetConfig()
  1756. opts.AllocateIdle = (c.DefaultIdle == "true")
  1757. } else {
  1758. opts.AllocateIdle = (idleFlag == "true")
  1759. }
  1760. opts.Rate = r.URL.Query().Get("rate")
  1761. opts.ShareSplit = r.URL.Query().Get("sharedSplit")
  1762. // timeSeries == true maintains the time series dimension of the data,
  1763. // which by default gets summed over the entire interval
  1764. opts.IncludeTimeSeries = r.URL.Query().Get("timeSeries") == "true"
  1765. // efficiency has been deprecated in favor of a default to always send efficiency
  1766. opts.IncludeEfficiency = true
  1767. // TODO niko/caching rename "recomputeCache"
  1768. // disableCache, if set to "true", tells this function to recompute and
  1769. // cache the requested data
  1770. opts.DisableCache = r.URL.Query().Get("disableCache") == "true"
  1771. // clearCache, if set to "true", tells this function to flush the cache,
  1772. // then recompute and cache the requested data
  1773. opts.ClearCache = r.URL.Query().Get("clearCache") == "true"
  1774. // noCache avoids the cache altogether, both reading from and writing to
  1775. opts.NoCache = r.URL.Query().Get("noCache") == "true"
  1776. // noExpireCache should only be used by cache warming to set non-expiring caches
  1777. opts.NoExpireCache = false
  1778. // etl triggers ETL adapter
  1779. opts.UseETLAdapter = r.URL.Query().Get("etl") == "true"
  1780. // aggregation field is required
  1781. if field == "" {
  1782. WriteError(w, BadRequest("Missing aggregation field parameter"))
  1783. return
  1784. }
  1785. // aggregation subfield is required when aggregation field is "label"
  1786. if (field == "label" || field == "annotation") && len(subfields) == 0 {
  1787. WriteError(w, BadRequest("Missing aggregation subfield parameter"))
  1788. return
  1789. }
  1790. // enforce one of the available rate options
  1791. if opts.Rate != "" && opts.Rate != "hourly" && opts.Rate != "daily" && opts.Rate != "monthly" {
  1792. WriteError(w, BadRequest("Rate parameter only supports: hourly, daily, monthly or empty"))
  1793. return
  1794. }
  1795. // parse cost data filters
  1796. // namespace and cluster are exact-string-matches
  1797. // labels are expected to be comma-separated and to take the form key=value
  1798. // e.g. app=cost-analyzer,app.kubernetes.io/instance=kubecost
  1799. opts.Filters = map[string]string{
  1800. "namespace": namespace,
  1801. "cluster": cluster,
  1802. "labels": labels,
  1803. "annotations": annotations,
  1804. "podprefix": podprefix,
  1805. }
  1806. // parse shared resources
  1807. sn := []string{}
  1808. sln := []string{}
  1809. slv := []string{}
  1810. if sharedNamespaces != "" {
  1811. sn = strings.Split(sharedNamespaces, ",")
  1812. }
  1813. if sharedLabelNames != "" {
  1814. sln = strings.Split(sharedLabelNames, ",")
  1815. slv = strings.Split(sharedLabelValues, ",")
  1816. if len(sln) != len(slv) || slv[0] == "" {
  1817. WriteError(w, BadRequest("Supply exactly one shared label value per shared label name"))
  1818. return
  1819. }
  1820. }
  1821. if len(sn) > 0 || len(sln) > 0 {
  1822. opts.SharedResources = NewSharedResourceInfo(true, sn, sln, slv)
  1823. }
  1824. // enable remote if it is available and not disabled
  1825. opts.RemoteEnabled = remote && env.IsRemoteEnabled()
  1826. promClient := a.GetPrometheusClient(remote)
  1827. var data map[string]*Aggregation
  1828. var message string
  1829. data, message, err = a.AggAPI.ComputeAggregateCostModel(promClient, window, field, subfields, opts)
  1830. // Find any warnings in http request context
  1831. warning, _ := util.GetWarning(r)
  1832. if err != nil {
  1833. if emptyErr, ok := err.(*EmptyDataError); ok {
  1834. if warning == "" {
  1835. w.Write(WrapData(map[string]interface{}{}, emptyErr))
  1836. } else {
  1837. w.Write(WrapDataWithWarning(map[string]interface{}{}, emptyErr, warning))
  1838. }
  1839. return
  1840. }
  1841. if boundaryErr, ok := err.(*kubecost.BoundaryError); ok {
  1842. if window.Start() != nil && window.Start().After(time.Now().Add(-90*24*time.Hour)) {
  1843. // Asking for data within a 90 day period: it will be available
  1844. // after the pipeline builds
  1845. msg := "Data will be available after ETL is built"
  1846. rex := regexp.MustCompile(`(\d+\.*\d*)%`)
  1847. match := rex.FindStringSubmatch(boundaryErr.Message)
  1848. if len(match) > 1 {
  1849. completionPct, err := strconv.ParseFloat(match[1], 64)
  1850. if err == nil {
  1851. msg = fmt.Sprintf("%s (%.1f%% complete)", msg, completionPct)
  1852. }
  1853. }
  1854. WriteError(w, InternalServerError(msg))
  1855. } else {
  1856. // Boundary error outside of 90 day period; may not be available
  1857. WriteError(w, InternalServerError(boundaryErr.Error()))
  1858. }
  1859. return
  1860. }
  1861. errStr := fmt.Sprintf("error computing aggregate cost model: %s", err)
  1862. WriteError(w, InternalServerError(errStr))
  1863. return
  1864. }
  1865. if warning == "" {
  1866. w.Write(WrapDataWithMessage(data, nil, message))
  1867. } else {
  1868. w.Write(WrapDataWithMessageAndWarning(data, nil, message, warning))
  1869. }
  1870. }
  1871. // ParseAggregationProperties attempts to parse and return aggregation properties
  1872. // encoded under the given key. If none exist, or if parsing fails, an error
  1873. // is returned with empty AllocationProperties.
  1874. func ParseAggregationProperties(qp util.QueryParams, key string) ([]string, error) {
  1875. aggregateBy := []string{}
  1876. for _, agg := range qp.GetList(key, ",") {
  1877. aggregate := strings.TrimSpace(agg)
  1878. if aggregate != "" {
  1879. if prop, err := kubecost.ParseProperty(aggregate); err == nil {
  1880. aggregateBy = append(aggregateBy, string(prop))
  1881. } else if strings.HasPrefix(aggregate, "label:") {
  1882. aggregateBy = append(aggregateBy, aggregate)
  1883. } else if strings.HasPrefix(aggregate, "annotation:") {
  1884. aggregateBy = append(aggregateBy, aggregate)
  1885. }
  1886. }
  1887. }
  1888. return aggregateBy, nil
  1889. }
  1890. // ComputeAllocationHandler computes an AllocationSetRange from the CostModel.
  1891. func (a *Accesses) ComputeAllocationHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
  1892. w.Header().Set("Content-Type", "application/json")
  1893. qp := util.NewQueryParams(r.URL.Query())
  1894. // Window is a required field describing the window of time over which to
  1895. // compute allocation data.
  1896. window, err := kubecost.ParseWindowWithOffset(qp.Get("window", ""), env.GetParsedUTCOffset())
  1897. if err != nil {
  1898. http.Error(w, fmt.Sprintf("Invalid 'window' parameter: %s", err), http.StatusBadRequest)
  1899. }
  1900. // Step is an optional parameter that defines the duration per-set, i.e.
  1901. // the window for an AllocationSet, of the AllocationSetRange to be
  1902. // computed. Defaults to the window size, making one set.
  1903. step := qp.GetDuration("step", window.Duration())
  1904. // Resolution is an optional parameter, defaulting to the configured ETL
  1905. // resolution.
  1906. resolution := qp.GetDuration("resolution", env.GetETLResolution())
  1907. // Aggregation is a required comma-separated list of fields by which to
  1908. // aggregate results. Some fields allow a sub-field, which is distinguished
  1909. // with a colon; e.g. "label:app".
  1910. // Examples: "namespace", "namespace,label:app"
  1911. aggregateBy, err := ParseAggregationProperties(qp, "aggregate")
  1912. if err != nil {
  1913. http.Error(w, fmt.Sprintf("Invalid 'aggregate' parameter: %s", err), http.StatusBadRequest)
  1914. }
  1915. // Accumulate is an optional parameter, defaulting to false, which if true
  1916. // sums each Set in the Range, producing one Set.
  1917. accumulate := qp.GetBool("accumulate", false)
  1918. // Query for AllocationSets in increments of the given step duration,
  1919. // appending each to the AllocationSetRange.
  1920. asr := kubecost.NewAllocationSetRange()
  1921. stepStart := *window.Start()
  1922. for window.End().After(stepStart) {
  1923. stepEnd := stepStart.Add(step)
  1924. stepWindow := kubecost.NewWindow(&stepStart, &stepEnd)
  1925. as, err := a.Model.ComputeAllocation(*stepWindow.Start(), *stepWindow.End(), resolution)
  1926. if err != nil {
  1927. WriteError(w, InternalServerError(err.Error()))
  1928. return
  1929. }
  1930. asr.Append(as)
  1931. stepStart = stepEnd
  1932. }
  1933. // Aggregate, if requested
  1934. if len(aggregateBy) > 0 {
  1935. err = asr.AggregateBy(aggregateBy, nil)
  1936. if err != nil {
  1937. WriteError(w, InternalServerError(err.Error()))
  1938. return
  1939. }
  1940. }
  1941. // Accumulate, if requested
  1942. if accumulate {
  1943. as, err := asr.Accumulate()
  1944. if err != nil {
  1945. WriteError(w, InternalServerError(err.Error()))
  1946. return
  1947. }
  1948. asr = kubecost.NewAllocationSetRange(as)
  1949. }
  1950. w.Write(WrapData(asr, nil))
  1951. }
  1952. // The below was transferred from a different package in order to maintain
  1953. // previous behavior. Ultimately, we should clean this up at some point.
  1954. // TODO move to util and/or standardize everything
  1955. type Error struct {
  1956. StatusCode int
  1957. Body string
  1958. }
  1959. func WriteError(w http.ResponseWriter, err Error) {
  1960. status := err.StatusCode
  1961. if status == 0 {
  1962. status = http.StatusInternalServerError
  1963. }
  1964. w.WriteHeader(status)
  1965. resp, _ := json.Marshal(&Response{
  1966. Code: status,
  1967. Message: fmt.Sprintf("Error: %s", err.Body),
  1968. })
  1969. w.Write(resp)
  1970. }
  1971. func BadRequest(message string) Error {
  1972. return Error{
  1973. StatusCode: http.StatusBadRequest,
  1974. Body: message,
  1975. }
  1976. }
  1977. func InternalServerError(message string) Error {
  1978. if message == "" {
  1979. message = "Internal Server Error"
  1980. }
  1981. return Error{
  1982. StatusCode: http.StatusInternalServerError,
  1983. Body: message,
  1984. }
  1985. }
  1986. func NotFound() Error {
  1987. return Error{
  1988. StatusCode: http.StatusNotFound,
  1989. Body: "Not Found",
  1990. }
  1991. }