| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556 |
- package kubecost
- import (
- "encoding"
- "fmt"
- "math"
- "strings"
- "time"
- "github.com/opencost/opencost/pkg/log"
- "github.com/opencost/opencost/pkg/util/json"
- )
- // UndefinedKey is used in composing Asset group keys if the group does not have that property defined.
- // E.g. if aggregating on Cluster, Assets in the AssetSet where Asset has no cluster will be grouped under key "__undefined__"
- const UndefinedKey = "__undefined__"
- // LocalStorageClass is used to assign storage class of local disks.
- const LocalStorageClass = "__local__"
- // UnknownStorageClass is used to assign storage class of persistent volume whose information is unable to be traced.
- const UnknownStorageClass = "__unknown__"
- // Asset defines an entity within a cluster that has a defined cost over a
- // given period of time.
- type Asset interface {
- // Type identifies the kind of Asset, which must always exist and should
- // be defined by the underlying type implementing the interface.
- Type() AssetType
- // GetProperties are a map of predefined traits, which may or may not exist,
- // but must conform to the AssetProperty schema
- GetProperties() *AssetProperties
- SetProperties(*AssetProperties)
- // GetLabels are a map of undefined string-to-string values
- GetLabels() AssetLabels
- SetLabels(AssetLabels)
- // Monetary values
- GetAdjustment() float64
- SetAdjustment(float64)
- TotalCost() float64
- // Temporal values
- GetStart() time.Time
- GetEnd() time.Time
- SetStartEnd(time.Time, time.Time)
- GetWindow() Window
- SetWindow(Window)
- ExpandWindow(Window)
- Minutes() float64
- // Operations and comparisons
- Add(Asset) Asset
- Clone() Asset
- Equal(Asset) bool
- // Representations
- encoding.BinaryMarshaler
- encoding.BinaryUnmarshaler
- json.Marshaler
- fmt.Stringer
- }
- // AssetToExternalAllocation converts the given asset to an Allocation, given
- // the Properties to use to aggregate, and the mapping from Allocation property
- // to Asset label. For example, consider this asset:
- //
- // CURRENT: Asset ETL stores its data ALREADY MAPPED from label to k8s concept. This isn't ideal-- see the TOOD.
- //
- // Cloud {
- // TotalCost: 10.00,
- // Labels{
- // "kubernetes_namespace":"monitoring",
- // "env":"prod"
- // }
- // }
- //
- // Given the following parameters, we expect to return:
- //
- // 1. single-prop full match
- // aggregateBy = ["namespace"]
- // => Allocation{Name: "monitoring", ExternalCost: 10.00, TotalCost: 10.00}, nil
- //
- // 2. multi-prop full match
- // aggregateBy = ["namespace", "label:env"]
- // allocationPropertyLabels = {"namespace":"kubernetes_namespace"}
- // => Allocation{Name: "monitoring/env=prod", ExternalCost: 10.00, TotalCost: 10.00}, nil
- //
- // 3. multi-prop partial match
- // aggregateBy = ["namespace", "label:foo"]
- // => Allocation{Name: "monitoring/__unallocated__", ExternalCost: 10.00, TotalCost: 10.00}, nil
- //
- // 4. no match
- // aggregateBy = ["cluster"]
- // => nil, err
- //
- // TODO:
- //
- // Cloud {
- // TotalCost: 10.00,
- // Labels{
- // "kubernetes_namespace":"monitoring",
- // "env":"prod"
- // }
- // }
- //
- // Given the following parameters, we expect to return:
- //
- // 1. single-prop full match
- // aggregateBy = ["namespace"]
- // allocationPropertyLabels = {"namespace":"kubernetes_namespace"}
- // => Allocation{Name: "monitoring", ExternalCost: 10.00, TotalCost: 10.00}, nil
- //
- // 2. multi-prop full match
- // aggregateBy = ["namespace", "label:env"]
- // allocationPropertyLabels = {"namespace":"kubernetes_namespace"}
- // => Allocation{Name: "monitoring/env=prod", ExternalCost: 10.00, TotalCost: 10.00}, nil
- //
- // 3. multi-prop partial match
- // aggregateBy = ["namespace", "label:foo"]
- // allocationPropertyLabels = {"namespace":"kubernetes_namespace"}
- // => Allocation{Name: "monitoring/__unallocated__", ExternalCost: 10.00, TotalCost: 10.00}, nil
- //
- // 4. no match
- // aggregateBy = ["cluster"]
- // allocationPropertyLabels = {"namespace":"kubernetes_namespace"}
- // => nil, err
- //
- // (See asset_test.go for assertions of these examples and more.)
- func AssetToExternalAllocation(asset Asset, aggregateBy []string, labelConfig *LabelConfig) (*Allocation, error) {
- if asset == nil {
- return nil, fmt.Errorf("asset is nil")
- }
- // Use default label config if one is not provided.
- if labelConfig == nil {
- labelConfig = NewLabelConfig()
- }
- // names will collect the slash-separated names accrued by iterating over
- // aggregateBy and checking the relevant labels.
- names := []string{}
- // match records whether or not a match was found in the Asset labels,
- // such that is can genuinely be turned into an external Allocation.
- match := false
- // props records the relevant Properties to set on the resultant Allocation
- props := AllocationProperties{}
- // For each aggregation parameter, try to find a match in the asset's
- // labels, using the labelConfig to translate. For an aggregation parameter
- // defined by a label (e.g. "label:app") this is simple: look for the label
- // and use it (e.g. if "app" is a defined label on the asset, then use its
- // value). For an aggregation parameter defined by a non-label property
- // (e.g. "namespace") this requires using the labelConfig to look up the
- // label name associated with that property and to use the value under that
- // label, if set (e.g. if the aggregation property is "namespace" and the
- // labelConfig is configured with "namespace_external_label" => "kubens"
- // and the asset has label "kubens":"kubecost", then file the asset as an
- // external cost under "kubecost").
- for _, aggBy := range aggregateBy {
- name := labelConfig.GetExternalAllocationName(asset.GetLabels(), aggBy)
- if name == "" {
- // No matching label has been defined in the cost-analyzer label config
- // relating to the given aggregateBy property.
- names = append(names, UnallocatedSuffix)
- continue
- } else {
- names = append(names, name)
- match = true
- // Default labels to an empty map, if necessary
- if props.Labels == nil {
- props.Labels = map[string]string{}
- }
- // Set the corresponding property on props
- switch aggBy {
- case AllocationClusterProp:
- props.Cluster = name
- case AllocationNodeProp:
- props.Node = name
- case AllocationNamespaceProp:
- props.Namespace = name
- case AllocationControllerKindProp:
- props.ControllerKind = name
- case AllocationControllerProp:
- props.Controller = name
- case AllocationPodProp:
- props.Pod = name
- case AllocationContainerProp:
- props.Container = name
- case AllocationServiceProp:
- props.Services = []string{name}
- case AllocationDeploymentProp:
- props.Controller = name
- props.ControllerKind = "deployment"
- case AllocationStatefulSetProp:
- props.Controller = name
- props.ControllerKind = "statefulset"
- case AllocationDaemonSetProp:
- props.Controller = name
- props.ControllerKind = "daemonset"
- case AllocationDepartmentProp:
- props.Labels[labelConfig.DepartmentLabel] = name
- case AllocationEnvironmentProp:
- props.Labels[labelConfig.EnvironmentLabel] = name
- case AllocationOwnerProp:
- props.Labels[labelConfig.OwnerLabel] = name
- case AllocationProductProp:
- props.Labels[labelConfig.ProductLabel] = name
- case AllocationTeamProp:
- props.Labels[labelConfig.TeamLabel] = name
- default:
- if strings.HasPrefix(aggBy, "label:") {
- // Set the corresponding label in props
- labelName := strings.TrimPrefix(aggBy, "label:")
- labelValue := strings.TrimPrefix(name, labelName+"=")
- props.Labels[labelName] = labelValue
- }
- }
- }
- }
- // If not a signle aggregation property generated a matching label property,
- // then consider the asset ineligible to be treated as an external allocation.
- if !match {
- return nil, fmt.Errorf("asset does not qualify as an external allocation")
- }
- // Use naming to label as an external allocation. See IsExternal() for more.
- names = append(names, ExternalSuffix)
- // TODO: external allocation: efficiency?
- // TODO: external allocation: resource totals?
- return &Allocation{
- Name: strings.Join(names, "/"),
- Properties: &props,
- Window: asset.GetWindow().Clone(),
- Start: asset.GetStart(),
- End: asset.GetEnd(),
- ExternalCost: asset.TotalCost(),
- }, nil
- }
- // key is used to determine uniqueness of an Asset, for instance during Insert
- // to determine if two Assets should be combined. Passing `nil` `aggregateBy` indicates
- // that all available `AssetProperty` keys should be used. Passing empty `aggregateBy` indicates that
- // no key should be used (e.g. to aggregate all assets). Passing one or more `aggregateBy`
- // values will key by only those values.
- // Valid values of `aggregateBy` elements are strings which are an `AssetProperty`, and strings prefixed
- // with `"label:"`.
- func key(a Asset, aggregateBy []string) (string, error) {
- var buffer strings.Builder
- if aggregateBy == nil {
- aggregateBy = []string{
- string(AssetProviderProp),
- string(AssetAccountProp),
- string(AssetProjectProp),
- string(AssetCategoryProp),
- string(AssetClusterProp),
- string(AssetTypeProp),
- string(AssetServiceProp),
- string(AssetProviderIDProp),
- string(AssetNameProp),
- }
- }
- for i, s := range aggregateBy {
- key := ""
- switch true {
- case s == string(AssetProviderProp):
- key = a.GetProperties().Provider
- case s == string(AssetAccountProp):
- key = a.GetProperties().Account
- case s == string(AssetProjectProp):
- key = a.GetProperties().Project
- case s == string(AssetClusterProp):
- key = a.GetProperties().Cluster
- case s == string(AssetCategoryProp):
- key = a.GetProperties().Category
- case s == string(AssetTypeProp):
- key = a.Type().String()
- case s == string(AssetServiceProp):
- key = a.GetProperties().Service
- case s == string(AssetProviderIDProp):
- key = a.GetProperties().ProviderID
- case s == string(AssetNameProp):
- key = a.GetProperties().Name
- case strings.HasPrefix(s, "label:"):
- if labelKey := strings.TrimPrefix(s, "label:"); labelKey != "" {
- labelVal := a.GetLabels()[labelKey]
- if labelVal == "" {
- key = "__undefined__"
- } else {
- key = fmt.Sprintf("%s=%s", labelKey, labelVal)
- }
- } else {
- // Don't allow aggregating on label ""
- return "", fmt.Errorf("attempted to aggregate on invalid key: %s", s)
- }
- default:
- return "", fmt.Errorf("attempted to aggregate on invalid key: %s", s)
- }
- if key != "" {
- buffer.WriteString(key)
- } else {
- buffer.WriteString(UndefinedKey)
- }
- if i != (len(aggregateBy) - 1) {
- buffer.WriteString("/")
- }
- }
- return buffer.String(), nil
- }
- func GetAssetKey(a Asset, aggregateBy []string) (string, error) {
- return key(a, aggregateBy)
- }
- func toString(a Asset) string {
- return fmt.Sprintf("%s{%s}%s=%.2f", a.Type().String(), a.GetProperties(), a.GetWindow(), a.TotalCost())
- }
- // AssetLabels is a schema-free mapping of key/value pairs that can be
- // attributed to an Asset as a flexible a
- type AssetLabels map[string]string
- // Clone returns a cloned map of labels
- func (al AssetLabels) Clone() AssetLabels {
- clone := make(AssetLabels, len(al))
- for label, value := range al {
- clone[label] = value
- }
- return clone
- }
- // Equal returns true only if the two set of labels are exact matches
- func (al AssetLabels) Equal(that AssetLabels) bool {
- if len(al) != len(that) {
- return false
- }
- for label, value := range al {
- if thatValue, ok := that[label]; !ok || thatValue != value {
- return false
- }
- }
- return true
- }
- // Merge retains only the labels shared with the given AssetLabels
- func (al AssetLabels) Merge(that AssetLabels) AssetLabels {
- result := AssetLabels{}
- for label, value := range al {
- if thatValue, ok := that[label]; ok && thatValue == value {
- result[label] = value
- }
- }
- return result
- }
- // Append joins AssetLabels with a given map of labels
- func (al AssetLabels) Append(newLabels map[string]string, overwrite bool) {
- if len(newLabels) == 0 {
- return
- }
- for label, value := range newLabels {
- if _, ok := al[label]; ok {
- if overwrite {
- al[label] = value
- }
- } else {
- al[label] = value
- }
- }
- }
- // AssetMatchFunc is a function that can be used to match Assets by
- // returning true for any given Asset if a condition is met.
- type AssetMatchFunc func(Asset) bool
- // AssetType identifies a type of Asset
- type AssetType int
- const (
- // AnyAssetType describes the Any AssetType
- AnyAssetType AssetType = iota
- // CloudAssetType describes the Cloud AssetType
- CloudAssetType
- // ClusterManagementAssetType describes the ClusterManagement AssetType
- ClusterManagementAssetType
- // DiskAssetType describes the Disk AssetType
- DiskAssetType
- // LoadBalancerAssetType describes the LoadBalancer AssetType
- LoadBalancerAssetType
- // NetworkAssetType describes the Network AssetType
- NetworkAssetType
- // NodeAssetType describes the Node AssetType
- NodeAssetType
- // SharedAssetType describes the Shared AssetType
- SharedAssetType
- )
- // ParseAssetType attempts to parse the given string into an AssetType
- func ParseAssetType(text string) (AssetType, error) {
- switch strings.TrimSpace(strings.ToLower(text)) {
- case "cloud":
- return CloudAssetType, nil
- case "clustermanagement":
- return ClusterManagementAssetType, nil
- case "disk":
- return DiskAssetType, nil
- case "loadbalancer":
- return LoadBalancerAssetType, nil
- case "network":
- return NetworkAssetType, nil
- case "node":
- return NodeAssetType, nil
- case "shared":
- return SharedAssetType, nil
- }
- return AnyAssetType, fmt.Errorf("invalid asset type: %s", text)
- }
- // String converts the given AssetType to a string
- func (at AssetType) String() string {
- return [...]string{
- "Asset",
- "Cloud",
- "ClusterManagement",
- "Disk",
- "LoadBalancer",
- "Network",
- "Node",
- "Shared",
- }[at]
- }
- // Any is the most general Asset, which is usually created as a result of
- // adding two Assets of different types.
- type Any struct {
- Labels AssetLabels
- Properties *AssetProperties
- Start time.Time
- End time.Time
- Window Window
- Adjustment float64
- Cost float64
- }
- // NewAsset creates a new Any-type Asset for the given period of time
- func NewAsset(start, end time.Time, window Window) *Any {
- return &Any{
- Labels: AssetLabels{},
- Properties: &AssetProperties{},
- Start: start,
- End: end,
- Window: window.Clone(),
- }
- }
- // Type returns the Asset's type
- func (a *Any) Type() AssetType {
- return AnyAssetType
- }
- // Properties returns the Asset's Properties
- func (a *Any) GetProperties() *AssetProperties {
- return a.Properties
- }
- // SetProperties sets the Asset's Properties
- func (a *Any) SetProperties(props *AssetProperties) {
- a.Properties = props
- }
- // Labels returns the Asset's labels
- func (a *Any) GetLabels() AssetLabels {
- return a.Labels
- }
- // SetLabels sets the Asset's labels
- func (a *Any) SetLabels(labels AssetLabels) {
- a.Labels = labels
- }
- // Adjustment returns the Asset's cost adjustment
- func (a *Any) GetAdjustment() float64 {
- return a.Adjustment
- }
- // SetAdjustment sets the Asset's cost adjustment
- func (a *Any) SetAdjustment(adj float64) {
- a.Adjustment = adj
- }
- // TotalCost returns the Asset's TotalCost
- func (a *Any) TotalCost() float64 {
- return a.Cost + a.Adjustment
- }
- // Start returns the Asset's start time within the window
- func (a *Any) GetStart() time.Time {
- return a.Start
- }
- // End returns the Asset's end time within the window
- func (a *Any) GetEnd() time.Time {
- return a.End
- }
- // Minutes returns the number of minutes the Asset was active within the window
- func (a *Any) Minutes() float64 {
- return a.End.Sub(a.Start).Minutes()
- }
- // Window returns the Asset's window
- func (a *Any) GetWindow() Window {
- return a.Window
- }
- func (a *Any) SetWindow(window Window) {
- a.Window = window
- }
- // ExpandWindow expands the Asset's window by the given window
- func (a *Any) ExpandWindow(window Window) {
- a.Window = a.Window.Expand(window)
- }
- // SetStartEnd sets the Asset's Start and End fields
- func (a *Any) SetStartEnd(start, end time.Time) {
- if a.Window.Contains(start) {
- a.Start = start
- } else {
- log.Warnf("Any.SetStartEnd: start %s not in %s", start, a.Window)
- }
- if a.Window.Contains(end) {
- a.End = end
- } else {
- log.Warnf("Any.SetStartEnd: end %s not in %s", end, a.Window)
- }
- }
- // Add sums the Asset with the given Asset to produce a new Asset, maintaining
- // as much relevant information as possible (i.e. type, Properties, labels).
- func (a *Any) Add(that Asset) Asset {
- this := a.Clone().(*Any)
- props := a.Properties.Merge(that.GetProperties())
- labels := a.Labels.Merge(that.GetLabels())
- start := a.Start
- if that.GetStart().Before(start) {
- start = that.GetStart()
- }
- end := a.End
- if that.GetEnd().After(end) {
- end = that.GetEnd()
- }
- window := a.Window.Expand(that.GetWindow())
- this.Start = start
- this.End = end
- this.Window = window
- this.SetProperties(props)
- this.SetLabels(labels)
- this.Adjustment += that.GetAdjustment()
- this.Cost += (that.TotalCost() - that.GetAdjustment())
- return this
- }
- // Clone returns a cloned instance of the Asset
- func (a *Any) Clone() Asset {
- return &Any{
- Labels: a.Labels.Clone(),
- Properties: a.Properties.Clone(),
- Start: a.Start,
- End: a.End,
- Window: a.Window.Clone(),
- Adjustment: a.Adjustment,
- Cost: a.Cost,
- }
- }
- // Equal returns true if the given Asset is an exact match of the receiver
- func (a *Any) Equal(that Asset) bool {
- t, ok := that.(*Any)
- if !ok {
- return false
- }
- if !a.Labels.Equal(t.Labels) {
- return false
- }
- if !a.Properties.Equal(t.Properties) {
- return false
- }
- if !a.Start.Equal(t.Start) {
- return false
- }
- if !a.End.Equal(t.End) {
- return false
- }
- if !a.Window.Equal(t.Window) {
- return false
- }
- if a.Cost != t.Cost {
- return false
- }
- return true
- }
- // String implements fmt.Stringer
- func (a *Any) String() string {
- return toString(a)
- }
- // Cloud describes a cloud asset
- type Cloud struct {
- Labels AssetLabels
- Properties *AssetProperties
- Start time.Time
- End time.Time
- Window Window
- Adjustment float64
- Cost float64
- Credit float64 // Credit is a negative value representing dollars credited back to a given line-item
- }
- // NewCloud returns a new Cloud Asset
- func NewCloud(category, providerID string, start, end time.Time, window Window) *Cloud {
- properties := &AssetProperties{
- Category: category,
- ProviderID: providerID,
- }
- return &Cloud{
- Labels: AssetLabels{},
- Properties: properties,
- Start: start,
- End: end,
- Window: window.Clone(),
- }
- }
- // Type returns the AssetType
- func (ca *Cloud) Type() AssetType {
- return CloudAssetType
- }
- // Properties returns the AssetProperties
- func (ca *Cloud) GetProperties() *AssetProperties {
- return ca.Properties
- }
- // SetProperties sets the Asset's Properties
- func (ca *Cloud) SetProperties(props *AssetProperties) {
- ca.Properties = props
- }
- // Labels returns the AssetLabels
- func (ca *Cloud) GetLabels() AssetLabels {
- return ca.Labels
- }
- // SetLabels sets the Asset's labels
- func (ca *Cloud) SetLabels(labels AssetLabels) {
- ca.Labels = labels
- }
- // Adjustment returns the Asset's adjustment value
- func (ca *Cloud) GetAdjustment() float64 {
- return ca.Adjustment
- }
- // SetAdjustment sets the Asset's adjustment value
- func (ca *Cloud) SetAdjustment(adj float64) {
- ca.Adjustment = adj
- }
- // TotalCost returns the Asset's total cost
- func (ca *Cloud) TotalCost() float64 {
- return ca.Cost + ca.Adjustment + ca.Credit
- }
- // Start returns the Asset's precise start time within the window
- func (ca *Cloud) GetStart() time.Time {
- return ca.Start
- }
- // End returns the Asset's precise end time within the window
- func (ca *Cloud) GetEnd() time.Time {
- return ca.End
- }
- // Minutes returns the number of Minutes the Asset ran
- func (ca *Cloud) Minutes() float64 {
- return ca.End.Sub(ca.Start).Minutes()
- }
- // Window returns the window within which the Asset ran
- func (ca *Cloud) GetWindow() Window {
- return ca.Window
- }
- func (ca *Cloud) SetWindow(window Window) {
- ca.Window = window
- }
- // ExpandWindow expands the Asset's window by the given window
- func (ca *Cloud) ExpandWindow(window Window) {
- ca.Window = ca.Window.Expand(window)
- }
- // SetStartEnd sets the Asset's Start and End fields
- func (ca *Cloud) SetStartEnd(start, end time.Time) {
- if ca.Window.Contains(start) {
- ca.Start = start
- } else {
- log.Warnf("Cloud.SetStartEnd: start %s not in %s", start, ca.Window)
- }
- if ca.Window.Contains(end) {
- ca.End = end
- } else {
- log.Warnf("Cloud.SetStartEnd: end %s not in %s", end, ca.Window)
- }
- }
- // Add sums the Asset with the given Asset to produce a new Asset, maintaining
- // as much relevant information as possible (i.e. type, Properties, labels).
- func (ca *Cloud) Add(a Asset) Asset {
- // Cloud + Cloud = Cloud
- if that, ok := a.(*Cloud); ok {
- this := ca.Clone().(*Cloud)
- this.add(that)
- return this
- }
- props := ca.Properties.Merge(a.GetProperties())
- labels := ca.Labels.Merge(a.GetLabels())
- start := ca.Start
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- end := ca.End
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- window := ca.Window.Expand(a.GetWindow())
- // Cloud + !Cloud = Any
- any := NewAsset(start, end, window)
- any.SetProperties(props)
- any.SetLabels(labels)
- any.Adjustment = ca.Adjustment + a.GetAdjustment()
- any.Cost = (ca.TotalCost() - ca.Adjustment) + (a.TotalCost() - a.GetAdjustment())
- return any
- }
- func (ca *Cloud) add(that *Cloud) {
- if ca == nil {
- ca = that
- return
- }
- props := ca.Properties.Merge(that.Properties)
- labels := ca.Labels.Merge(that.Labels)
- start := ca.Start
- if that.Start.Before(start) {
- start = that.Start
- }
- end := ca.End
- if that.End.After(end) {
- end = that.End
- }
- window := ca.Window.Expand(that.Window)
- ca.Start = start
- ca.End = end
- ca.Window = window
- ca.SetProperties(props)
- ca.SetLabels(labels)
- ca.Adjustment += that.Adjustment
- ca.Cost += that.Cost
- ca.Credit += that.Credit
- }
- // Clone returns a cloned instance of the Asset
- func (ca *Cloud) Clone() Asset {
- return &Cloud{
- Labels: ca.Labels.Clone(),
- Properties: ca.Properties.Clone(),
- Start: ca.Start,
- End: ca.End,
- Window: ca.Window.Clone(),
- Adjustment: ca.Adjustment,
- Cost: ca.Cost,
- Credit: ca.Credit,
- }
- }
- // Equal returns true if the given Asset precisely equals the Asset
- func (ca *Cloud) Equal(a Asset) bool {
- that, ok := a.(*Cloud)
- if !ok {
- return false
- }
- if !ca.Labels.Equal(that.Labels) {
- return false
- }
- if !ca.Properties.Equal(that.Properties) {
- return false
- }
- if !ca.Start.Equal(that.Start) {
- return false
- }
- if !ca.End.Equal(that.End) {
- return false
- }
- if !ca.Window.Equal(that.Window) {
- return false
- }
- if ca.Adjustment != that.Adjustment {
- return false
- }
- if ca.Cost != that.Cost {
- return false
- }
- if ca.Credit != that.Credit {
- return false
- }
- return true
- }
- // String implements fmt.Stringer
- func (ca *Cloud) String() string {
- return toString(ca)
- }
- // ClusterManagement describes a provider's cluster management fee
- type ClusterManagement struct {
- Labels AssetLabels
- Properties *AssetProperties
- Window Window
- Cost float64
- Adjustment float64 // @bingen:field[version=16]
- }
- // NewClusterManagement creates and returns a new ClusterManagement instance
- func NewClusterManagement(provider, cluster string, window Window) *ClusterManagement {
- properties := &AssetProperties{
- Category: ManagementCategory,
- Provider: ParseProvider(provider),
- Cluster: cluster,
- Service: KubernetesService,
- }
- return &ClusterManagement{
- Labels: AssetLabels{},
- Properties: properties,
- Window: window.Clone(),
- }
- }
- // Type returns the Asset's type
- func (cm *ClusterManagement) Type() AssetType {
- return ClusterManagementAssetType
- }
- // Properties returns the Asset's Properties
- func (cm *ClusterManagement) GetProperties() *AssetProperties {
- return cm.Properties
- }
- // SetProperties sets the Asset's Properties
- func (cm *ClusterManagement) SetProperties(props *AssetProperties) {
- cm.Properties = props
- }
- // Labels returns the Asset's labels
- func (cm *ClusterManagement) GetLabels() AssetLabels {
- return cm.Labels
- }
- // SetLabels sets the Asset's Properties
- func (cm *ClusterManagement) SetLabels(props AssetLabels) {
- cm.Labels = props
- }
- // Adjustment does not apply to ClusterManagement
- func (cm *ClusterManagement) GetAdjustment() float64 {
- return cm.Adjustment
- }
- // SetAdjustment does not apply to ClusterManagement
- func (cm *ClusterManagement) SetAdjustment(adj float64) {
- cm.Adjustment = adj
- }
- // TotalCost returns the Asset's total cost
- func (cm *ClusterManagement) TotalCost() float64 {
- return cm.Cost + cm.Adjustment
- }
- // Start returns the Asset's precise start time within the window
- func (cm *ClusterManagement) GetStart() time.Time {
- return *cm.Window.Start()
- }
- // End returns the Asset's precise end time within the window
- func (cm *ClusterManagement) GetEnd() time.Time {
- return *cm.Window.End()
- }
- // Minutes returns the number of minutes the Asset ran
- func (cm *ClusterManagement) Minutes() float64 {
- return cm.Window.Minutes()
- }
- // Window return the Asset's window
- func (cm *ClusterManagement) GetWindow() Window {
- return cm.Window
- }
- func (cm *ClusterManagement) SetWindow(window Window) {
- cm.Window = window
- }
- // ExpandWindow expands the Asset's window by the given window
- func (cm *ClusterManagement) ExpandWindow(window Window) {
- cm.Window = cm.Window.Expand(window)
- }
- // SetStartEnd sets the Asset's Start and End fields (not applicable here)
- func (cm *ClusterManagement) SetStartEnd(start, end time.Time) {
- return
- }
- // Add sums the Asset with the given Asset to produce a new Asset, maintaining
- // as much relevant information as possible (i.e. type, Properties, labels).
- func (cm *ClusterManagement) Add(a Asset) Asset {
- // ClusterManagement + ClusterManagement = ClusterManagement
- if that, ok := a.(*ClusterManagement); ok {
- this := cm.Clone().(*ClusterManagement)
- this.add(that)
- return this
- }
- props := cm.Properties.Merge(a.GetProperties())
- labels := cm.Labels.Merge(a.GetLabels())
- start := cm.GetStart()
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- end := cm.GetEnd()
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- window := cm.Window.Expand(a.GetWindow())
- // ClusterManagement + !ClusterManagement = Any
- any := NewAsset(start, end, window)
- any.SetProperties(props)
- any.SetLabels(labels)
- any.Adjustment = cm.Adjustment + a.GetAdjustment()
- any.Cost = (cm.TotalCost() - cm.Adjustment) + (a.TotalCost() - a.GetAdjustment())
- return any
- }
- func (cm *ClusterManagement) add(that *ClusterManagement) {
- if cm == nil {
- cm = that
- return
- }
- props := cm.Properties.Merge(that.Properties)
- labels := cm.Labels.Merge(that.Labels)
- window := cm.Window.Expand(that.Window)
- cm.Window = window
- cm.SetProperties(props)
- cm.SetLabels(labels)
- cm.Adjustment += that.Adjustment
- cm.Cost += that.Cost
- }
- // Clone returns a cloned instance of the Asset
- func (cm *ClusterManagement) Clone() Asset {
- return &ClusterManagement{
- Labels: cm.Labels.Clone(),
- Properties: cm.Properties.Clone(),
- Window: cm.Window.Clone(),
- Adjustment: cm.Adjustment,
- Cost: cm.Cost,
- }
- }
- // Equal returns true if the given Asset exactly matches the Asset
- func (cm *ClusterManagement) Equal(a Asset) bool {
- that, ok := a.(*ClusterManagement)
- if !ok {
- return false
- }
- if !cm.Labels.Equal(that.Labels) {
- return false
- }
- if !cm.Properties.Equal(that.Properties) {
- return false
- }
- if !cm.Window.Equal(that.Window) {
- return false
- }
- if cm.Adjustment != that.Adjustment {
- return false
- }
- if cm.Cost != that.Cost {
- return false
- }
- return true
- }
- // String implements fmt.Stringer
- func (cm *ClusterManagement) String() string {
- return toString(cm)
- }
- // Disk represents an in-cluster disk Asset
- type Disk struct {
- Labels AssetLabels
- Properties *AssetProperties
- Start time.Time
- End time.Time
- Window Window
- Adjustment float64
- Cost float64
- ByteHours float64
- Local float64
- Breakdown *Breakdown
- StorageClass string // @bingen:field[version=17]
- ByteHoursUsed *float64 // @bingen:field[version=18]
- ByteUsageMax *float64 // @bingen:field[version=18]
- VolumeName string // @bingen:field[version=18]
- ClaimName string // @bingen:field[version=18]
- ClaimNamespace string // @bingen:field[version=18]
- }
- // NewDisk creates and returns a new Disk Asset
- func NewDisk(name, cluster, providerID string, start, end time.Time, window Window) *Disk {
- properties := &AssetProperties{
- Category: StorageCategory,
- Name: name,
- Cluster: cluster,
- ProviderID: providerID,
- Service: KubernetesService,
- }
- return &Disk{
- Labels: AssetLabels{},
- Properties: properties,
- Start: start,
- End: end,
- Window: window,
- Breakdown: &Breakdown{},
- }
- }
- // Type returns the AssetType of the Asset
- func (d *Disk) Type() AssetType {
- return DiskAssetType
- }
- // Properties returns the Asset's Properties
- func (d *Disk) GetProperties() *AssetProperties {
- return d.Properties
- }
- // SetProperties sets the Asset's Properties
- func (d *Disk) SetProperties(props *AssetProperties) {
- d.Properties = props
- }
- // Labels returns the Asset's labels
- func (d *Disk) GetLabels() AssetLabels {
- return d.Labels
- }
- // SetLabels sets the Asset's labels
- func (d *Disk) SetLabels(labels AssetLabels) {
- d.Labels = labels
- }
- // Adjustment returns the Asset's cost adjustment
- func (d *Disk) GetAdjustment() float64 {
- return d.Adjustment
- }
- // SetAdjustment sets the Asset's cost adjustment
- func (d *Disk) SetAdjustment(adj float64) {
- d.Adjustment = adj
- }
- // TotalCost returns the Asset's total cost
- func (d *Disk) TotalCost() float64 {
- return d.Cost + d.Adjustment
- }
- // Start returns the precise start time of the Asset within the window
- func (d *Disk) GetStart() time.Time {
- return d.Start
- }
- // End returns the precise start time of the Asset within the window
- func (d *Disk) GetEnd() time.Time {
- return d.End
- }
- // Minutes returns the number of minutes the Asset ran
- func (d *Disk) Minutes() float64 {
- diskMins := d.End.Sub(d.Start).Minutes()
- windowMins := d.Window.Minutes()
- if diskMins > windowMins {
- log.Warnf("Asset ETL: Disk.Minutes exceeds window: %.2f > %.2f", diskMins, windowMins)
- diskMins = windowMins
- }
- if diskMins < 0 {
- diskMins = 0
- }
- return diskMins
- }
- // Window returns the window within which the Asset
- func (d *Disk) GetWindow() Window {
- return d.Window
- }
- func (d *Disk) SetWindow(window Window) {
- d.Window = window
- }
- // ExpandWindow expands the Asset's window by the given window
- func (d *Disk) ExpandWindow(window Window) {
- d.Window = d.Window.Expand(window)
- }
- // SetStartEnd sets the Asset's Start and End fields
- func (d *Disk) SetStartEnd(start, end time.Time) {
- if d.Window.Contains(start) {
- d.Start = start
- } else {
- log.Warnf("Disk.SetStartEnd: start %s not in %s", start, d.Window)
- }
- if d.Window.Contains(end) {
- d.End = end
- } else {
- log.Warnf("Disk.SetStartEnd: end %s not in %s", end, d.Window)
- }
- }
- // Add sums the Asset with the given Asset to produce a new Asset, maintaining
- // as much relevant information as possible (i.e. type, Properties, labels).
- func (d *Disk) Add(a Asset) Asset {
- // Disk + Disk = Disk
- if that, ok := a.(*Disk); ok {
- this := d.Clone().(*Disk)
- this.add(that)
- return this
- }
- props := d.Properties.Merge(a.GetProperties())
- labels := d.Labels.Merge(a.GetLabels())
- start := d.Start
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- end := d.End
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- window := d.Window.Expand(a.GetWindow())
- // Disk + !Disk = Any
- any := NewAsset(start, end, window)
- any.SetProperties(props)
- any.SetLabels(labels)
- any.Adjustment = d.Adjustment + a.GetAdjustment()
- any.Cost = (d.TotalCost() - d.Adjustment) + (a.TotalCost() - a.GetAdjustment())
- return any
- }
- func (d *Disk) add(that *Disk) {
- if d == nil {
- d = that
- return
- }
- props := d.Properties.Merge(that.Properties)
- labels := d.Labels.Merge(that.Labels)
- d.SetProperties(props)
- d.SetLabels(labels)
- start := d.Start
- if that.Start.Before(start) {
- start = that.Start
- }
- end := d.End
- if that.End.After(end) {
- end = that.End
- }
- window := d.Window.Expand(that.Window)
- d.Start = start
- d.End = end
- d.Window = window
- totalCost := d.Cost + that.Cost
- if totalCost > 0.0 {
- d.Breakdown.Idle = (d.Breakdown.Idle*d.Cost + that.Breakdown.Idle*that.Cost) / totalCost
- d.Breakdown.Other = (d.Breakdown.Other*d.Cost + that.Breakdown.Other*that.Cost) / totalCost
- d.Breakdown.System = (d.Breakdown.System*d.Cost + that.Breakdown.System*that.Cost) / totalCost
- d.Breakdown.User = (d.Breakdown.User*d.Cost + that.Breakdown.User*that.Cost) / totalCost
- d.Local = (d.TotalCost()*d.Local + that.TotalCost()*that.Local) / (d.TotalCost() + that.TotalCost())
- } else {
- d.Local = (d.Local + that.Local) / 2.0
- }
- d.Adjustment += that.Adjustment
- d.Cost += that.Cost
- d.ByteHours += that.ByteHours
- if d.ByteHoursUsed == nil && that.ByteHoursUsed != nil {
- copy := *that.ByteHoursUsed
- d.ByteHoursUsed = ©
- } else if d.ByteHoursUsed != nil && that.ByteHoursUsed == nil {
- // do nothing
- } else if d.ByteHoursUsed != nil && that.ByteHoursUsed != nil {
- sum := *d.ByteHoursUsed
- sum += *that.ByteHoursUsed
- d.ByteHoursUsed = &sum
- }
- // We have to nil out the max because we don't know if we're
- // aggregating across time our properties. See RawAllocationOnly on
- // Allocation for further reference.
- d.ByteUsageMax = nil
- // If storage class don't match default it to empty storage class
- if d.StorageClass != that.StorageClass {
- d.StorageClass = ""
- }
- if d.VolumeName != that.VolumeName {
- d.VolumeName = ""
- }
- if d.ClaimName != that.ClaimName {
- d.ClaimName = ""
- }
- if d.ClaimNamespace != that.ClaimNamespace {
- d.ClaimNamespace = ""
- }
- }
- // Clone returns a cloned instance of the Asset
- func (d *Disk) Clone() Asset {
- var max *float64
- if d.ByteUsageMax != nil {
- copied := *d.ByteUsageMax
- max = &copied
- }
- var byteHoursUsed *float64
- if d.ByteHoursUsed != nil {
- copied := *d.ByteHoursUsed
- byteHoursUsed = &copied
- }
- return &Disk{
- Properties: d.Properties.Clone(),
- Labels: d.Labels.Clone(),
- Start: d.Start,
- End: d.End,
- Window: d.Window.Clone(),
- Adjustment: d.Adjustment,
- Cost: d.Cost,
- ByteHours: d.ByteHours,
- ByteHoursUsed: byteHoursUsed,
- ByteUsageMax: max,
- Local: d.Local,
- Breakdown: d.Breakdown.Clone(),
- StorageClass: d.StorageClass,
- VolumeName: d.VolumeName,
- ClaimName: d.ClaimName,
- ClaimNamespace: d.ClaimNamespace,
- }
- }
- // Equal returns true if the two Assets match exactly
- func (d *Disk) Equal(a Asset) bool {
- that, ok := a.(*Disk)
- if !ok {
- return false
- }
- if !d.Labels.Equal(that.Labels) {
- return false
- }
- if !d.Properties.Equal(that.Properties) {
- return false
- }
- if !d.Start.Equal(that.Start) {
- return false
- }
- if !d.End.Equal(that.End) {
- return false
- }
- if !d.Window.Equal(that.Window) {
- return false
- }
- if d.Adjustment != that.Adjustment {
- return false
- }
- if d.Cost != that.Cost {
- return false
- }
- if d.ByteHours != that.ByteHours {
- return false
- }
- if d.ByteHoursUsed != nil && that.ByteHoursUsed == nil {
- return false
- }
- if d.ByteHoursUsed == nil && that.ByteHoursUsed != nil {
- return false
- }
- if (d.ByteHoursUsed != nil && that.ByteHoursUsed != nil) && *d.ByteHoursUsed != *that.ByteHoursUsed {
- return false
- }
- if d.ByteUsageMax != nil && that.ByteUsageMax == nil {
- return false
- }
- if d.ByteUsageMax == nil && that.ByteUsageMax != nil {
- return false
- }
- if (d.ByteUsageMax != nil && that.ByteUsageMax != nil) && *d.ByteUsageMax != *that.ByteUsageMax {
- return false
- }
- if d.Local != that.Local {
- return false
- }
- if !d.Breakdown.Equal(that.Breakdown) {
- return false
- }
- if d.StorageClass != that.StorageClass {
- return false
- }
- if d.VolumeName != that.VolumeName {
- return false
- }
- if d.ClaimName != that.ClaimName {
- return false
- }
- if d.ClaimNamespace != that.ClaimNamespace {
- return false
- }
- return true
- }
- // String implements fmt.Stringer
- func (d *Disk) String() string {
- return toString(d)
- }
- // Bytes returns the number of bytes belonging to the disk. This could be
- // fractional because it's the number of byte*hours divided by the number of
- // hours running; e.g. the sum of a 100GiB disk running for the first 10 hours
- // and a 30GiB disk running for the last 20 hours of the same 24-hour window
- // would produce:
- //
- // (100*10 + 30*20) / 24 = 66.667GiB
- //
- // However, any number of disks running for the full span of a window will
- // report the actual number of bytes of the static disk; e.g. the above
- // scenario for one entire 24-hour window:
- //
- // (100*24 + 30*24) / 24 = (100 + 30) = 130GiB
- func (d *Disk) Bytes() float64 {
- // [b*hr]*([min/hr]*[1/min]) = [b*hr]/[hr] = b
- return d.ByteHours * (60.0 / d.Minutes())
- }
- // Breakdown describes a resource's use as a percentage of various usage types
- type Breakdown struct {
- Idle float64 `json:"idle"`
- Other float64 `json:"other"`
- System float64 `json:"system"`
- User float64 `json:"user"`
- }
- // Clone returns a cloned instance of the Breakdown
- func (b *Breakdown) Clone() *Breakdown {
- if b == nil {
- return nil
- }
- return &Breakdown{
- Idle: b.Idle,
- Other: b.Other,
- System: b.System,
- User: b.User,
- }
- }
- // Equal returns true if the two Breakdowns are exact matches
- func (b *Breakdown) Equal(that *Breakdown) bool {
- if b == nil || that == nil {
- return false
- }
- if b.Idle != that.Idle {
- return false
- }
- if b.Other != that.Other {
- return false
- }
- if b.System != that.System {
- return false
- }
- if b.User != that.User {
- return false
- }
- return true
- }
- // Network is an Asset representing a single node's network costs
- type Network struct {
- Properties *AssetProperties
- Labels AssetLabels
- Start time.Time
- End time.Time
- Window Window
- Adjustment float64
- Cost float64
- }
- // NewNetwork creates and returns a new Network Asset
- func NewNetwork(name, cluster, providerID string, start, end time.Time, window Window) *Network {
- properties := &AssetProperties{
- Category: NetworkCategory,
- Name: name,
- Cluster: cluster,
- ProviderID: providerID,
- Service: KubernetesService,
- }
- return &Network{
- Properties: properties,
- Labels: AssetLabels{},
- Start: start,
- End: end,
- Window: window.Clone(),
- }
- }
- // Type returns the AssetType of the Asset
- func (n *Network) Type() AssetType {
- return NetworkAssetType
- }
- // Properties returns the Asset's Properties
- func (n *Network) GetProperties() *AssetProperties {
- return n.Properties
- }
- // SetProperties sets the Asset's Properties
- func (n *Network) SetProperties(props *AssetProperties) {
- n.Properties = props
- }
- // Labels returns the Asset's labels
- func (n *Network) GetLabels() AssetLabels {
- return n.Labels
- }
- // SetLabels sets the Asset's labels
- func (n *Network) SetLabels(labels AssetLabels) {
- n.Labels = labels
- }
- // Adjustment returns the Asset's cost adjustment
- func (n *Network) GetAdjustment() float64 {
- return n.Adjustment
- }
- // SetAdjustment sets the Asset's cost adjustment
- func (n *Network) SetAdjustment(adj float64) {
- n.Adjustment = adj
- }
- // TotalCost returns the Asset's total cost
- func (n *Network) TotalCost() float64 {
- return n.Cost + n.Adjustment
- }
- // Start returns the precise start time of the Asset within the window
- func (n *Network) GetStart() time.Time {
- return n.Start
- }
- // End returns the precise end time of the Asset within the window
- func (n *Network) GetEnd() time.Time {
- return n.End
- }
- // Minutes returns the number of minutes the Asset ran within the window
- func (n *Network) Minutes() float64 {
- netMins := n.End.Sub(n.Start).Minutes()
- windowMins := n.Window.Minutes()
- if netMins > windowMins {
- log.Warnf("Asset ETL: Network.Minutes exceeds window: %.2f > %.2f", netMins, windowMins)
- netMins = windowMins
- }
- if netMins < 0 {
- netMins = 0
- }
- return netMins
- }
- // Window returns the window within which the Asset ran
- func (n *Network) GetWindow() Window {
- return n.Window
- }
- func (n *Network) SetWindow(window Window) {
- n.Window = window
- }
- // ExpandWindow expands the Asset's window by the given window
- func (n *Network) ExpandWindow(window Window) {
- n.Window = n.Window.Expand(window)
- }
- // SetStartEnd sets the Asset's Start and End fields
- func (n *Network) SetStartEnd(start, end time.Time) {
- if n.Window.Contains(start) {
- n.Start = start
- } else {
- log.Warnf("Disk.SetStartEnd: start %s not in %s", start, n.Window)
- }
- if n.Window.Contains(end) {
- n.End = end
- } else {
- log.Warnf("Disk.SetStartEnd: end %s not in %s", end, n.Window)
- }
- }
- // Add sums the Asset with the given Asset to produce a new Asset, maintaining
- // as much relevant information as possible (i.e. type, Properties, labels).
- func (n *Network) Add(a Asset) Asset {
- // Network + Network = Network
- if that, ok := a.(*Network); ok {
- this := n.Clone().(*Network)
- this.add(that)
- return this
- }
- props := n.Properties.Merge(a.GetProperties())
- labels := n.Labels.Merge(a.GetLabels())
- start := n.Start
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- end := n.End
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- window := n.Window.Expand(a.GetWindow())
- // Network + !Network = Any
- any := NewAsset(start, end, window)
- any.SetProperties(props)
- any.SetLabels(labels)
- any.Adjustment = n.Adjustment + a.GetAdjustment()
- any.Cost = (n.TotalCost() - n.Adjustment) + (a.TotalCost() - a.GetAdjustment())
- return any
- }
- func (n *Network) add(that *Network) {
- if n == nil {
- n = that
- return
- }
- props := n.Properties.Merge(that.Properties)
- labels := n.Labels.Merge(that.Labels)
- n.SetProperties(props)
- n.SetLabels(labels)
- start := n.Start
- if that.Start.Before(start) {
- start = that.Start
- }
- end := n.End
- if that.End.After(end) {
- end = that.End
- }
- window := n.Window.Expand(that.Window)
- n.Start = start
- n.End = end
- n.Window = window
- n.Cost += that.Cost
- n.Adjustment += that.Adjustment
- }
- // Clone returns a deep copy of the given Network
- func (n *Network) Clone() Asset {
- if n == nil {
- return nil
- }
- return &Network{
- Properties: n.Properties.Clone(),
- Labels: n.Labels.Clone(),
- Start: n.Start,
- End: n.End,
- Window: n.Window.Clone(),
- Adjustment: n.Adjustment,
- Cost: n.Cost,
- }
- }
- // Equal returns true if the tow Assets match exactly
- func (n *Network) Equal(a Asset) bool {
- that, ok := a.(*Network)
- if !ok {
- return false
- }
- if !n.Labels.Equal(that.Labels) {
- return false
- }
- if !n.Properties.Equal(that.Properties) {
- return false
- }
- if !n.Start.Equal(that.Start) {
- return false
- }
- if !n.End.Equal(that.End) {
- return false
- }
- if !n.Window.Equal(that.Window) {
- return false
- }
- if n.Adjustment != that.Adjustment {
- return false
- }
- if n.Cost != that.Cost {
- return false
- }
- return true
- }
- // String implements fmt.Stringer
- func (n *Network) String() string {
- return toString(n)
- }
- // Node is an Asset representing a single node in a cluster
- type Node struct {
- Properties *AssetProperties
- Labels AssetLabels
- Start time.Time
- End time.Time
- Window Window
- Adjustment float64
- NodeType string
- CPUCoreHours float64
- RAMByteHours float64
- GPUHours float64
- CPUBreakdown *Breakdown
- RAMBreakdown *Breakdown
- CPUCost float64
- GPUCost float64
- GPUCount float64
- RAMCost float64
- Discount float64
- Preemptible float64
- }
- // NewNode creates and returns a new Node Asset
- func NewNode(name, cluster, providerID string, start, end time.Time, window Window) *Node {
- properties := &AssetProperties{
- Category: ComputeCategory,
- Name: name,
- Cluster: cluster,
- ProviderID: providerID,
- Service: KubernetesService,
- }
- return &Node{
- Properties: properties,
- Labels: AssetLabels{},
- Start: start,
- End: end,
- Window: window.Clone(),
- CPUBreakdown: &Breakdown{},
- RAMBreakdown: &Breakdown{},
- }
- }
- // Type returns the AssetType of the Asset
- func (n *Node) Type() AssetType {
- return NodeAssetType
- }
- // Properties returns the Asset's Properties
- func (n *Node) GetProperties() *AssetProperties {
- return n.Properties
- }
- // SetProperties sets the Asset's Properties
- func (n *Node) SetProperties(props *AssetProperties) {
- n.Properties = props
- }
- // Labels returns the Asset's labels
- func (n *Node) GetLabels() AssetLabels {
- return n.Labels
- }
- // SetLabels sets the Asset's labels
- func (n *Node) SetLabels(labels AssetLabels) {
- n.Labels = labels
- }
- // Adjustment returns the Asset's cost adjustment
- func (n *Node) GetAdjustment() float64 {
- return n.Adjustment
- }
- // SetAdjustment sets the Asset's cost adjustment
- func (n *Node) SetAdjustment(adj float64) {
- n.Adjustment = adj
- }
- // TotalCost returns the Asset's total cost
- func (n *Node) TotalCost() float64 {
- return ((n.CPUCost + n.RAMCost) * (1.0 - n.Discount)) + n.GPUCost + n.Adjustment
- }
- // Start returns the precise start time of the Asset within the window
- func (n *Node) GetStart() time.Time {
- return n.Start
- }
- // End returns the precise end time of the Asset within the window
- func (n *Node) GetEnd() time.Time {
- return n.End
- }
- // Minutes returns the number of minutes the Asset ran within the window
- func (n *Node) Minutes() float64 {
- nodeMins := n.End.Sub(n.Start).Minutes()
- windowMins := n.Window.Minutes()
- if nodeMins > windowMins {
- log.Warnf("Asset ETL: Node.Minutes exceeds window: %.2f > %.2f", nodeMins, windowMins)
- nodeMins = windowMins
- }
- if nodeMins < 0 {
- nodeMins = 0
- }
- return nodeMins
- }
- // Window returns the window within which the Asset ran
- func (n *Node) GetWindow() Window {
- return n.Window
- }
- func (n *Node) SetWindow(window Window) {
- n.Window = window
- }
- // ExpandWindow expands the Asset's window by the given window
- func (n *Node) ExpandWindow(window Window) {
- n.Window = n.Window.Expand(window)
- }
- // SetStartEnd sets the Asset's Start and End fields
- func (n *Node) SetStartEnd(start, end time.Time) {
- if n.Window.Contains(start) {
- n.Start = start
- } else {
- log.Warnf("Disk.SetStartEnd: start %s not in %s", start, n.Window)
- }
- if n.Window.Contains(end) {
- n.End = end
- } else {
- log.Warnf("Disk.SetStartEnd: end %s not in %s", end, n.Window)
- }
- }
- // Add sums the Asset with the given Asset to produce a new Asset, maintaining
- // as much relevant information as possible (i.e. type, Properties, labels).
- func (n *Node) Add(a Asset) Asset {
- // Node + Node = Node
- if that, ok := a.(*Node); ok {
- this := n.Clone().(*Node)
- this.add(that)
- return this
- }
- props := n.Properties.Merge(a.GetProperties())
- labels := n.Labels.Merge(a.GetLabels())
- start := n.Start
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- end := n.End
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- window := n.Window.Expand(a.GetWindow())
- // Node + !Node = Any
- any := NewAsset(start, end, window)
- any.SetProperties(props)
- any.SetLabels(labels)
- any.Adjustment = n.Adjustment + a.GetAdjustment()
- any.Cost = (n.TotalCost() - n.Adjustment) + (a.TotalCost() - a.GetAdjustment())
- return any
- }
- func (n *Node) add(that *Node) {
- if n == nil {
- n = that
- return
- }
- props := n.Properties.Merge(that.Properties)
- labels := n.Labels.Merge(that.Labels)
- n.SetProperties(props)
- n.SetLabels(labels)
- if n.NodeType != that.NodeType {
- n.NodeType = ""
- }
- start := n.Start
- if that.Start.Before(start) {
- start = that.Start
- }
- end := n.End
- if that.End.After(end) {
- end = that.End
- }
- window := n.Window.Expand(that.Window)
- n.Start = start
- n.End = end
- n.Window = window
- // Order of operations for node costs is:
- // Discount(CPU + RAM) + GPU + Adjustment
- // Combining discounts, then involves weighting each discount by each
- // respective (CPU + RAM) cost. Combining preemptible, on the other
- // hand, is done with all three (but not Adjustment, which can change
- // without triggering a re-computation of Preemtible).
- disc := (n.CPUCost+n.RAMCost)*(1.0-n.Discount) + (that.CPUCost+that.RAMCost)*(1.0-that.Discount)
- nonDisc := (n.CPUCost + n.RAMCost) + (that.CPUCost + that.RAMCost)
- if nonDisc > 0 {
- n.Discount = 1.0 - (disc / nonDisc)
- } else {
- n.Discount = (n.Discount + that.Discount) / 2.0
- }
- nNoAdj := n.TotalCost() - n.Adjustment
- thatNoAdj := that.TotalCost() - that.Adjustment
- if (nNoAdj + thatNoAdj) > 0 {
- n.Preemptible = (nNoAdj*n.Preemptible + thatNoAdj*that.Preemptible) / (nNoAdj + thatNoAdj)
- } else {
- n.Preemptible = (n.Preemptible + that.Preemptible) / 2.0
- }
- totalCPUCost := n.CPUCost + that.CPUCost
- if totalCPUCost > 0.0 {
- n.CPUBreakdown.Idle = (n.CPUBreakdown.Idle*n.CPUCost + that.CPUBreakdown.Idle*that.CPUCost) / totalCPUCost
- n.CPUBreakdown.Other = (n.CPUBreakdown.Other*n.CPUCost + that.CPUBreakdown.Other*that.CPUCost) / totalCPUCost
- n.CPUBreakdown.System = (n.CPUBreakdown.System*n.CPUCost + that.CPUBreakdown.System*that.CPUCost) / totalCPUCost
- n.CPUBreakdown.User = (n.CPUBreakdown.User*n.CPUCost + that.CPUBreakdown.User*that.CPUCost) / totalCPUCost
- }
- totalRAMCost := n.RAMCost + that.RAMCost
- if totalRAMCost > 0.0 {
- n.RAMBreakdown.Idle = (n.RAMBreakdown.Idle*n.RAMCost + that.RAMBreakdown.Idle*that.RAMCost) / totalRAMCost
- n.RAMBreakdown.Other = (n.RAMBreakdown.Other*n.RAMCost + that.RAMBreakdown.Other*that.RAMCost) / totalRAMCost
- n.RAMBreakdown.System = (n.RAMBreakdown.System*n.RAMCost + that.RAMBreakdown.System*that.RAMCost) / totalRAMCost
- n.RAMBreakdown.User = (n.RAMBreakdown.User*n.RAMCost + that.RAMBreakdown.User*that.RAMCost) / totalRAMCost
- }
- n.CPUCoreHours += that.CPUCoreHours
- n.RAMByteHours += that.RAMByteHours
- n.GPUHours += that.GPUHours
- n.CPUCost += that.CPUCost
- n.GPUCost += that.GPUCost
- n.RAMCost += that.RAMCost
- n.Adjustment += that.Adjustment
- }
- // Clone returns a deep copy of the given Node
- func (n *Node) Clone() Asset {
- if n == nil {
- return nil
- }
- return &Node{
- Properties: n.Properties.Clone(),
- Labels: n.Labels.Clone(),
- Start: n.Start,
- End: n.End,
- Window: n.Window.Clone(),
- Adjustment: n.Adjustment,
- NodeType: n.NodeType,
- CPUCoreHours: n.CPUCoreHours,
- RAMByteHours: n.RAMByteHours,
- GPUHours: n.GPUHours,
- CPUBreakdown: n.CPUBreakdown.Clone(),
- RAMBreakdown: n.RAMBreakdown.Clone(),
- CPUCost: n.CPUCost,
- GPUCost: n.GPUCost,
- GPUCount: n.GPUCount,
- RAMCost: n.RAMCost,
- Preemptible: n.Preemptible,
- Discount: n.Discount,
- }
- }
- // Equal returns true if the tow Assets match exactly
- func (n *Node) Equal(a Asset) bool {
- that, ok := a.(*Node)
- if !ok {
- return false
- }
- if !n.Labels.Equal(that.Labels) {
- return false
- }
- if !n.Properties.Equal(that.Properties) {
- return false
- }
- if !n.Start.Equal(that.Start) {
- return false
- }
- if !n.End.Equal(that.End) {
- return false
- }
- if !n.Window.Equal(that.Window) {
- return false
- }
- if n.Adjustment != that.Adjustment {
- return false
- }
- if n.NodeType != that.NodeType {
- return false
- }
- if n.CPUCoreHours != that.CPUCoreHours {
- return false
- }
- if n.RAMByteHours != that.RAMByteHours {
- return false
- }
- if n.GPUHours != that.GPUHours {
- return false
- }
- if !n.CPUBreakdown.Equal(that.CPUBreakdown) {
- return false
- }
- if !n.RAMBreakdown.Equal(that.RAMBreakdown) {
- return false
- }
- if n.CPUCost != that.CPUCost {
- return false
- }
- if n.GPUCost != that.GPUCost {
- return false
- }
- if n.RAMCost != that.RAMCost {
- return false
- }
- if n.Discount != that.Discount {
- return false
- }
- if n.Preemptible != that.Preemptible {
- return false
- }
- return true
- }
- // String implements fmt.Stringer
- func (n *Node) String() string {
- return toString(n)
- }
- // IsPreemptible returns true if the node is 100% preemptible. It's possible
- // to be "partially preemptible" by adding a preemptible node with a
- // non-preemptible node.
- func (n *Node) IsPreemptible() bool {
- return n.Preemptible == 1.0
- }
- // CPUCores returns the number of cores belonging to the node. This could be
- // fractional because it's the number of core*hours divided by the number of
- // hours running; e.g. the sum of a 4-core node running for the first 10 hours
- // and a 3-core node running for the last 20 hours of the same 24-hour window
- // would produce:
- //
- // (4*10 + 3*20) / 24 = 4.167 cores
- //
- // However, any number of cores running for the full span of a window will
- // report the actual number of cores of the static node; e.g. the above
- // scenario for one entire 24-hour window:
- //
- // (4*24 + 3*24) / 24 = (4 + 3) = 7 cores
- func (n *Node) CPUCores() float64 {
- // [core*hr]*([min/hr]*[1/min]) = [core*hr]/[hr] = core
- return n.CPUCoreHours * (60.0 / n.Minutes())
- }
- // RAMBytes returns the amount of RAM belonging to the node. This could be
- // fractional because it's the number of byte*hours divided by the number of
- // hours running; e.g. the sum of a 12GiB-RAM node running for the first 10 hours
- // and a 16GiB-RAM node running for the last 20 hours of the same 24-hour window
- // would produce:
- //
- // (12*10 + 16*20) / 24 = 18.333GiB RAM
- //
- // However, any number of bytes running for the full span of a window will
- // report the actual number of bytes of the static node; e.g. the above
- // scenario for one entire 24-hour window:
- //
- // (12*24 + 16*24) / 24 = (12 + 16) = 28GiB RAM
- func (n *Node) RAMBytes() float64 {
- // [b*hr]*([min/hr]*[1/min]) = [b*hr]/[hr] = b
- return n.RAMByteHours * (60.0 / n.Minutes())
- }
- // GPUs returns the amount of GPUs belonging to the node. This could be
- // fractional because it's the number of gpu*hours divided by the number of
- // hours running; e.g. the sum of a 2 gpu node running for the first 10 hours
- // and a 1 gpu node running for the last 20 hours of the same 24-hour window
- // would produce:
- //
- // (2*10 + 1*20) / 24 = 1.667 GPUs
- //
- // However, any number of GPUs running for the full span of a window will
- // report the actual number of GPUs of the static node; e.g. the above
- // scenario for one entire 24-hour window:
- //
- // (2*24 + 1*24) / 24 = (2 + 1) = 3 GPUs
- func (n *Node) GPUs() float64 {
- // [b*hr]*([min/hr]*[1/min]) = [b*hr]/[hr] = b
- return n.GPUHours * (60.0 / n.Minutes())
- }
- // LoadBalancer is an Asset representing a single load balancer in a cluster
- // TODO: add GB of ingress processed, numForwardingRules once we start recording those to prometheus metric
- type LoadBalancer struct {
- Properties *AssetProperties
- Labels AssetLabels
- Start time.Time
- End time.Time
- Window Window
- Adjustment float64
- Cost float64
- }
- // NewLoadBalancer instantiates and returns a new LoadBalancer
- func NewLoadBalancer(name, cluster, providerID string, start, end time.Time, window Window) *LoadBalancer {
- properties := &AssetProperties{
- Category: NetworkCategory,
- Name: name,
- Cluster: cluster,
- ProviderID: providerID,
- Service: KubernetesService,
- }
- return &LoadBalancer{
- Properties: properties,
- Labels: AssetLabels{},
- Start: start,
- End: end,
- Window: window,
- }
- }
- // Type returns the AssetType of the Asset
- func (lb *LoadBalancer) Type() AssetType {
- return LoadBalancerAssetType
- }
- // Properties returns the Asset's Properties
- func (lb *LoadBalancer) GetProperties() *AssetProperties {
- return lb.Properties
- }
- // SetProperties sets the Asset's Properties
- func (lb *LoadBalancer) SetProperties(props *AssetProperties) {
- lb.Properties = props
- }
- // Labels returns the Asset's labels
- func (lb *LoadBalancer) GetLabels() AssetLabels {
- return lb.Labels
- }
- // SetLabels sets the Asset's labels
- func (lb *LoadBalancer) SetLabels(labels AssetLabels) {
- lb.Labels = labels
- }
- // Adjustment returns the Asset's cost adjustment
- func (lb *LoadBalancer) GetAdjustment() float64 {
- return lb.Adjustment
- }
- // SetAdjustment sets the Asset's cost adjustment
- func (lb *LoadBalancer) SetAdjustment(adj float64) {
- lb.Adjustment = adj
- }
- // TotalCost returns the total cost of the Asset
- func (lb *LoadBalancer) TotalCost() float64 {
- return lb.Cost + lb.Adjustment
- }
- // Start returns the preceise start point of the Asset within the window
- func (lb *LoadBalancer) GetStart() time.Time {
- return lb.Start
- }
- // End returns the preceise end point of the Asset within the window
- func (lb *LoadBalancer) GetEnd() time.Time {
- return lb.End
- }
- // Minutes returns the number of minutes the Asset ran within the window
- func (lb *LoadBalancer) Minutes() float64 {
- return lb.End.Sub(lb.Start).Minutes()
- }
- // Window returns the window within which the Asset ran
- func (lb *LoadBalancer) GetWindow() Window {
- return lb.Window
- }
- func (lb *LoadBalancer) SetWindow(window Window) {
- lb.Window = window
- }
- // ExpandWindow expands the Asset's window by the given window
- func (lb *LoadBalancer) ExpandWindow(w Window) {
- lb.Window = lb.Window.Expand(w)
- }
- // SetStartEnd sets the Asset's Start and End fields
- func (lb *LoadBalancer) SetStartEnd(start, end time.Time) {
- if lb.Window.Contains(start) {
- lb.Start = start
- } else {
- log.Warnf("Disk.SetStartEnd: start %s not in %s", start, lb.Window)
- }
- if lb.Window.Contains(end) {
- lb.End = end
- } else {
- log.Warnf("Disk.SetStartEnd: end %s not in %s", end, lb.Window)
- }
- }
- // Add sums the Asset with the given Asset to produce a new Asset, maintaining
- // as much relevant information as possible (i.e. type, Properties, labels).
- func (lb *LoadBalancer) Add(a Asset) Asset {
- // LoadBalancer + LoadBalancer = LoadBalancer
- if that, ok := a.(*LoadBalancer); ok {
- this := lb.Clone().(*LoadBalancer)
- this.add(that)
- return this
- }
- props := lb.GetProperties().Merge(a.GetProperties())
- labels := lb.Labels.Merge(a.GetLabels())
- start := lb.Start
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- end := lb.End
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- window := lb.Window.Expand(a.GetWindow())
- // LoadBalancer + !LoadBalancer = Any
- any := NewAsset(start, end, window)
- any.SetProperties(props)
- any.SetLabels(labels)
- any.Adjustment = lb.Adjustment + a.GetAdjustment()
- any.Cost = (lb.TotalCost() - lb.Adjustment) + (a.TotalCost() - a.GetAdjustment())
- return any
- }
- func (lb *LoadBalancer) add(that *LoadBalancer) {
- if lb == nil {
- lb = that
- return
- }
- props := lb.Properties.Merge(that.GetProperties())
- labels := lb.Labels.Merge(that.GetLabels())
- lb.SetProperties(props)
- lb.SetLabels(labels)
- start := lb.Start
- if that.Start.Before(start) {
- start = that.Start
- }
- end := lb.End
- if that.End.After(end) {
- end = that.End
- }
- window := lb.Window.Expand(that.Window)
- lb.Start = start
- lb.End = end
- lb.Window = window
- lb.Cost += that.Cost
- lb.Adjustment += that.Adjustment
- }
- // Clone returns a cloned instance of the given Asset
- func (lb *LoadBalancer) Clone() Asset {
- return &LoadBalancer{
- Properties: lb.Properties.Clone(),
- Labels: lb.Labels.Clone(),
- Start: lb.Start,
- End: lb.End,
- Window: lb.Window.Clone(),
- Adjustment: lb.Adjustment,
- Cost: lb.Cost,
- }
- }
- // Equal returns true if the tow Assets match precisely
- func (lb *LoadBalancer) Equal(a Asset) bool {
- that, ok := a.(*LoadBalancer)
- if !ok {
- return false
- }
- if !lb.Labels.Equal(that.Labels) {
- return false
- }
- if !lb.Properties.Equal(that.Properties) {
- return false
- }
- if !lb.Start.Equal(that.Start) {
- return false
- }
- if !lb.End.Equal(that.End) {
- return false
- }
- if !lb.Window.Equal(that.Window) {
- return false
- }
- if lb.Adjustment != that.Adjustment {
- return false
- }
- if lb.Cost != that.Cost {
- return false
- }
- return true
- }
- // String implements fmt.Stringer
- func (lb *LoadBalancer) String() string {
- return toString(lb)
- }
- // SharedAsset is an Asset representing a shared cost
- type SharedAsset struct {
- Properties *AssetProperties
- Labels AssetLabels
- Window Window
- Cost float64
- }
- // NewSharedAsset creates and returns a new SharedAsset
- func NewSharedAsset(name string, window Window) *SharedAsset {
- properties := &AssetProperties{
- Name: name,
- Category: SharedCategory,
- Service: OtherCategory,
- }
- return &SharedAsset{
- Properties: properties,
- Labels: AssetLabels{},
- Window: window.Clone(),
- }
- }
- // Type returns the AssetType of the Asset
- func (sa *SharedAsset) Type() AssetType {
- return SharedAssetType
- }
- // Properties returns the Asset's Properties
- func (sa *SharedAsset) GetProperties() *AssetProperties {
- return sa.Properties
- }
- // SetProperties sets the Asset's Properties
- func (sa *SharedAsset) SetProperties(props *AssetProperties) {
- sa.Properties = props
- }
- // Labels returns the Asset's labels
- func (sa *SharedAsset) GetLabels() AssetLabels {
- return sa.Labels
- }
- // SetLabels sets the Asset's labels
- func (sa *SharedAsset) SetLabels(labels AssetLabels) {
- sa.Labels = labels
- }
- // Adjustment is not relevant to SharedAsset, but required to implement Asset
- func (sa *SharedAsset) GetAdjustment() float64 {
- return 0.0
- }
- // SetAdjustment is not relevant to SharedAsset, but required to implement Asset
- func (sa *SharedAsset) SetAdjustment(float64) {
- return
- }
- // TotalCost returns the Asset's total cost
- func (sa *SharedAsset) TotalCost() float64 {
- return sa.Cost
- }
- // Start returns the start time of the Asset
- func (sa *SharedAsset) GetStart() time.Time {
- return *sa.Window.start
- }
- // End returns the end time of the Asset
- func (sa *SharedAsset) GetEnd() time.Time {
- return *sa.Window.end
- }
- // Minutes returns the number of minutes the SharedAsset ran within the window
- func (sa *SharedAsset) Minutes() float64 {
- return sa.Window.Minutes()
- }
- // Window returns the window within the SharedAsset ran
- func (sa *SharedAsset) GetWindow() Window {
- return sa.Window
- }
- func (sa *SharedAsset) SetWindow(window Window) {
- sa.Window = window
- }
- // ExpandWindow expands the Asset's window
- func (sa *SharedAsset) ExpandWindow(w Window) {
- sa.Window = sa.Window.Expand(w)
- }
- // SetStartEnd sets the Asset's Start and End fields (not applicable here)
- func (sa *SharedAsset) SetStartEnd(start, end time.Time) {
- return
- }
- // Add sums the Asset with the given Asset to produce a new Asset, maintaining
- // as much relevant information as possible (i.e. type, Properties, labels).
- func (sa *SharedAsset) Add(a Asset) Asset {
- // SharedAsset + SharedAsset = SharedAsset
- if that, ok := a.(*SharedAsset); ok {
- this := sa.Clone().(*SharedAsset)
- this.add(that)
- return this
- }
- props := sa.Properties.Merge(a.GetProperties())
- labels := sa.Labels.Merge(a.GetLabels())
- start := sa.GetStart()
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- end := sa.GetEnd()
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- window := sa.Window.Expand(a.GetWindow())
- // SharedAsset + !SharedAsset = Any
- any := NewAsset(start, end, window)
- any.SetProperties(props)
- any.SetLabels(labels)
- any.Adjustment = sa.GetAdjustment() + a.GetAdjustment()
- any.Cost = (sa.TotalCost() - sa.GetAdjustment()) + (a.TotalCost() - a.GetAdjustment())
- return any
- }
- func (sa *SharedAsset) add(that *SharedAsset) {
- if sa == nil {
- sa = that
- return
- }
- props := sa.Properties.Merge(that.GetProperties())
- labels := sa.Labels.Merge(that.GetLabels())
- sa.SetProperties(props)
- sa.SetLabels(labels)
- window := sa.Window.Expand(that.Window)
- sa.Window = window
- sa.Cost += that.Cost
- }
- // Clone returns a deep copy of the given SharedAsset
- func (sa *SharedAsset) Clone() Asset {
- if sa == nil {
- return nil
- }
- return &SharedAsset{
- Properties: sa.Properties.Clone(),
- Labels: sa.Labels.Clone(),
- Window: sa.Window.Clone(),
- Cost: sa.Cost,
- }
- }
- // Equal returns true if the two Assets are exact matches
- func (sa *SharedAsset) Equal(a Asset) bool {
- that, ok := a.(*SharedAsset)
- if !ok {
- return false
- }
- if !sa.Labels.Equal(that.Labels) {
- return false
- }
- if !sa.Properties.Equal(that.Properties) {
- return false
- }
- if !sa.Window.Equal(that.Window) {
- return false
- }
- if sa.Cost != that.Cost {
- return false
- }
- return true
- }
- // String implements fmt.Stringer
- func (sa *SharedAsset) String() string {
- return toString(sa)
- }
- // This type exists because only the assets map of AssetSet is marshaled to
- // json, which makes it impossible to recreate an AssetSet struct. Thus,
- // the type when unmarshaling a marshaled AssetSet,is AssetSetResponse
- type AssetSetResponse struct {
- Assets map[string]Asset
- }
- // AssetSet stores a set of Assets, each with a unique name, that share
- // a window. An AssetSet is mutable, so treat it like a threadsafe map.
- type AssetSet struct {
- AggregationKeys []string
- Assets map[string]Asset
- Any map[string]*Any //@bingen:field[ignore]
- Cloud map[string]*Cloud //@bingen:field[ignore]
- ClusterManagement map[string]*ClusterManagement //@bingen:field[ignore]
- Disks map[string]*Disk //@bingen:field[ignore]
- Network map[string]*Network //@bingen:field[ignore]
- Nodes map[string]*Node //@bingen:field[ignore]
- LoadBalancers map[string]*LoadBalancer //@bingen:field[ignore]
- SharedAssets map[string]*SharedAsset //@bingen:field[ignore]
- FromSource string // stores the name of the source used to compute the data
- Window Window
- Warnings []string
- Errors []string
- }
- // This methid is executed before marshalling the AssetSet binary.
- func preProcessAssetSet(assetSet *AssetSet) {
- length := len(assetSet.Any) + len(assetSet.Cloud) + len(assetSet.ClusterManagement) + len(assetSet.Disks) +
- len(assetSet.Network) + len(assetSet.Nodes) + len(assetSet.LoadBalancers) + len(assetSet.SharedAssets)
- if length != len(assetSet.Assets) {
- log.Warnf("AssetSet concrete Asset maps are out of sync with AssetSet.Assets map.")
- }
- }
- // This method is executed after unmarshalling the AssetSet binary.
- func postProcessAssetSet(assetSet *AssetSet) {
- for key, as := range assetSet.Assets {
- addToConcreteMap(assetSet, key, as)
- }
- }
- // addToConcreteMap adds the Asset to the correct concrete map in the AssetSet. This is used
- // in the postProcessAssetSet method as well as AssetSet.Insert().
- func addToConcreteMap(assetSet *AssetSet, key string, as Asset) {
- switch asset := as.(type) {
- case *Any:
- if assetSet.Any == nil {
- assetSet.Any = make(map[string]*Any)
- }
- assetSet.Any[key] = asset
- case *Cloud:
- if assetSet.Cloud == nil {
- assetSet.Cloud = make(map[string]*Cloud)
- }
- assetSet.Cloud[key] = asset
- case *ClusterManagement:
- if assetSet.ClusterManagement == nil {
- assetSet.ClusterManagement = make(map[string]*ClusterManagement)
- }
- assetSet.ClusterManagement[key] = asset
- case *Disk:
- if assetSet.Disks == nil {
- assetSet.Disks = make(map[string]*Disk)
- }
- assetSet.Disks[key] = asset
- case *Network:
- if assetSet.Network == nil {
- assetSet.Network = make(map[string]*Network)
- }
- assetSet.Network[key] = asset
- case *Node:
- if assetSet.Nodes == nil {
- assetSet.Nodes = make(map[string]*Node)
- }
- assetSet.Nodes[key] = asset
- case *LoadBalancer:
- if assetSet.LoadBalancers == nil {
- assetSet.LoadBalancers = make(map[string]*LoadBalancer)
- }
- assetSet.LoadBalancers[key] = asset
- case *SharedAsset:
- if assetSet.SharedAssets == nil {
- assetSet.SharedAssets = make(map[string]*SharedAsset)
- }
- assetSet.SharedAssets[key] = asset
- }
- }
- // removeFromConcreteMap will remove an Asset from the AssetSet's concrete type mapping for the Asset and key.
- func removeFromConcreteMap(assetSet *AssetSet, key string, as Asset) {
- switch as.(type) {
- case *Any:
- delete(assetSet.Any, key)
- case *Cloud:
- delete(assetSet.Cloud, key)
- case *ClusterManagement:
- delete(assetSet.ClusterManagement, key)
- case *Disk:
- delete(assetSet.Disks, key)
- case *Network:
- delete(assetSet.Network, key)
- case *Node:
- delete(assetSet.Nodes, key)
- case *LoadBalancer:
- delete(assetSet.LoadBalancers, key)
- case *SharedAsset:
- delete(assetSet.SharedAssets, key)
- }
- }
- // NewAssetSet instantiates a new AssetSet and, optionally, inserts
- // the given list of Assets
- func NewAssetSet(start, end time.Time, assets ...Asset) *AssetSet {
- as := &AssetSet{
- Assets: map[string]Asset{},
- Window: NewWindow(&start, &end),
- }
- for _, a := range assets {
- as.Insert(a)
- }
- return as
- }
- // AggregateBy aggregates the Assets in the AssetSet by the given list of
- // AssetProperties, such that each asset is binned by a key determined by its
- // relevant property values.
- func (as *AssetSet) AggregateBy(aggregateBy []string, opts *AssetAggregationOptions) error {
- if opts == nil {
- opts = &AssetAggregationOptions{}
- }
- if as.IsEmpty() && len(opts.SharedHourlyCosts) == 0 {
- return nil
- }
- aggSet := NewAssetSet(as.Start(), as.End())
- aggSet.AggregationKeys = aggregateBy
- // Compute hours of the given AssetSet, and if it ends in the future,
- // adjust the hours accordingly
- hours := as.Window.Minutes() / 60.0
- diff := time.Since(as.End())
- if diff < 0.0 {
- hours += diff.Hours()
- }
- // Insert a shared asset for each shared cost
- for name, hourlyCost := range opts.SharedHourlyCosts {
- sa := NewSharedAsset(name, as.Window.Clone())
- sa.Cost = hourlyCost * hours
- // Insert shared asset if it passes all filters
- insert := true
- for _, ff := range opts.FilterFuncs {
- if !ff(sa) {
- insert = false
- break
- }
- }
- if insert {
- err := aggSet.Insert(sa)
- if err != nil {
- return err
- }
- }
- }
- // Delete the Assets that don't pass each filter
- for _, ff := range opts.FilterFuncs {
- for key, asset := range as.Assets {
- if !ff(asset) {
- delete(as.Assets, key)
- }
- }
- }
- // Insert each asset into the new set, which will be keyed by the `aggregateBy`
- // on aggSet, resulting in aggregation.
- for _, asset := range as.Assets {
- err := aggSet.Insert(asset)
- if err != nil {
- return err
- }
- }
- // Assign the aggregated values back to the original set
- as.Assets = aggSet.Assets
- as.AggregationKeys = aggregateBy
- return nil
- }
- // Clone returns a new AssetSet with a deep copy of the given
- // AssetSet's assets.
- func (as *AssetSet) Clone() *AssetSet {
- if as == nil {
- return nil
- }
- var aggregateBy []string
- if as.AggregationKeys != nil {
- aggregateBy = append(aggregateBy, as.AggregationKeys...)
- }
- s := as.Start()
- e := as.End()
- var errors []string
- var warnings []string
- if as.Errors != nil {
- errors = make([]string, len(as.Errors))
- copy(errors, as.Errors)
- } else {
- errors = nil
- }
- if as.Warnings != nil {
- warnings := make([]string, len(as.Warnings))
- copy(warnings, as.Warnings)
- } else {
- warnings = nil
- }
- var anyMap map[string]*Any
- if as.Any != nil {
- anyMap = make(map[string]*Any, len(as.Any))
- }
- var cloudMap map[string]*Cloud
- if as.Cloud != nil {
- cloudMap = make(map[string]*Cloud, len(as.Cloud))
- }
- var clusterManagementMap map[string]*ClusterManagement
- if as.ClusterManagement != nil {
- clusterManagementMap = make(map[string]*ClusterManagement, len(as.ClusterManagement))
- }
- var disksMap map[string]*Disk
- if as.Disks != nil {
- disksMap = make(map[string]*Disk, len(as.Disks))
- }
- var networkMap map[string]*Network
- if as.Network != nil {
- networkMap = make(map[string]*Network, len(as.Network))
- }
- var nodesMap map[string]*Node
- if as.Nodes != nil {
- nodesMap = make(map[string]*Node, len(as.Nodes))
- }
- var loadBalancersMap map[string]*LoadBalancer
- if as.LoadBalancers != nil {
- loadBalancersMap = make(map[string]*LoadBalancer, len(as.LoadBalancers))
- }
- var sharedAssetsMap map[string]*SharedAsset
- if as.SharedAssets != nil {
- sharedAssetsMap = make(map[string]*SharedAsset, len(as.SharedAssets))
- }
- assetSet := &AssetSet{
- Window: NewWindow(&s, &e),
- AggregationKeys: aggregateBy,
- Assets: make(map[string]Asset, len(as.Assets)),
- Any: anyMap,
- Cloud: cloudMap,
- ClusterManagement: clusterManagementMap,
- Disks: disksMap,
- Network: networkMap,
- Nodes: nodesMap,
- LoadBalancers: loadBalancersMap,
- SharedAssets: sharedAssetsMap,
- Errors: errors,
- Warnings: warnings,
- }
- for k, v := range as.Assets {
- newAsset := v.Clone()
- assetSet.Assets[k] = newAsset
- addToConcreteMap(assetSet, k, newAsset)
- }
- return assetSet
- }
- // End returns the end time of the AssetSet's window
- func (as *AssetSet) End() time.Time {
- return *as.Window.End()
- }
- // FindMatch attempts to find a match in the AssetSet for the given Asset on
- // the provided Properties and labels. If a match is not found, FindMatch
- // returns nil and a Not Found error.
- func (as *AssetSet) FindMatch(query Asset, aggregateBy []string) (Asset, error) {
- matchKey, err := key(query, aggregateBy)
- if err != nil {
- return nil, err
- }
- for _, asset := range as.Assets {
- if k, err := key(asset, aggregateBy); err != nil {
- return nil, err
- } else if k == matchKey {
- return asset, nil
- }
- }
- return nil, fmt.Errorf("Asset not found to match %s on %v", query, aggregateBy)
- }
- // ReconciliationMatch attempts to find an exact match in the AssetSet on
- // (Category, ProviderID). If a match is found, it returns the Asset with the
- // intent to adjust it. If no match exists, it attempts to find one on only
- // (ProviderID). If that match is found, it returns the Asset with the intent
- // to insert the associated Cloud cost.
- func (as *AssetSet) ReconciliationMatch(query Asset) (Asset, bool, error) {
- // Full match means matching on (Category, ProviderID)
- fullMatchProps := []string{string(AssetCategoryProp), string(AssetProviderIDProp)}
- fullMatchKey, err := key(query, fullMatchProps)
- // This should never happen because we are using enumerated Properties,
- // but the check is here in case that changes
- if err != nil {
- return nil, false, err
- }
- // Partial match means matching only on (ProviderID)
- providerIDMatchProps := []string{string(AssetProviderIDProp)}
- providerIDMatchKey, err := key(query, providerIDMatchProps)
- // This should never happen because we are using enumerated Properties,
- // but the check is here in case that changes
- if err != nil {
- return nil, false, err
- }
- var providerIDMatch Asset
- for _, asset := range as.Assets {
- // Ignore cloud assets when looking for reconciliation matches
- if asset.Type() == CloudAssetType {
- continue
- }
- if k, err := key(asset, fullMatchProps); err != nil {
- return nil, false, err
- } else if k == fullMatchKey {
- log.DedupedInfof(10, "Asset ETL: Reconciliation[rcnw]: ReconcileRange Match: %s", fullMatchKey)
- return asset, true, nil
- }
- if k, err := key(asset, providerIDMatchProps); err != nil {
- return nil, false, err
- } else if k == providerIDMatchKey {
- // Found a partial match. Save it until after all other options
- // have been checked for full matches.
- providerIDMatch = asset
- }
- }
- // No full match was found, so return partial match, if found.
- if providerIDMatch != nil {
- return providerIDMatch, false, nil
- }
- return nil, false, fmt.Errorf("Asset not found to match %s", query)
- }
- // ReconciliationMatchMap returns a map of the calling AssetSet's Assets, by provider id and category. This data structure
- // allows for reconciliation matching to be done in constant time and prevents duplicate reconciliation.
- func (as *AssetSet) ReconciliationMatchMap() map[string]map[string]Asset {
- matchMap := make(map[string]map[string]Asset)
- if as == nil {
- return matchMap
- }
- for _, asset := range as.Assets {
- if asset == nil {
- continue
- }
- props := asset.GetProperties()
- // Ignore assets that cannot be matched when looking for reconciliation matches
- if props == nil || props.ProviderID == "" {
- continue
- }
- if _, ok := matchMap[props.ProviderID]; !ok {
- matchMap[props.ProviderID] = make(map[string]Asset)
- }
- // Check if a match is already in the map
- if duplicateAsset, ok := matchMap[props.ProviderID][props.Category]; ok {
- log.DedupedWarningf(5, "duplicate asset found when reconciling for %s", props.ProviderID)
- // if one asset already has adjustment use that one
- if duplicateAsset.GetAdjustment() == 0 && asset.GetAdjustment() != 0 {
- matchMap[props.ProviderID][props.Category] = asset
- } else if duplicateAsset.GetAdjustment() != 0 && asset.GetAdjustment() == 0 {
- matchMap[props.ProviderID][props.Category] = duplicateAsset
- // otherwise use the one with the higher cost
- } else if duplicateAsset.TotalCost() < asset.TotalCost() {
- matchMap[props.ProviderID][props.Category] = asset
- }
- } else {
- matchMap[props.ProviderID][props.Category] = asset
- }
- }
- return matchMap
- }
- // Get returns the Asset in the AssetSet at the given key, or nil and false
- // if no Asset exists for the given key
- func (as *AssetSet) Get(key string) (Asset, bool) {
- if a, ok := as.Assets[key]; ok {
- return a, true
- }
- return nil, false
- }
- // Insert inserts the given Asset into the AssetSet, using the AssetSet's
- // configured Properties to determine the key under which the Asset will
- // be inserted.
- func (as *AssetSet) Insert(asset Asset) error {
- if as == nil {
- return fmt.Errorf("cannot Insert into nil AssetSet")
- }
- if as.Assets == nil {
- as.Assets = map[string]Asset{}
- }
- // Determine key into which to Insert the Asset.
- k, err := key(asset, as.AggregationKeys)
- if err != nil {
- return err
- }
- // Add the given Asset to the existing entry, if there is one;
- // otherwise just set directly into assets
- if _, ok := as.Assets[k]; !ok {
- as.Assets[k] = asset
- // insert the asset into it's type specific map as well
- addToConcreteMap(as, k, asset)
- } else {
- // possibly creates a new asset type, so we need to update the
- // concrete type mappings
- newAsset := as.Assets[k].Add(asset)
- removeFromConcreteMap(as, k, as.Assets[k])
- // overwrite the existing asset with the new one, and re-add the new
- // asset to the concrete type mappings
- as.Assets[k] = newAsset
- addToConcreteMap(as, k, newAsset)
- }
- // Expand the window, just to be safe. It's possible that the asset will
- // be set into the map without expanding it to the AssetSet's window.
- as.Assets[k].ExpandWindow(as.Window)
- return nil
- }
- // IsEmpty returns true if the AssetSet is nil, or if it contains
- // zero assets.
- func (as *AssetSet) IsEmpty() bool {
- return as == nil || len(as.Assets) == 0
- }
- func (as *AssetSet) Length() int {
- if as == nil {
- return 0
- }
- return len(as.Assets)
- }
- func (as *AssetSet) GetWindow() Window {
- return as.Window
- }
- // Resolution returns the AssetSet's window duration
- func (as *AssetSet) Resolution() time.Duration {
- return as.Window.Duration()
- }
- func (as *AssetSet) Set(asset Asset, aggregateBy []string) error {
- if as.IsEmpty() {
- as.Assets = map[string]Asset{}
- }
- // Expand the window to match the AssetSet, then set it
- asset.ExpandWindow(as.Window)
- k, err := key(asset, aggregateBy)
- if err != nil {
- return err
- }
- as.Assets[k] = asset
- addToConcreteMap(as, k, asset)
- return nil
- }
- func (as *AssetSet) Start() time.Time {
- return *as.Window.Start()
- }
- func (as *AssetSet) TotalCost() float64 {
- tc := 0.0
- for _, a := range as.Assets {
- tc += a.TotalCost()
- }
- return tc
- }
- func (as *AssetSet) UTCOffset() time.Duration {
- _, zone := as.Start().Zone()
- return time.Duration(zone) * time.Second
- }
- func (as *AssetSet) accumulate(that *AssetSet) (*AssetSet, error) {
- if as == nil {
- return that, nil
- }
- if that == nil {
- return as, nil
- }
- // In the case of an AssetSetRange with empty entries, we may end up with
- // an incoming `as` without an `aggregateBy`, even though we are tring to
- // aggregate here. This handles that case by assigning the correct `aggregateBy`.
- if !sameContents(as.AggregationKeys, that.AggregationKeys) {
- if len(as.AggregationKeys) == 0 {
- as.AggregationKeys = that.AggregationKeys
- }
- }
- // Set start, end to min(start), max(end)
- start := as.Start()
- end := as.End()
- if that.Start().Before(start) {
- start = that.Start()
- }
- if that.End().After(end) {
- end = that.End()
- }
- if as.IsEmpty() && that.IsEmpty() {
- return NewAssetSet(start, end), nil
- }
- acc := NewAssetSet(start, end)
- acc.AggregationKeys = as.AggregationKeys
- for _, asset := range as.Assets {
- err := acc.Insert(asset)
- if err != nil {
- return nil, err
- }
- }
- for _, asset := range that.Assets {
- err := acc.Insert(asset)
- if err != nil {
- return nil, err
- }
- }
- return acc, nil
- }
- type DiffKind string
- const (
- DiffAdded DiffKind = "added"
- DiffRemoved = "removed"
- DiffChanged = "changed"
- )
- // Diff stores an object and a string that denotes whether that object was
- // added or removed from a set of those objects
- type Diff[T any] struct {
- Before T
- After T
- Kind DiffKind
- }
- // DiffAsset takes two AssetSets and returns a map of keys to Diffs by checking
- // the keys of each AssetSet. If a key is not found or is found with a different total cost,
- // a Diff is generated and added to the map. A found asset will only be added to the map if the new
- // total cost is greater than ratioCostChange * the old total cost
- func DiffAsset(before, after *AssetSet, ratioCostChange float64) (map[string]Diff[Asset], error) {
- if ratioCostChange < 0.0 {
- return nil, fmt.Errorf("Percent cost change cannot be less than 0")
- }
- changedItems := map[string]Diff[Asset]{}
- for assetKey1, asset1 := range before.Assets {
- if asset2, ok := after.Assets[assetKey1]; !ok {
- d := Diff[Asset]{asset1, nil, DiffRemoved}
- changedItems[assetKey1] = d
- } else if math.Abs(asset1.TotalCost()-asset2.TotalCost()) > ratioCostChange*asset1.TotalCost() { //check if either value exceeds the other by more than pctCostChange
- d := Diff[Asset]{asset1, asset2, DiffChanged}
- changedItems[assetKey1] = d
- }
- }
- for assetKey2, asset2 := range after.Assets {
- if _, ok := before.Assets[assetKey2]; !ok {
- d := Diff[Asset]{nil, asset2, DiffAdded}
- changedItems[assetKey2] = d
- }
- }
- return changedItems, nil
- }
- // AssetSetRange is a thread-safe slice of AssetSets. It is meant to
- // be used such that the AssetSets held are consecutive and coherent with
- // respect to using the same aggregation Properties, UTC offset, and
- // resolution. However these rules are not necessarily enforced, so use wisely.
- type AssetSetRange struct {
- Assets []*AssetSet
- FromStore string // stores the name of the store used to retrieve the data
- }
- // NewAssetSetRange instantiates a new range composed of the given
- // AssetSets in the order provided.
- func NewAssetSetRange(assets ...*AssetSet) *AssetSetRange {
- return &AssetSetRange{
- Assets: assets,
- }
- }
- // Accumulate sums each AssetSet in the given range, returning a single cumulative
- // AssetSet for the entire range.
- func (asr *AssetSetRange) Accumulate() (*AssetSet, error) {
- var assetSet *AssetSet
- var err error
- for _, as := range asr.Assets {
- assetSet, err = assetSet.accumulate(as)
- if err != nil {
- return nil, err
- }
- }
- return assetSet, nil
- }
- // NewAccumulation clones the first available AssetSet to use as the data structure to
- // accumulate the remaining data. This leaves the original AssetSetRange intact.
- func (asr *AssetSetRange) NewAccumulation() (*AssetSet, error) {
- var assetSet *AssetSet
- var err error
- for _, as := range asr.Assets {
- if assetSet == nil {
- assetSet = as.Clone()
- continue
- }
- // copy if non-nil
- var assetSetCopy *AssetSet = nil
- if as != nil {
- assetSetCopy = as.Clone()
- }
- // nil is acceptable to pass to accumulate
- assetSet, err = assetSet.accumulate(assetSetCopy)
- if err != nil {
- return nil, err
- }
- }
- return assetSet, nil
- }
- type AssetAggregationOptions struct {
- SharedHourlyCosts map[string]float64
- FilterFuncs []AssetMatchFunc
- }
- func (asr *AssetSetRange) AggregateBy(aggregateBy []string, opts *AssetAggregationOptions) error {
- aggRange := &AssetSetRange{Assets: []*AssetSet{}}
- for _, as := range asr.Assets {
- err := as.AggregateBy(aggregateBy, opts)
- if err != nil {
- return err
- }
- aggRange.Assets = append(aggRange.Assets, as)
- }
- asr.Assets = aggRange.Assets
- return nil
- }
- func (asr *AssetSetRange) Append(that *AssetSet) {
- asr.Assets = append(asr.Assets, that)
- }
- // Get provides bounds checked access into the AssetSetRange's AssetSets.
- func (asr *AssetSetRange) Get(i int) (*AssetSet, error) {
- if i < 0 || i >= len(asr.Assets) {
- return nil, fmt.Errorf("AssetSetRange: index out of range: %d", i)
- }
- return asr.Assets[i], nil
- }
- // Length returns the total number of AssetSets in the range.
- func (asr *AssetSetRange) Length() int {
- if asr == nil {
- return 0
- }
- return len(asr.Assets)
- }
- // InsertRange merges the given AssetSetRange into the receiving one by
- // lining up sets with matching windows, then inserting each asset from
- // the given ASR into the respective set in the receiving ASR. If the given
- // ASR contains an AssetSetRange from a window that does not exist in the
- // receiving ASR, then an error is returned. However, the given ASR does not
- // need to cover the full range of the receiver.
- func (asr *AssetSetRange) InsertRange(that *AssetSetRange) error {
- if asr == nil {
- return fmt.Errorf("cannot insert range into nil AssetSetRange")
- }
- // keys maps window to index in asr
- keys := map[string]int{}
- for i, as := range asr.Assets {
- if as == nil {
- continue
- }
- keys[as.Window.String()] = i
- }
- // Nothing to merge, so simply return
- if len(keys) == 0 {
- return nil
- }
- var err error
- for _, thatAS := range that.Assets {
- if thatAS == nil || err != nil {
- continue
- }
- // Find matching AssetSet in asr
- i, ok := keys[thatAS.Window.String()]
- if !ok {
- err = fmt.Errorf("cannot merge AssetSet into window that does not exist: %s", thatAS.Window.String())
- continue
- }
- as, err := asr.Get(i)
- if err != nil {
- err = fmt.Errorf("AssetSetRange index does not exist: %d", i)
- continue
- }
- // Insert each Asset from the given set
- for _, asset := range thatAS.Assets {
- err = as.Insert(asset)
- if err != nil {
- err = fmt.Errorf("error inserting asset: %s", err)
- continue
- }
- }
- }
- // err might be nil
- return err
- }
- // IsEmpty returns false if AssetSetRange contains a single AssetSet that is not empty
- func (asr *AssetSetRange) IsEmpty() bool {
- if asr == nil || asr.Length() == 0 {
- return true
- }
- for _, asset := range asr.Assets {
- if !asset.IsEmpty() {
- return false
- }
- }
- return true
- }
- func (asr *AssetSetRange) MarshalJSON() ([]byte, error) {
- if asr == nil {
- return json.Marshal([]*AssetSet{})
- }
- return json.Marshal(asr.Assets)
- }
- // As with AssetSet, AssetSetRange does not serialize all its fields,
- // making it impossible to reconstruct the AssetSetRange from its json.
- // Therefore, the type a marshaled AssetSetRange unmarshals to is
- // AssetSetRangeResponse
- type AssetSetRangeResponse struct {
- Assets []*AssetSetResponse
- }
- func (asr *AssetSetRange) UTCOffset() time.Duration {
- if asr.Length() == 0 {
- return 0
- }
- as, err := asr.Get(0)
- if err != nil {
- return 0
- }
- return as.UTCOffset()
- }
- // Window returns the full window that the AssetSetRange spans, from the
- // start of the first AssetSet to the end of the last one.
- func (asr *AssetSetRange) Window() Window {
- if asr == nil || asr.Length() == 0 {
- return NewWindow(nil, nil)
- }
- start := asr.Assets[0].Start()
- end := asr.Assets[asr.Length()-1].End()
- return NewWindow(&start, &end)
- }
- // Start returns the earliest start of all Assets in the AssetSetRange.
- // It returns an error if there are no assets
- func (asr *AssetSetRange) Start() (time.Time, error) {
- start := time.Time{}
- if asr == nil {
- return start, fmt.Errorf("had no data to compute a start from")
- }
- firstStartNotSet := true
- for _, as := range asr.Assets {
- for _, a := range as.Assets {
- if firstStartNotSet {
- start = a.GetStart()
- firstStartNotSet = false
- }
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- }
- }
- if firstStartNotSet {
- return start, fmt.Errorf("had no data to compute a start from")
- }
- return start, nil
- }
- // End returns the latest end of all Assets in the AssetSetRange.
- // It returns an error if there are no assets.
- func (asr *AssetSetRange) End() (time.Time, error) {
- end := time.Time{}
- if asr == nil {
- return end, fmt.Errorf("had no data to compute an end from")
- }
- firstEndNotSet := true
- for _, as := range asr.Assets {
- for _, a := range as.Assets {
- if firstEndNotSet {
- end = a.GetEnd()
- firstEndNotSet = false
- }
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- }
- }
- if firstEndNotSet {
- return end, fmt.Errorf("had no data to compute an end from")
- }
- return end, nil
- }
- // Each iterates over all AssetSets in the AssetSetRange and returns the start and end over
- // the entire range
- func (asr *AssetSetRange) StartAndEnd() (time.Time, time.Time, error) {
- start := time.Time{}
- end := time.Time{}
- if asr == nil {
- return start, end, fmt.Errorf("had no data to compute a start and end from")
- }
- firstStartNotSet := true
- firstEndNotSet := true
- for _, as := range asr.Assets {
- for _, a := range as.Assets {
- if firstStartNotSet {
- start = a.GetStart()
- firstStartNotSet = false
- }
- if a.GetStart().Before(start) {
- start = a.GetStart()
- }
- if firstEndNotSet {
- end = a.GetEnd()
- firstEndNotSet = false
- }
- if a.GetEnd().After(end) {
- end = a.GetEnd()
- }
- }
- }
- if firstStartNotSet {
- return start, end, fmt.Errorf("had no data to compute a start from")
- }
- if firstEndNotSet {
- return start, end, fmt.Errorf("had no data to compute an end from")
- }
- return start, end, nil
- }
- // Minutes returns the duration, in minutes, between the earliest start
- // and the latest end of all assets in the AssetSetRange.
- func (asr *AssetSetRange) Minutes() float64 {
- if asr == nil {
- return 0
- }
- start, end, err := asr.StartAndEnd()
- if err != nil {
- return 0
- }
- duration := end.Sub(start)
- return duration.Minutes()
- }
- // TotalCost returns the AssetSetRange's total cost
- func (asr *AssetSetRange) TotalCost() float64 {
- if asr == nil {
- return 0.0
- }
- tc := 0.0
- for _, as := range asr.Assets {
- tc += as.TotalCost()
- }
- return tc
- }
- // This is a helper type. The Asset API returns a json which cannot be natively
- // unmarshaled into any Asset struct. Therefore, this struct IN COMBINATION WITH
- // DESERIALIZATION LOGIC DEFINED IN asset_json.go can unmarshal a json directly
- // from an Assets API query
- type AssetAPIResponse struct {
- Code int `json:"code"`
- Data AssetSetRangeResponse `json:"data"`
- }
- // Returns true if string slices a and b contain all of the same strings, in any order.
- func sameContents(a, b []string) bool {
- if len(a) != len(b) {
- return false
- }
- for i := range a {
- if !contains(b, a[i]) {
- return false
- }
- }
- return true
- }
- func contains(slice []string, item string) bool {
- for _, element := range slice {
- if element == item {
- return true
- }
- }
- return false
- }
|