-
Notifications
You must be signed in to change notification settings - Fork 519
/
window.go
1178 lines (990 loc) · 33.4 KB
/
window.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package opencost
import (
"bytes"
"encoding/json"
"fmt"
"math"
"regexp"
"strconv"
"sync"
"time"
"github.com/opencost/opencost/core/pkg/env"
"github.com/opencost/opencost/core/pkg/log"
"github.com/opencost/opencost/core/pkg/util/timeutil"
)
const (
minutesPerDay = 60 * 24
minutesPerHour = 60
hoursPerDay = 24
)
var (
durationRegex = regexp.MustCompile(`^(\d+)(m|h|d|w)$`)
durationOffsetRegex = regexp.MustCompile(`^(\d+)(m|h|d|w) offset (\d+)(m|h|d|w)$`)
offesetRegex = regexp.MustCompile(`^(\+|-)(\d\d):(\d\d)$`)
rfc3339 = `\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ`
rfcRegex = regexp.MustCompile(fmt.Sprintf(`(%s),(%s)`, rfc3339, rfc3339))
timestampPairRegex = regexp.MustCompile(`^(\d+)[,|-](\d+)$`)
tOffsetLock sync.Mutex
tOffset *time.Duration
utcOffsetLock sync.Mutex
utcOffsetDur *time.Duration
)
// get and cache the thanos offset duration.
// TODO: Due to dependencies here, we have to drag a non-core config option into
// TOOD: core scope. Any solution here would be a one-off until we can generalize
// TODO: global configuration options.
func thanosOffset() time.Duration {
tOffsetLock.Lock()
defer tOffsetLock.Unlock()
if tOffset == nil {
d, err := time.ParseDuration(env.Get("THANOS_QUERY_OFFSET", "3h"))
if err != nil {
d = 0
}
tOffset = &d
}
return *tOffset
}
// returns true if thanos is enabled
// TODO: Same note as thanosOffset above - temporary work-around until more
// TODO: generalized global configuration.
func isThanosEnabled() bool {
return env.GetBool("THANOS_ENABLED", false)
}
// returns the configured utc offset as a duration
// TODO: Same as the above options -- we should provide a one-time initialization configuration
// TODO: for these values, or deprecate their use.
func utcOffset() time.Duration {
utcOffsetLock.Lock()
defer utcOffsetLock.Unlock()
if utcOffsetDur == nil {
utcOff, err := timeutil.ParseUTCOffset(env.Get("UTC_OFFSET", ""))
if err != nil {
utcOff = time.Duration(0)
}
utcOffsetDur = &utcOff
}
return *utcOffsetDur
}
// RoundBack rounds the given time back to a multiple of the given resolution
// in the given time's timezone.
// e.g. 2020-01-01T12:37:48-0700, 24h = 2020-01-01T00:00:00-0700
func RoundBack(t time.Time, resolution time.Duration) time.Time {
// if the duration is a week - roll back to the following Sunday
if resolution == timeutil.Week {
return timeutil.RoundToStartOfWeek(t)
}
_, offSec := t.Zone()
return t.Add(time.Duration(offSec) * time.Second).Truncate(resolution).Add(-time.Duration(offSec) * time.Second)
}
// RoundForward rounds the given time forward to a multiple of the given resolution
// in the given time's timezone.
// e.g. 2020-01-01T12:37:48-0700, 24h = 2020-01-02T00:00:00-0700
func RoundForward(t time.Time, resolution time.Duration) time.Time {
back := RoundBack(t, resolution)
if back.Equal(t) {
// The given time is exactly a multiple of the given resolution
return t
}
return back.Add(resolution)
}
// Window defines a period of time with a start and an end. If either start or
// end are nil it indicates an open time period.
type Window struct {
start *time.Time
end *time.Time
}
// NewWindow creates and returns a new Window instance from the given times
func NewWindow(start, end *time.Time) Window {
return Window{
start: start,
end: end,
}
}
// NewClosedWindow creates and returns a new Window instance from the given
// times, which cannot be nil, so they are value types.
func NewClosedWindow(start, end time.Time) Window {
return Window{
start: &start,
end: &end,
}
}
// ParseWindowUTC attempts to parse the given string into a valid Window. It
// accepts several formats, returning an error if the given string does not
// match one of the following:
// - named intervals: "today", "yesterday", "week", "month", "lastweek", "lastmonth"
// - durations: "24h", "7d", etc.
// - date ranges: "2020-04-01T00:00:00Z,2020-04-03T00:00:00Z", etc.
// - timestamp ranges: "1586822400,1586908800", etc.
func ParseWindowUTC(window string) (Window, error) {
return parseWindow(window, time.Now().UTC())
}
// ParseWindowWithOffsetString parses the given window string within the context of
// the timezone defined by the UTC offset string of format -07:00, +01:30, etc.
func ParseWindowWithOffsetString(window string, offset string) (Window, error) {
if offset == "UTC" || offset == "" {
return ParseWindowUTC(window)
}
match := offesetRegex.FindStringSubmatch(offset)
if match == nil {
return Window{}, fmt.Errorf("illegal UTC offset: '%s'; should be of form '-07:00'", offset)
}
sig := 1
if match[1] == "-" {
sig = -1
}
hrs64, _ := strconv.ParseInt(match[2], 10, 64)
hrs := sig * int(hrs64)
mins64, _ := strconv.ParseInt(match[3], 10, 64)
mins := sig * int(mins64)
loc := time.FixedZone(fmt.Sprintf("UTC%s", offset), (hrs*60*60)+(mins*60))
now := time.Now().In(loc)
return parseWindow(window, now)
}
// ParseWindowWithOffset parses the given window string within the context of
// the timezone defined by the UTC offset.
func ParseWindowWithOffset(window string, offset time.Duration) (Window, error) {
loc := time.FixedZone("", int(offset.Seconds()))
now := time.Now().In(loc)
return parseWindow(window, now)
}
// parseWindow generalizes the parsing of window strings, relative to a given
// moment in time, defined as "now".
func parseWindow(window string, now time.Time) (Window, error) {
// compute UTC offset in terms of minutes
offHr := now.UTC().Hour() - now.Hour()
offMin := (now.UTC().Minute() - now.Minute()) + (offHr * 60)
offset := time.Duration(offMin) * time.Minute
if window == "today" {
start := now
start = start.Truncate(time.Hour * 24)
start = start.Add(offset)
end := start.Add(time.Hour * 24)
return NewWindow(&start, &end), nil
}
if window == "yesterday" {
start := now
start = start.Truncate(time.Hour * 24)
start = start.Add(offset)
start = start.Add(time.Hour * -24)
end := start.Add(time.Hour * 24)
return NewWindow(&start, &end), nil
}
if window == "week" {
// now
start := now
// 00:00 today, accounting for timezone offset
start = start.Truncate(time.Hour * 24)
start = start.Add(offset)
// 00:00 Sunday of the current week
start = start.Add(-24 * time.Hour * time.Duration(start.Weekday()))
end := now
return NewWindow(&start, &end), nil
}
if window == "lastweek" {
// now
start := now
// 00:00 today, accounting for timezone offset
start = start.Truncate(time.Hour * 24)
start = start.Add(offset)
// 00:00 Sunday of last week
start = start.Add(-24 * time.Hour * time.Duration(start.Weekday()+7))
end := start.Add(7 * 24 * time.Hour)
return NewWindow(&start, &end), nil
}
if window == "month" {
// now
start := now
// 00:00 today, accounting for timezone offset
start = start.Truncate(time.Hour * 24)
start = start.Add(offset)
// 00:00 1st of this month
start = start.Add(-24 * time.Hour * time.Duration(start.Day()-1))
end := now
return NewWindow(&start, &end), nil
}
if window == "month" {
// now
start := now
// 00:00 today, accounting for timezone offset
start = start.Truncate(time.Hour * 24)
start = start.Add(offset)
// 00:00 1st of this month
start = start.Add(-24 * time.Hour * time.Duration(start.Day()-1))
end := now
return NewWindow(&start, &end), nil
}
if window == "lastmonth" {
// now
end := now
// 00:00 today, accounting for timezone offset
end = end.Truncate(time.Hour * 24)
end = end.Add(offset)
// 00:00 1st of this month
end = end.Add(-24 * time.Hour * time.Duration(end.Day()-1))
// 00:00 last day of last month
start := end.Add(-24 * time.Hour)
// 00:00 1st of last month
start = start.Add(-24 * time.Hour * time.Duration(start.Day()-1))
return NewWindow(&start, &end), nil
}
// Match duration strings; e.g. "45m", "24h", "7d"
match := durationRegex.FindStringSubmatch(window)
if match != nil {
dur := time.Minute
if match[2] == "h" {
dur = time.Hour
}
if match[2] == "d" {
dur = 24 * time.Hour
}
if match[2] == "w" {
dur = timeutil.Week
}
num, _ := strconv.ParseInt(match[1], 10, 64)
end := now
start := end.Add(-time.Duration(num) * dur)
// when using windows such as "7d" and "1w", we have to have a definition for what "the past X days" means.
// let "the past X days" be defined as the entirety of today plus the entirety of the past X-1 days, where
// "entirety" is defined as midnight to midnight, UTC. given this definition, we round forward the calculated
// start and end times to the nearest day to align with midnight boundaries
if match[2] == "d" || match[2] == "w" {
end = end.Truncate(timeutil.Day).Add(timeutil.Day)
start = start.Truncate(timeutil.Day).Add(timeutil.Day)
}
return NewWindow(&start, &end), nil
}
// Match duration strings with offset; e.g. "45m offset 15m", etc.
match = durationOffsetRegex.FindStringSubmatch(window)
if match != nil {
end := now
offUnit := time.Minute
if match[4] == "h" {
offUnit = time.Hour
}
if match[4] == "d" {
offUnit = 24 * time.Hour
}
if match[4] == "w" {
offUnit = 24 * timeutil.Week
}
offNum, _ := strconv.ParseInt(match[3], 10, 64)
end = end.Add(-time.Duration(offNum) * offUnit)
durUnit := time.Minute
if match[2] == "h" {
durUnit = time.Hour
}
if match[2] == "d" {
durUnit = 24 * time.Hour
}
if match[2] == "w" {
durUnit = timeutil.Week
}
durNum, _ := strconv.ParseInt(match[1], 10, 64)
start := end.Add(-time.Duration(durNum) * durUnit)
return NewWindow(&start, &end), nil
}
// Match timestamp pairs, e.g. "1586822400,1586908800" or "1586822400-1586908800"
match = timestampPairRegex.FindStringSubmatch(window)
if match != nil {
s, _ := strconv.ParseInt(match[1], 10, 64)
e, _ := strconv.ParseInt(match[2], 10, 64)
start := time.Unix(s, 0).UTC()
end := time.Unix(e, 0).UTC()
return NewWindow(&start, &end), nil
}
// Match RFC3339 pairs, e.g. "2020-04-01T00:00:00Z,2020-04-03T00:00:00Z"
match = rfcRegex.FindStringSubmatch(window)
if match != nil {
start, _ := time.Parse(time.RFC3339, match[1])
end, _ := time.Parse(time.RFC3339, match[2])
return NewWindow(&start, &end), nil
}
return Window{nil, nil}, fmt.Errorf("illegal window: %s", window)
}
// ApproximatelyEqual returns true if the start and end times of the two windows,
// respectively, are within the given threshold of each other.
func (w Window) ApproximatelyEqual(that Window, threshold time.Duration) bool {
return approxEqual(w.start, that.start, threshold) && approxEqual(w.end, that.end, threshold)
}
func approxEqual(x *time.Time, y *time.Time, threshold time.Duration) bool {
// both times are nil, so they are equal
if x == nil && y == nil {
return true
}
// one time is nil, but the other is not, so they are not equal
if x == nil || y == nil {
return false
}
// neither time is nil, so they are approximately close if their times are
// within the given threshold
delta := math.Abs((*x).Sub(*y).Seconds())
return delta < threshold.Seconds()
}
func (w Window) Clone() Window {
var start, end *time.Time
var s, e time.Time
if w.start != nil {
s = *w.start
start = &s
}
if w.end != nil {
e = *w.end
end = &e
}
return NewWindow(start, end)
}
func (w Window) Contains(t time.Time) bool {
if w.start != nil && t.Before(*w.start) {
return false
}
if w.end != nil && t.After(*w.end) {
return false
}
return true
}
func (w Window) ContainsWindow(that Window) bool {
// only support containing closed windows for now
// could check if openness is compatible with closure
if that.IsOpen() {
return false
}
return w.Contains(*that.start) && w.Contains(*that.end)
}
func (w Window) Duration() time.Duration {
if w.IsOpen() {
// TODO test
return time.Duration(math.Inf(1.0))
}
return w.end.Sub(*w.start)
}
func (w Window) End() *time.Time {
return w.end
}
func (w Window) Equal(that Window) bool {
if w.start != nil && that.start != nil && !w.start.Equal(*that.start) {
// starts are not nil, but not equal
return false
}
if w.end != nil && that.end != nil && !w.end.Equal(*that.end) {
// ends are not nil, but not equal
return false
}
if (w.start == nil && that.start != nil) || (w.start != nil && that.start == nil) {
// one start is nil, the other is not
return false
}
if (w.end == nil && that.end != nil) || (w.end != nil && that.end == nil) {
// one end is nil, the other is not
return false
}
// either both starts are nil, or they match; likewise for the ends
return true
}
func (w Window) ExpandStart(start time.Time) Window {
if w.start == nil || start.Before(*w.start) {
w.start = &start
}
return w
}
func (w Window) ExpandEnd(end time.Time) Window {
if w.end == nil || end.After(*w.end) {
w.end = &end
}
return w
}
func (w Window) Expand(that Window) Window {
if that.start == nil {
w.start = nil
} else {
w = w.ExpandStart(*that.start)
}
if that.end == nil {
w.end = nil
} else {
w = w.ExpandEnd(*that.end)
}
return w
}
func (w Window) ContractStart(start time.Time) Window {
if w.start == nil || start.After(*w.start) {
w.start = &start
}
return w
}
func (w Window) ContractEnd(end time.Time) Window {
if w.end == nil || end.Before(*w.end) {
w.end = &end
}
return w
}
func (w Window) Contract(that Window) Window {
if that.start != nil {
w = w.ContractStart(*that.start)
}
if that.end != nil {
w = w.ContractEnd(*that.end)
}
return w
}
func (w Window) Hours() float64 {
if w.IsOpen() {
return math.Inf(1)
}
return w.end.Sub(*w.start).Hours()
}
// IsEmpty a Window is empty if it does not have a start and an end
func (w Window) IsEmpty() bool {
return w.start == nil && w.end == nil
}
// HasDuration a Window has duration if neither start and end are not nil and not equal
func (w Window) HasDuration() bool {
return !w.IsOpen() && !w.end.Equal(*w.Start())
}
// IsNegative a Window is negative if start and end are not null and end is before start
func (w Window) IsNegative() bool {
return !w.IsOpen() && w.end.Before(*w.Start())
}
// IsOpen a Window is open if it has a nil start or end
func (w Window) IsOpen() bool {
return w.start == nil || w.end == nil
}
func (w Window) MarshalJSON() ([]byte, error) {
buffer := bytes.NewBufferString("{")
if w.start != nil {
buffer.WriteString(fmt.Sprintf("\"start\":\"%s\",", w.start.Format(time.RFC3339)))
} else {
buffer.WriteString(fmt.Sprintf("\"start\":\"%s\",", "null"))
}
if w.end != nil {
buffer.WriteString(fmt.Sprintf("\"end\":\"%s\"", w.end.Format(time.RFC3339)))
} else {
buffer.WriteString(fmt.Sprintf("\"end\":\"%s\"", "null"))
}
buffer.WriteString("}")
return buffer.Bytes(), nil
}
func (w *Window) UnmarshalJSON(bs []byte) error {
// Due to the behavior of our custom MarshalJSON, we unmarshal as strings
// and then manually handle the weird quoted "null" case.
type PubWindow struct {
Start string `json:"start"`
End string `json:"end"`
}
var pw PubWindow
err := json.Unmarshal(bs, &pw)
if err != nil {
return fmt.Errorf("half unmarshal: %w", err)
}
var start *time.Time
var end *time.Time
if pw.Start != "null" {
t, err := time.Parse(time.RFC3339, pw.Start)
if err != nil {
return fmt.Errorf("parsing start as RFC3339: %w", err)
}
start = &t
}
if pw.End != "null" {
t, err := time.Parse(time.RFC3339, pw.End)
if err != nil {
return fmt.Errorf("parsing end as RFC3339: %w", err)
}
end = &t
}
w.start = start
w.end = end
return nil
}
func (w Window) Minutes() float64 {
if w.IsOpen() {
return math.Inf(1)
}
return w.end.Sub(*w.start).Minutes()
}
// Overlaps returns true iff the two given Windows share an amount of temporal
// coverage.
// TODO complete (with unit tests!) and then implement in AllocationSet.accumulate
// TODO:CLEANUP
// func (w Window) Overlaps(x Window) bool {
// if (w.start == nil && w.end == nil) || (x.start == nil && x.end == nil) {
// // one window is completely open, so overlap is guaranteed
// // <---------->
// // ?------?
// return true
// }
// // Neither window is completely open (nil, nil), but one or the other might
// // still be future- or past-open.
// if w.start == nil {
// // w is past-open, future-closed
// // <------]
// if x.start != nil && !x.start.Before(*w.end) {
// // x starts after w ends (or eq)
// // <------]
// // [------?
// return false
// }
// // <-----]
// // ?-----?
// return true
// }
// if w.end == nil {
// // w is future-open, past-closed
// // [------>
// if x.end != nil && !x.end.After(*w.end) {
// // x ends before w begins (or eq)
// // [------>
// // ?------]
// return false
// }
// // [------>
// // ?------?
// return true
// }
// // Now we know w is closed, but we don't know about x
// // [------]
// // ?------?
// if x.start == nil {
// // TODO
// }
// if x.end == nil {
// // TODO
// }
// // Both are closed.
// if !x.start.Before(*w.end) && !x.end.Before(*w.end) {
// // x starts and ends after w ends
// // [------]
// // [------]
// return false
// }
// if !x.start.After(*w.start) && !x.end.After(*w.start) {
// // x starts and ends before w starts
// // [------]
// // [------]
// return false
// }
// // w and x must overlap
// // [------]
// // [------]
// return true
// }
func (w *Window) Set(start, end *time.Time) {
w.start = start
w.end = end
}
// Shift adds the given duration to both the start and end times of the window
func (w Window) Shift(dur time.Duration) Window {
if w.start != nil {
s := w.start.Add(dur)
w.start = &s
}
if w.end != nil {
e := w.end.Add(dur)
w.end = &e
}
return w
}
func (w Window) Start() *time.Time {
return w.start
}
func (w Window) String() string {
if w.start == nil && w.end == nil {
return "[nil, nil)"
}
if w.start == nil {
return fmt.Sprintf("[nil, %s)", w.end.Format("2006-01-02T15:04:05-0700"))
}
if w.end == nil {
return fmt.Sprintf("[%s, nil)", w.start.Format("2006-01-02T15:04:05-0700"))
}
return fmt.Sprintf("[%s, %s)", w.start.Format("2006-01-02T15:04:05-0700"), w.end.Format("2006-01-02T15:04:05-0700"))
}
// DurationOffset returns durations representing the duration and offset of the
// given window
func (w Window) DurationOffset() (time.Duration, time.Duration, error) {
if w.IsOpen() || w.IsNegative() {
return 0, 0, fmt.Errorf("illegal window: %s", w)
}
duration := w.Duration()
offset := time.Since(*w.End())
return duration, offset, nil
}
// DurationOffsetForPrometheus returns strings representing durations for the
// duration and offset of the given window, factoring in the Thanos offset if
// necessary. Whereas duration is a simple duration string (e.g. "1d"), the
// offset includes the word "offset" (e.g. " offset 2d") so that the values
// returned can be used directly in the formatting string "some_metric[%s]%s"
// to generate the query "some_metric[1d] offset 2d".
func (w Window) DurationOffsetForPrometheus() (string, string, error) {
duration, offset, err := w.DurationOffset()
if err != nil {
return "", "", err
}
// If using Thanos, increase offset to 3 hours, reducing the duration by
// equal measure to maintain the same starting point.
// TODO: This logic should technically be decoupled from this type, but
// TODO: current use cases are unclear. To ensure we do not break existing
// TODO: (or legacy) use-cases, temporarily support this one-off logic.
thanosDur := thanosOffset()
if offset < thanosDur && isThanosEnabled() {
diff := thanosDur - offset
offset += diff
duration -= diff
}
// If duration < 0, return an error
if duration < 0 {
return "", "", fmt.Errorf("negative duration: %s", duration)
}
// Negative offset means that the end time is in the future. Prometheus
// fails for non-positive offset values, so shrink the duration and
// remove the offset altogether.
if offset < 0 {
duration = duration + offset
offset = 0
}
durStr, offStr := timeutil.DurationOffsetStrings(duration, offset)
if offset < time.Minute {
offStr = ""
} else {
offStr = " offset " + offStr
}
return durStr, offStr, nil
}
// DurationOffsetStrings returns formatted, Prometheus-compatible strings representing
// the duration and offset of the window in terms of days, hours, minutes, or seconds;
// e.g. ("7d", "1441m", "30m", "1s", "")
func (w Window) DurationOffsetStrings() (string, string) {
dur, off, err := w.DurationOffset()
if err != nil {
return "", ""
}
return timeutil.DurationOffsetStrings(dur, off)
}
// GetPercentInWindow Determine pct of item time contained the window.
// determined by the overlap of the start/end with the given
// window, which will be negative if there is no overlap. If
// there is positive overlap, compare it with the total mins.
//
// e.g. here are the two possible scenarios as simplidied
// 10m windows with dashes representing item's time running:
//
// 1. item falls entirely within one CloudCostSet window
// | ---- | | |
// totalMins = 4.0
// pct := 4.0 / 4.0 = 1.0 for window 1
// pct := 0.0 / 4.0 = 0.0 for window 2
// pct := 0.0 / 4.0 = 0.0 for window 3
//
// 2. item overlaps multiple CloudCostSet windows
// | ----|----------|-- |
// totalMins = 16.0
// pct := 4.0 / 16.0 = 0.250 for window 1
// pct := 10.0 / 16.0 = 0.625 for window 2
// pct := 2.0 / 16.0 = 0.125 for window 3
func (w Window) GetPercentInWindow(that Window) float64 {
if that.IsOpen() {
log.Errorf("Window: GetPercentInWindow: invalid window %s", that.String())
return 0
}
s := *that.Start()
if s.Before(*w.Start()) {
s = *w.Start()
}
e := *that.End()
if e.After(*w.End()) {
e = *w.End()
}
mins := e.Sub(s).Minutes()
if mins <= 0.0 {
return 0.0
}
totalMins := that.Duration().Minutes()
pct := mins / totalMins
return pct
}
// GetAccumulateWindow rounds the start and end of the window to the given accumulation option
func (w Window) GetAccumulateWindow(accumOpt AccumulateOption) (Window, error) {
if w.IsOpen() {
return w, fmt.Errorf("could not get accumlate window for open window")
}
switch accumOpt {
case AccumulateOptionAll:
// just return the entire window
return w.Clone(), nil
case AccumulateOptionHour:
return w.getHourlyWindow(), nil
case AccumulateOptionDay:
return w.getDailyWindow(), nil
case AccumulateOptionWeek:
return w.getWeeklyWindow(), nil
case AccumulateOptionMonth:
return w.getMonthlyWindow(), nil
case AccumulateOptionQuarter:
return w.getQuarterlyWindow(), nil
case AccumulateOptionNone:
// the default behavior of the app currently is to return the highest resolution steps
// possible
fallthrough
default:
// if we are here, it means someone wants a window older than what we can query for
return w, fmt.Errorf("cannot round window to given accumulation option %s", string(accumOpt))
}
}
// GetAccumulateWindows breaks provided window into a []Window with each window having the resolution of the provided AccumulateOption
func (w Window) GetAccumulateWindows(accumOpt AccumulateOption) ([]Window, error) {
if w.IsOpen() {
return nil, fmt.Errorf("could not get accumlate window for open window")
}
switch accumOpt {
case AccumulateOptionAll:
// just return the entire window
return []Window{w.Clone()}, nil
case AccumulateOptionDay:
wins := w.getDailyWindows()
return wins, nil
case AccumulateOptionWeek:
wins := w.getWeeklyWindows()
return wins, nil
case AccumulateOptionMonth:
wins := w.getMonthlyWindows()
return wins, nil
case AccumulateOptionHour:
// our maximum resolution is hourly
wins := w.getHourlyWindows()
return wins, nil
case AccumulateOptionQuarter:
wins := w.getQuarterlyWindows()
return wins, nil
case AccumulateOptionNone:
// the default behavior of the app currently is to return the highest resolution steps
// possible
fallthrough
default:
// if we are here, it means someone wants a window older than what we can query for
return nil, fmt.Errorf("store does not have coverage window starting at %v", w.Start())
}
}
func (w Window) getHourlyWindow() Window {
origStart := w.Start()
origEnd := w.End()
// round the start and end windows to the calendar hour start and ends, respectively
roundedStart := time.Date(origStart.Year(), origStart.Month(), origStart.Day(), origStart.Hour(), 0, 0, 0, origStart.Location())
roundedEnd := time.Date(origEnd.Year(), origEnd.Month(), origEnd.Day(), origEnd.Hour()+1, 0, 0, 0, origEnd.Location())
// edge case - if user has exactly specified first instant of new hour, does not need rounding
if origEnd.Minute() == 0 && origEnd.Second() == 0 {
roundedEnd = *origEnd
}
return NewClosedWindow(roundedStart, roundedEnd)
}
// getHourlyWindows breaks up a window into hours
func (w Window) getHourlyWindows() []Window {
wins := []Window{}
roundedWindow := w.getHourlyWindow()
roundedStart := *roundedWindow.Start()
roundedEnd := *roundedWindow.End()
currStart := roundedStart
currEnd := time.Date(currStart.Year(), currStart.Month(), currStart.Day(), currStart.Hour()+1, 0, 0, 0, currStart.Location())
for currEnd.Before(roundedEnd) || currEnd.Equal(roundedEnd) {
wins = append(wins, NewClosedWindow(currStart, currEnd))
currStart = currEnd
currEnd = time.Date(currEnd.Year(), currEnd.Month(), currEnd.Day(), currEnd.Hour()+1, 0, 0, 0, currStart.Location())
}
return wins
}
func (w Window) getDailyWindow() Window {
origStart := w.Start()
origEnd := w.End()
// round the start and end windows to the calendar day start and ends, respectively
roundedStart := time.Date(origStart.Year(), origStart.Month(), origStart.Day(), 0, 0, 0, 0, origStart.Location())
roundedEnd := time.Date(origEnd.Year(), origEnd.Month(), origEnd.Day()+1, 0, 0, 0, 0, origEnd.Location())
// edge case - if user has exactly specified first instant of new day, does not need rounding
if origEnd.Minute() == 0 && origEnd.Second() == 0 && origEnd.Hour() == 0 {
roundedEnd = *origEnd
}
return NewClosedWindow(roundedStart, roundedEnd)
}
// getDailyWindows breaks up a window into days
func (w Window) getDailyWindows() []Window {
wins := []Window{}
roundedWindow := w.getDailyWindow()
roundedStart := *roundedWindow.Start()
roundedEnd := *roundedWindow.End()
currStart := roundedStart
currEnd := time.Date(currStart.Year(), currStart.Month(), currStart.Day()+1, 0, 0, 0, 0, currStart.Location())
for currEnd.Before(roundedEnd) || currEnd.Equal(roundedEnd) {
wins = append(wins, NewClosedWindow(currStart, currEnd))
currStart = currEnd
currEnd = time.Date(currEnd.Year(), currEnd.Month(), currEnd.Day()+1, 0, 0, 0, 0, currStart.Location())
}
return wins
}
func (w Window) getWeeklyWindow() Window {
origStart := w.Start()
origEnd := w.End()
// round the start and end windows to the calendar month start and ends, respectively
roundedStart := origStart.Add(-1 * time.Duration(origStart.Weekday()) * time.Hour * 24)
roundedStart = time.Date(roundedStart.Year(), roundedStart.Month(), roundedStart.Day(), 0, 0, 0, 0, origEnd.Location())
roundedEnd := origEnd.Add(time.Duration(6-origEnd.Weekday()) * time.Hour * 24)
roundedEnd = time.Date(roundedEnd.Year(), roundedEnd.Month(), roundedEnd.Day()+1, 0, 0, 0, 0, origEnd.Location())
// edge case - if user has exactly specified first instant of new day, does not need rounding
if origEnd.Weekday() == 0 && origEnd.Second() == 0 && origEnd.Hour() == 0 {
roundedEnd = *origEnd
}
return NewClosedWindow(roundedStart, roundedEnd)
}
// getWeeklyWindows breaks up a window into weeks, with weeks starting on Sunday
func (w Window) getWeeklyWindows() []Window {
wins := []Window{}