aggregation.go 82 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252
  1. package costmodel
  2. import (
  3. "fmt"
  4. "github.com/kubecost/cost-model/pkg/util/timeutil"
  5. "math"
  6. "net/http"
  7. "regexp"
  8. "sort"
  9. "strconv"
  10. "strings"
  11. "time"
  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. for key, val := range c.SharedCosts {
  1311. cost, err := strconv.ParseFloat(val, 64)
  1312. durationCoefficient := window.Hours() / timeutil.HoursPerMonth
  1313. if err != nil {
  1314. return nil, "", fmt.Errorf("unable to parse shared cost %s: %s", val, err)
  1315. }
  1316. sc[key] = &SharedCostInfo{
  1317. Name: key,
  1318. Cost: cost * durationCoefficient,
  1319. }
  1320. }
  1321. }
  1322. idleCoefficients := make(map[string]float64)
  1323. if allocateIdle {
  1324. dur, off, err := window.DurationOffset()
  1325. if err != nil {
  1326. log.Errorf("ComputeAggregateCostModel: error computing idle coefficient: illegal window: %s (%s)", window, err)
  1327. return nil, "", err
  1328. }
  1329. if a.ThanosClient != nil && off < thanos.OffsetDuration() {
  1330. // Determine difference between the Thanos offset and the requested
  1331. // offset; e.g. off=1h, thanosOffsetDuration=3h => diff=2h
  1332. diff := thanos.OffsetDuration() - off
  1333. // Reduce duration by difference and increase offset by difference
  1334. // e.g. 24h offset 0h => 21h offset 3h
  1335. dur = dur - diff
  1336. off = thanos.OffsetDuration()
  1337. log.Infof("ComputeAggregateCostModel: setting duration, offset to %s, %s due to Thanos", dur, off)
  1338. // Idle computation cannot be fulfilled for some windows, specifically
  1339. // those with sum(duration, offset) < Thanos offset, because there is
  1340. // no data within that window.
  1341. if dur <= 0 {
  1342. return nil, "", fmt.Errorf("requested idle coefficients from Thanos for illegal duration, offset: %s, %s (original window %s)", dur, off, window)
  1343. }
  1344. }
  1345. idleCoefficients, err = a.ComputeIdleCoefficient(costData, promClient, a.CloudProvider, discount, customDiscount, dur, off)
  1346. if err != nil {
  1347. durStr, offStr := timeutil.DurationOffsetStrings(dur, off)
  1348. log.Errorf("ComputeAggregateCostModel: error computing idle coefficient: duration=%s, offset=%s, err=%s", durStr, offStr, err)
  1349. return nil, "", err
  1350. }
  1351. }
  1352. totalContainerCost := 0.0
  1353. if shared == SplitTypeWeighted {
  1354. totalContainerCost = GetTotalContainerCost(costData, rate, a.CloudProvider, discount, customDiscount, idleCoefficients)
  1355. }
  1356. // filter cost data by namespace and cluster after caching for maximal cache hits
  1357. costData, filteredContainerCount, filteredEnvironments := FilterCostData(costData, retainFuncs, filterFuncs)
  1358. // aggregate cost model data by given fields and cache the result for the default expiration
  1359. aggOpts := &AggregationOptions{
  1360. Discount: discount,
  1361. CustomDiscount: customDiscount,
  1362. IdleCoefficients: idleCoefficients,
  1363. IncludeEfficiency: includeEfficiency,
  1364. IncludeTimeSeries: includeTimeSeries,
  1365. Rate: rate,
  1366. ResolutionHours: resolution.Hours(),
  1367. SharedResourceInfo: sri,
  1368. SharedCosts: sc,
  1369. FilteredContainerCount: filteredContainerCount,
  1370. FilteredEnvironments: filteredEnvironments,
  1371. TotalContainerCost: totalContainerCost,
  1372. SharedSplit: shared,
  1373. }
  1374. result := AggregateCostData(costData, field, subfields, a.CloudProvider, aggOpts)
  1375. // If sending time series data back, switch scale back to hourly data. At this point,
  1376. // resolutionHours may have converted our hourly data to more- or less-than hourly data.
  1377. if includeTimeSeries {
  1378. for _, aggs := range result {
  1379. ScaleAggregationTimeSeries(aggs, resolution.Hours())
  1380. }
  1381. }
  1382. // compute length of the time series in the cost data and only cache
  1383. // aggregation results if the length is sufficiently high
  1384. costDataLen := costDataTimeSeriesLength(costData)
  1385. if costDataLen >= minCostDataLength && window.Hours() > 1.0 && !noCache {
  1386. // Set the result map (rather than a pointer to it) because map is a reference type
  1387. log.Infof("ComputeAggregateCostModel: setting aggregate cache: %s", aggKey)
  1388. a.AggregateCache.Set(aggKey, result, cacheExpiry)
  1389. } else {
  1390. 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)
  1391. }
  1392. return result, cacheMessage, nil
  1393. }
  1394. // ScaleAggregationTimeSeries reverses the scaling done by ScaleHourlyCostData, returning
  1395. // the aggregation's time series to hourly data.
  1396. func ScaleAggregationTimeSeries(aggregation *Aggregation, resolutionHours float64) {
  1397. for _, v := range aggregation.CPUCostVector {
  1398. v.Value /= resolutionHours
  1399. }
  1400. for _, v := range aggregation.GPUCostVector {
  1401. v.Value /= resolutionHours
  1402. }
  1403. for _, v := range aggregation.RAMCostVector {
  1404. v.Value /= resolutionHours
  1405. }
  1406. for _, v := range aggregation.PVCostVector {
  1407. v.Value /= resolutionHours
  1408. }
  1409. for _, v := range aggregation.NetworkCostVector {
  1410. v.Value /= resolutionHours
  1411. }
  1412. for _, v := range aggregation.TotalCostVector {
  1413. v.Value /= resolutionHours
  1414. }
  1415. return
  1416. }
  1417. // String returns a string representation of the encapsulated shared resources, which
  1418. // can be used to uniquely identify a set of shared resources. Sorting sets of shared
  1419. // resources ensures that strings representing permutations of the same combination match.
  1420. func (s *SharedResourceInfo) String() string {
  1421. if s == nil {
  1422. return ""
  1423. }
  1424. nss := []string{}
  1425. for ns := range s.SharedNamespace {
  1426. nss = append(nss, ns)
  1427. }
  1428. sort.Strings(nss)
  1429. nsStr := strings.Join(nss, ",")
  1430. labels := []string{}
  1431. for lbl, vals := range s.LabelSelectors {
  1432. for val := range vals {
  1433. if lbl != "" && val != "" {
  1434. labels = append(labels, fmt.Sprintf("%s=%s", lbl, val))
  1435. }
  1436. }
  1437. }
  1438. sort.Strings(labels)
  1439. labelStr := strings.Join(labels, ",")
  1440. return fmt.Sprintf("%s:%s", nsStr, labelStr)
  1441. }
  1442. type aggKeyParams struct {
  1443. duration string
  1444. offset string
  1445. filters map[string]string
  1446. field string
  1447. subfields []string
  1448. rate string
  1449. sri *SharedResourceInfo
  1450. shareType string
  1451. idle bool
  1452. timeSeries bool
  1453. efficiency bool
  1454. }
  1455. // GenerateAggKey generates a parameter-unique key for caching the aggregate cost model
  1456. func GenerateAggKey(window kubecost.Window, field string, subfields []string, opts *AggregateQueryOpts) string {
  1457. if opts == nil {
  1458. opts = DefaultAggregateQueryOpts()
  1459. }
  1460. // Covert to duration, offset so that cache hits occur, even when timestamps have
  1461. // shifted slightly.
  1462. duration, offset := window.DurationOffsetStrings()
  1463. // parse, trim, and sort podprefix filters
  1464. podPrefixFilters := []string{}
  1465. if ppfs, ok := opts.Filters["podprefix"]; ok && ppfs != "" {
  1466. for _, psf := range strings.Split(ppfs, ",") {
  1467. podPrefixFilters = append(podPrefixFilters, strings.TrimSpace(psf))
  1468. }
  1469. }
  1470. sort.Strings(podPrefixFilters)
  1471. podPrefixFiltersStr := strings.Join(podPrefixFilters, ",")
  1472. // parse, trim, and sort namespace filters
  1473. nsFilters := []string{}
  1474. if nsfs, ok := opts.Filters["namespace"]; ok && nsfs != "" {
  1475. for _, nsf := range strings.Split(nsfs, ",") {
  1476. nsFilters = append(nsFilters, strings.TrimSpace(nsf))
  1477. }
  1478. }
  1479. sort.Strings(nsFilters)
  1480. nsFilterStr := strings.Join(nsFilters, ",")
  1481. // parse, trim, and sort node filters
  1482. nodeFilters := []string{}
  1483. if nodefs, ok := opts.Filters["node"]; ok && nodefs != "" {
  1484. for _, nodef := range strings.Split(nodefs, ",") {
  1485. nodeFilters = append(nodeFilters, strings.TrimSpace(nodef))
  1486. }
  1487. }
  1488. sort.Strings(nodeFilters)
  1489. nodeFilterStr := strings.Join(nodeFilters, ",")
  1490. // parse, trim, and sort cluster filters
  1491. cFilters := []string{}
  1492. if cfs, ok := opts.Filters["cluster"]; ok && cfs != "" {
  1493. for _, cf := range strings.Split(cfs, ",") {
  1494. cFilters = append(cFilters, strings.TrimSpace(cf))
  1495. }
  1496. }
  1497. sort.Strings(cFilters)
  1498. cFilterStr := strings.Join(cFilters, ",")
  1499. // parse, trim, and sort label filters
  1500. lFilters := []string{}
  1501. if lfs, ok := opts.Filters["labels"]; ok && lfs != "" {
  1502. for _, lf := range strings.Split(lfs, ",") {
  1503. // trim whitespace from the label name and the label value
  1504. // of each label name/value pair, then reconstruct
  1505. // e.g. "tier = frontend, app = kubecost" == "app=kubecost,tier=frontend"
  1506. lfa := strings.Split(lf, "=")
  1507. if len(lfa) == 2 {
  1508. lfn := strings.TrimSpace(lfa[0])
  1509. lfv := strings.TrimSpace(lfa[1])
  1510. lFilters = append(lFilters, fmt.Sprintf("%s=%s", lfn, lfv))
  1511. } else {
  1512. // label is not of the form name=value, so log it and move on
  1513. klog.V(2).Infof("[Warning] GenerateAggKey: skipping illegal label filter: %s", lf)
  1514. }
  1515. }
  1516. }
  1517. sort.Strings(lFilters)
  1518. lFilterStr := strings.Join(lFilters, ",")
  1519. // parse, trim, and sort annotation filters
  1520. aFilters := []string{}
  1521. if afs, ok := opts.Filters["annotations"]; ok && afs != "" {
  1522. for _, af := range strings.Split(afs, ",") {
  1523. // trim whitespace from the annotation name and the annotation value
  1524. // of each annotation name/value pair, then reconstruct
  1525. // e.g. "tier = frontend, app = kubecost" == "app=kubecost,tier=frontend"
  1526. afa := strings.Split(af, "=")
  1527. if len(afa) == 2 {
  1528. afn := strings.TrimSpace(afa[0])
  1529. afv := strings.TrimSpace(afa[1])
  1530. aFilters = append(aFilters, fmt.Sprintf("%s=%s", afn, afv))
  1531. } else {
  1532. // annotation is not of the form name=value, so log it and move on
  1533. klog.V(2).Infof("[Warning] GenerateAggKey: skipping illegal annotation filter: %s", af)
  1534. }
  1535. }
  1536. }
  1537. sort.Strings(aFilters)
  1538. aFilterStr := strings.Join(aFilters, ",")
  1539. filterStr := fmt.Sprintf("%s:%s:%s:%s:%s:%s", nsFilterStr, nodeFilterStr, cFilterStr, lFilterStr, aFilterStr, podPrefixFiltersStr)
  1540. sort.Strings(subfields)
  1541. fieldStr := fmt.Sprintf("%s:%s", field, strings.Join(subfields, ","))
  1542. if offset == "1m" {
  1543. offset = ""
  1544. }
  1545. return fmt.Sprintf("%s:%s:%s:%s:%s:%s:%s:%t:%t:%t", duration, offset, filterStr, fieldStr, opts.Rate,
  1546. opts.SharedResources, opts.ShareSplit, opts.AllocateIdle, opts.IncludeTimeSeries,
  1547. opts.IncludeEfficiency)
  1548. }
  1549. // Aggregator is capable of computing the aggregated cost model. This is
  1550. // a brutal interface, which should be cleaned up, but it's necessary for
  1551. // being able to swap in an ETL-backed implementation.
  1552. type Aggregator interface {
  1553. ComputeAggregateCostModel(promClient prometheusClient.Client, window kubecost.Window, field string, subfields []string, opts *AggregateQueryOpts) (map[string]*Aggregation, string, error)
  1554. }
  1555. func (a *Accesses) warmAggregateCostModelCache() {
  1556. // Only allow one concurrent cache-warming operation
  1557. sem := util.NewSemaphore(1)
  1558. // Set default values, pulling them from application settings where applicable, and warm the cache
  1559. // for the given duration. Cache is intentionally set to expire (i.e. noExpireCache=false) so that
  1560. // if the default parameters change, the old cached defaults with eventually expire. Thus, the
  1561. // timing of the cache expiry/refresh is the only mechanism ensuring 100% cache warmth.
  1562. warmFunc := func(duration, offset time.Duration, cacheEfficiencyData bool) (error, error) {
  1563. if a.ThanosClient != nil {
  1564. duration = thanos.OffsetDuration()
  1565. log.Infof("Setting Offset to %s", duration)
  1566. }
  1567. fmtDuration, fmtOffset := timeutil.DurationOffsetStrings(duration, offset)
  1568. durationHrs, err := timeutil.FormatDurationStringDaysToHours(fmtDuration)
  1569. promClient := a.GetPrometheusClient(true)
  1570. windowStr := fmt.Sprintf("%s offset %s", fmtDuration, fmtOffset)
  1571. window, err := kubecost.ParseWindowUTC(windowStr)
  1572. if err != nil {
  1573. return nil, fmt.Errorf("invalid window from window string: %s", windowStr)
  1574. }
  1575. field := "namespace"
  1576. subfields := []string{}
  1577. aggOpts := DefaultAggregateQueryOpts()
  1578. aggOpts.Rate = ""
  1579. aggOpts.Filters = map[string]string{}
  1580. aggOpts.IncludeTimeSeries = false
  1581. aggOpts.IncludeEfficiency = true
  1582. aggOpts.DisableCache = true
  1583. aggOpts.ClearCache = false
  1584. aggOpts.NoCache = false
  1585. aggOpts.NoExpireCache = false
  1586. aggOpts.ShareSplit = SplitTypeWeighted
  1587. aggOpts.RemoteEnabled = env.IsRemoteEnabled()
  1588. aggOpts.AllocateIdle = cloud.AllocateIdleByDefault(a.CloudProvider)
  1589. sharedNamespaces := cloud.SharedNamespaces(a.CloudProvider)
  1590. sharedLabelNames, sharedLabelValues := cloud.SharedLabels(a.CloudProvider)
  1591. if len(sharedNamespaces) > 0 || len(sharedLabelNames) > 0 {
  1592. aggOpts.SharedResources = NewSharedResourceInfo(true, sharedNamespaces, sharedLabelNames, sharedLabelValues)
  1593. }
  1594. aggKey := GenerateAggKey(window, field, subfields, aggOpts)
  1595. log.Infof("aggregation: cache warming defaults: %s", aggKey)
  1596. key := fmt.Sprintf("%s:%s", durationHrs, fmtOffset)
  1597. _, _, aggErr := a.ComputeAggregateCostModel(promClient, window, field, subfields, aggOpts)
  1598. if aggErr != nil {
  1599. log.Infof("Error building cache %s: %s", window, aggErr)
  1600. }
  1601. totals, err := a.ComputeClusterCosts(promClient, a.CloudProvider, duration, offset, cacheEfficiencyData)
  1602. if err != nil {
  1603. log.Infof("Error building cluster costs cache %s", key)
  1604. }
  1605. maxMinutesWithData := 0.0
  1606. for _, cluster := range totals {
  1607. if cluster.DataMinutes > maxMinutesWithData {
  1608. maxMinutesWithData = cluster.DataMinutes
  1609. }
  1610. }
  1611. if len(totals) > 0 && maxMinutesWithData > clusterCostsCacheMinutes {
  1612. a.ClusterCostsCache.Set(key, totals, a.GetCacheExpiration(window.Duration()))
  1613. log.Infof("caching %s cluster costs for %s", fmtDuration, a.GetCacheExpiration(window.Duration()))
  1614. } else {
  1615. log.Warningf("not caching %s cluster costs: no data or less than %f minutes data ", fmtDuration, clusterCostsCacheMinutes)
  1616. }
  1617. return aggErr, err
  1618. }
  1619. // 1 day
  1620. go func(sem *util.Semaphore) {
  1621. defer errors.HandlePanic()
  1622. offset := time.Minute
  1623. duration := 24 * time.Hour
  1624. for {
  1625. sem.Acquire()
  1626. warmFunc(duration, offset, true)
  1627. sem.Return()
  1628. log.Infof("aggregation: warm cache: %s", timeutil.DurationString(duration))
  1629. time.Sleep(a.GetCacheRefresh(duration))
  1630. }
  1631. }(sem)
  1632. if !env.IsETLEnabled() {
  1633. // 2 day
  1634. go func(sem *util.Semaphore) {
  1635. defer errors.HandlePanic()
  1636. offset := time.Minute
  1637. duration := 2 * 24 * time.Hour
  1638. for {
  1639. sem.Acquire()
  1640. warmFunc(duration, offset, false)
  1641. sem.Return()
  1642. log.Infof("aggregation: warm cache: %s", timeutil.DurationString(duration))
  1643. time.Sleep(a.GetCacheRefresh(duration))
  1644. }
  1645. }(sem)
  1646. // 7 day
  1647. go func(sem *util.Semaphore) {
  1648. defer errors.HandlePanic()
  1649. offset := time.Minute
  1650. duration := 7 * 24 * time.Hour
  1651. for {
  1652. sem.Acquire()
  1653. aggErr, err := warmFunc(duration, offset, false)
  1654. sem.Return()
  1655. log.Infof("aggregation: warm cache: %s", timeutil.DurationString(duration))
  1656. if aggErr == nil && err == nil {
  1657. time.Sleep(a.GetCacheRefresh(duration))
  1658. } else {
  1659. time.Sleep(5 * time.Minute)
  1660. }
  1661. }
  1662. }(sem)
  1663. // 30 day
  1664. go func(sem *util.Semaphore) {
  1665. defer errors.HandlePanic()
  1666. for {
  1667. offset := time.Minute
  1668. duration := 30 * 24 * time.Hour
  1669. sem.Acquire()
  1670. aggErr, err := warmFunc(duration, offset, false)
  1671. sem.Return()
  1672. if aggErr == nil && err == nil {
  1673. time.Sleep(a.GetCacheRefresh(duration))
  1674. } else {
  1675. time.Sleep(5 * time.Minute)
  1676. }
  1677. }
  1678. }(sem)
  1679. }
  1680. }
  1681. // AggregateCostModelHandler handles requests to the aggregated cost model API. See
  1682. // ComputeAggregateCostModel for details.
  1683. func (a *Accesses) AggregateCostModelHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
  1684. w.Header().Set("Content-Type", "application/json")
  1685. windowStr := r.URL.Query().Get("window")
  1686. // Convert UTC-RFC3339 pairs to configured UTC offset
  1687. // e.g. with UTC offset of -0600, 2020-07-01T00:00:00Z becomes
  1688. // 2020-07-01T06:00:00Z == 2020-07-01T00:00:00-0600
  1689. // TODO niko/etl fix the frontend because this is confusing if you're
  1690. // actually asking for UTC time (...Z) and we swap that "Z" out for the
  1691. // configured UTC offset without asking
  1692. rfc3339 := `\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ`
  1693. regex := regexp.MustCompile(fmt.Sprintf(`(%s),(%s)`, rfc3339, rfc3339))
  1694. match := regex.FindStringSubmatch(windowStr)
  1695. if match != nil {
  1696. start, _ := time.Parse(time.RFC3339, match[1])
  1697. start = start.Add(-env.GetParsedUTCOffset()).In(time.UTC)
  1698. end, _ := time.Parse(time.RFC3339, match[2])
  1699. end = end.Add(-env.GetParsedUTCOffset()).In(time.UTC)
  1700. windowStr = fmt.Sprintf("%sZ,%sZ", start.Format("2006-01-02T15:04:05"), end.Format("2006-01-02T15:04:05Z"))
  1701. }
  1702. // determine duration and offset from query parameters
  1703. window, err := kubecost.ParseWindowWithOffset(windowStr, env.GetParsedUTCOffset())
  1704. if err != nil || window.Start() == nil {
  1705. WriteError(w, BadRequest(fmt.Sprintf("invalid window: %s", err)))
  1706. return
  1707. }
  1708. durRegex := regexp.MustCompile(`^(\d+)(m|h|d|s)$`)
  1709. isDurationStr := durRegex.MatchString(windowStr)
  1710. // legacy offset option should override window offset
  1711. if r.URL.Query().Get("offset") != "" {
  1712. offset := r.URL.Query().Get("offset")
  1713. // Shift window by offset, but only when manually set with separate
  1714. // parameter and window was provided as a duration string. Otherwise,
  1715. // do not alter the (duration, offset) from ParseWindowWithOffset.
  1716. if offset != "1m" && isDurationStr {
  1717. match := durRegex.FindStringSubmatch(offset)
  1718. if match != nil && len(match) == 3 {
  1719. dur := time.Minute
  1720. if match[2] == "h" {
  1721. dur = time.Hour
  1722. }
  1723. if match[2] == "d" {
  1724. dur = 24 * time.Hour
  1725. }
  1726. if match[2] == "s" {
  1727. dur = time.Second
  1728. }
  1729. num, _ := strconv.ParseInt(match[1], 10, 64)
  1730. window = window.Shift(-time.Duration(num) * dur)
  1731. }
  1732. }
  1733. }
  1734. opts := DefaultAggregateQueryOpts()
  1735. // parse remaining query parameters
  1736. namespace := r.URL.Query().Get("namespace")
  1737. cluster := r.URL.Query().Get("cluster")
  1738. labels := r.URL.Query().Get("labels")
  1739. annotations := r.URL.Query().Get("annotations")
  1740. podprefix := r.URL.Query().Get("podprefix")
  1741. field := r.URL.Query().Get("aggregation")
  1742. sharedNamespaces := r.URL.Query().Get("sharedNamespaces")
  1743. sharedLabelNames := r.URL.Query().Get("sharedLabelNames")
  1744. sharedLabelValues := r.URL.Query().Get("sharedLabelValues")
  1745. remote := r.URL.Query().Get("remote") != "false"
  1746. subfieldStr := r.URL.Query().Get("aggregationSubfield")
  1747. subfields := []string{}
  1748. if len(subfieldStr) > 0 {
  1749. s := strings.Split(r.URL.Query().Get("aggregationSubfield"), ",")
  1750. for _, rawLabel := range s {
  1751. subfields = append(subfields, prom.SanitizeLabelName(rawLabel))
  1752. }
  1753. }
  1754. idleFlag := r.URL.Query().Get("allocateIdle")
  1755. if idleFlag == "default" {
  1756. c, _ := a.CloudProvider.GetConfig()
  1757. opts.AllocateIdle = (c.DefaultIdle == "true")
  1758. } else {
  1759. opts.AllocateIdle = (idleFlag == "true")
  1760. }
  1761. opts.Rate = r.URL.Query().Get("rate")
  1762. opts.ShareSplit = r.URL.Query().Get("sharedSplit")
  1763. // timeSeries == true maintains the time series dimension of the data,
  1764. // which by default gets summed over the entire interval
  1765. opts.IncludeTimeSeries = r.URL.Query().Get("timeSeries") == "true"
  1766. // efficiency has been deprecated in favor of a default to always send efficiency
  1767. opts.IncludeEfficiency = true
  1768. // TODO niko/caching rename "recomputeCache"
  1769. // disableCache, if set to "true", tells this function to recompute and
  1770. // cache the requested data
  1771. opts.DisableCache = r.URL.Query().Get("disableCache") == "true"
  1772. // clearCache, if set to "true", tells this function to flush the cache,
  1773. // then recompute and cache the requested data
  1774. opts.ClearCache = r.URL.Query().Get("clearCache") == "true"
  1775. // noCache avoids the cache altogether, both reading from and writing to
  1776. opts.NoCache = r.URL.Query().Get("noCache") == "true"
  1777. // noExpireCache should only be used by cache warming to set non-expiring caches
  1778. opts.NoExpireCache = false
  1779. // etl triggers ETL adapter
  1780. opts.UseETLAdapter = r.URL.Query().Get("etl") == "true"
  1781. // aggregation field is required
  1782. if field == "" {
  1783. WriteError(w, BadRequest("Missing aggregation field parameter"))
  1784. return
  1785. }
  1786. // aggregation subfield is required when aggregation field is "label"
  1787. if (field == "label" || field == "annotation") && len(subfields) == 0 {
  1788. WriteError(w, BadRequest("Missing aggregation subfield parameter"))
  1789. return
  1790. }
  1791. // enforce one of the available rate options
  1792. if opts.Rate != "" && opts.Rate != "hourly" && opts.Rate != "daily" && opts.Rate != "monthly" {
  1793. WriteError(w, BadRequest("Rate parameter only supports: hourly, daily, monthly or empty"))
  1794. return
  1795. }
  1796. // parse cost data filters
  1797. // namespace and cluster are exact-string-matches
  1798. // labels are expected to be comma-separated and to take the form key=value
  1799. // e.g. app=cost-analyzer,app.kubernetes.io/instance=kubecost
  1800. opts.Filters = map[string]string{
  1801. "namespace": namespace,
  1802. "cluster": cluster,
  1803. "labels": labels,
  1804. "annotations": annotations,
  1805. "podprefix": podprefix,
  1806. }
  1807. // parse shared resources
  1808. sn := []string{}
  1809. sln := []string{}
  1810. slv := []string{}
  1811. if sharedNamespaces != "" {
  1812. sn = strings.Split(sharedNamespaces, ",")
  1813. }
  1814. if sharedLabelNames != "" {
  1815. sln = strings.Split(sharedLabelNames, ",")
  1816. slv = strings.Split(sharedLabelValues, ",")
  1817. if len(sln) != len(slv) || slv[0] == "" {
  1818. WriteError(w, BadRequest("Supply exactly one shared label value per shared label name"))
  1819. return
  1820. }
  1821. }
  1822. if len(sn) > 0 || len(sln) > 0 {
  1823. opts.SharedResources = NewSharedResourceInfo(true, sn, sln, slv)
  1824. }
  1825. // enable remote if it is available and not disabled
  1826. opts.RemoteEnabled = remote && env.IsRemoteEnabled()
  1827. promClient := a.GetPrometheusClient(remote)
  1828. var data map[string]*Aggregation
  1829. var message string
  1830. data, message, err = a.AggAPI.ComputeAggregateCostModel(promClient, window, field, subfields, opts)
  1831. // Find any warnings in http request context
  1832. warning, _ := util.GetWarning(r)
  1833. if err != nil {
  1834. if emptyErr, ok := err.(*EmptyDataError); ok {
  1835. if warning == "" {
  1836. w.Write(WrapData(map[string]interface{}{}, emptyErr))
  1837. } else {
  1838. w.Write(WrapDataWithWarning(map[string]interface{}{}, emptyErr, warning))
  1839. }
  1840. return
  1841. }
  1842. if boundaryErr, ok := err.(*kubecost.BoundaryError); ok {
  1843. if window.Start() != nil && window.Start().After(time.Now().Add(-90*24*time.Hour)) {
  1844. // Asking for data within a 90 day period: it will be available
  1845. // after the pipeline builds
  1846. msg := "Data will be available after ETL is built"
  1847. rex := regexp.MustCompile(`(\d+\.*\d*)%`)
  1848. match := rex.FindStringSubmatch(boundaryErr.Message)
  1849. if len(match) > 1 {
  1850. completionPct, err := strconv.ParseFloat(match[1], 64)
  1851. if err == nil {
  1852. msg = fmt.Sprintf("%s (%.1f%% complete)", msg, completionPct)
  1853. }
  1854. }
  1855. WriteError(w, InternalServerError(msg))
  1856. } else {
  1857. // Boundary error outside of 90 day period; may not be available
  1858. WriteError(w, InternalServerError(boundaryErr.Error()))
  1859. }
  1860. return
  1861. }
  1862. errStr := fmt.Sprintf("error computing aggregate cost model: %s", err)
  1863. WriteError(w, InternalServerError(errStr))
  1864. return
  1865. }
  1866. if warning == "" {
  1867. w.Write(WrapDataWithMessage(data, nil, message))
  1868. } else {
  1869. w.Write(WrapDataWithMessageAndWarning(data, nil, message, warning))
  1870. }
  1871. }
  1872. // ParseAggregationProperties attempts to parse and return aggregation properties
  1873. // encoded under the given key. If none exist, or if parsing fails, an error
  1874. // is returned with empty AllocationProperties.
  1875. func ParseAggregationProperties(qp util.QueryParams, key string) ([]string, error) {
  1876. aggregateBy := []string{}
  1877. for _, agg := range qp.GetList(key, ",") {
  1878. aggregate := strings.TrimSpace(agg)
  1879. if aggregate != "" {
  1880. if prop, err := kubecost.ParseProperty(aggregate); err == nil {
  1881. aggregateBy = append(aggregateBy, string(prop))
  1882. } else if strings.HasPrefix(aggregate, "label:") {
  1883. aggregateBy = append(aggregateBy, aggregate)
  1884. } else if strings.HasPrefix(aggregate, "annotation:") {
  1885. aggregateBy = append(aggregateBy, aggregate)
  1886. }
  1887. }
  1888. }
  1889. return aggregateBy, nil
  1890. }
  1891. // ComputeAllocationHandler computes an AllocationSetRange from the CostModel.
  1892. func (a *Accesses) ComputeAllocationHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
  1893. w.Header().Set("Content-Type", "application/json")
  1894. qp := util.NewQueryParams(r.URL.Query())
  1895. // Window is a required field describing the window of time over which to
  1896. // compute allocation data.
  1897. window, err := kubecost.ParseWindowWithOffset(qp.Get("window", ""), env.GetParsedUTCOffset())
  1898. if err != nil {
  1899. http.Error(w, fmt.Sprintf("Invalid 'window' parameter: %s", err), http.StatusBadRequest)
  1900. }
  1901. // Step is an optional parameter that defines the duration per-set, i.e.
  1902. // the window for an AllocationSet, of the AllocationSetRange to be
  1903. // computed. Defaults to the window size, making one set.
  1904. step := qp.GetDuration("step", window.Duration())
  1905. // Resolution is an optional parameter, defaulting to the configured ETL
  1906. // resolution.
  1907. resolution := qp.GetDuration("resolution", env.GetETLResolution())
  1908. // Aggregation is a required comma-separated list of fields by which to
  1909. // aggregate results. Some fields allow a sub-field, which is distinguished
  1910. // with a colon; e.g. "label:app".
  1911. // Examples: "namespace", "namespace,label:app"
  1912. aggregateBy, err := ParseAggregationProperties(qp, "aggregate")
  1913. if err != nil {
  1914. http.Error(w, fmt.Sprintf("Invalid 'aggregate' parameter: %s", err), http.StatusBadRequest)
  1915. }
  1916. // Accumulate is an optional parameter, defaulting to false, which if true
  1917. // sums each Set in the Range, producing one Set.
  1918. accumulate := qp.GetBool("accumulate", false)
  1919. // Query for AllocationSets in increments of the given step duration,
  1920. // appending each to the AllocationSetRange.
  1921. asr := kubecost.NewAllocationSetRange()
  1922. stepStart := *window.Start()
  1923. for window.End().After(stepStart) {
  1924. stepEnd := stepStart.Add(step)
  1925. stepWindow := kubecost.NewWindow(&stepStart, &stepEnd)
  1926. as, err := a.Model.ComputeAllocation(*stepWindow.Start(), *stepWindow.End(), resolution)
  1927. if err != nil {
  1928. WriteError(w, InternalServerError(err.Error()))
  1929. return
  1930. }
  1931. asr.Append(as)
  1932. stepStart = stepEnd
  1933. }
  1934. // Aggregate, if requested
  1935. if len(aggregateBy) > 0 {
  1936. err = asr.AggregateBy(aggregateBy, nil)
  1937. if err != nil {
  1938. WriteError(w, InternalServerError(err.Error()))
  1939. return
  1940. }
  1941. }
  1942. // Accumulate, if requested
  1943. if accumulate {
  1944. as, err := asr.Accumulate()
  1945. if err != nil {
  1946. WriteError(w, InternalServerError(err.Error()))
  1947. return
  1948. }
  1949. asr = kubecost.NewAllocationSetRange(as)
  1950. }
  1951. w.Write(WrapData(asr, nil))
  1952. }
  1953. // The below was transferred from a different package in order to maintain
  1954. // previous behavior. Ultimately, we should clean this up at some point.
  1955. // TODO move to util and/or standardize everything
  1956. type Error struct {
  1957. StatusCode int
  1958. Body string
  1959. }
  1960. func WriteError(w http.ResponseWriter, err Error) {
  1961. status := err.StatusCode
  1962. if status == 0 {
  1963. status = http.StatusInternalServerError
  1964. }
  1965. w.WriteHeader(status)
  1966. resp, _ := json.Marshal(&Response{
  1967. Code: status,
  1968. Message: fmt.Sprintf("Error: %s", err.Body),
  1969. })
  1970. w.Write(resp)
  1971. }
  1972. func BadRequest(message string) Error {
  1973. return Error{
  1974. StatusCode: http.StatusBadRequest,
  1975. Body: message,
  1976. }
  1977. }
  1978. func InternalServerError(message string) Error {
  1979. if message == "" {
  1980. message = "Internal Server Error"
  1981. }
  1982. return Error{
  1983. StatusCode: http.StatusInternalServerError,
  1984. Body: message,
  1985. }
  1986. }
  1987. func NotFound() Error {
  1988. return Error{
  1989. StatusCode: http.StatusNotFound,
  1990. Body: "Not Found",
  1991. }
  1992. }