aggregation.go 78 KB

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