/
record.go
185 lines (153 loc) · 4.62 KB
/
record.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
package metricsutil
import (
"time"
"github.com/milvus-io/milvus/pkg/util/timerecord"
)
var (
_ labeledRecord = QuerySegmentAccessRecord{}
_ labeledRecord = SearchSegmentAccessRecord{}
_ labeledRecord = &CacheLoadRecord{}
_ labeledRecord = &CacheEvictRecord{}
)
// SegmentLabel is the label of a segment.
type SegmentLabel struct {
DatabaseName string `expr:"DatabaseName"`
ResourceGroup string `expr:"ResourceGroup"`
}
// CacheLoadRecord records the metrics of a cache load.
type CacheLoadRecord struct {
numBytes uint64
baseRecord
}
// NewCacheLoadRecord creates a new CacheLoadRecord.
func NewCacheLoadRecord(label SegmentLabel) *CacheLoadRecord {
return &CacheLoadRecord{
baseRecord: newBaseRecord(label),
}
}
// WithBytes sets the bytes of the record.
func (r *CacheLoadRecord) WithBytes(bytes uint64) *CacheLoadRecord {
r.numBytes = bytes
return r
}
// getBytes returns the bytes of the record.
func (r *CacheLoadRecord) getBytes() float64 {
return float64(r.numBytes)
}
// Finish finishes the record.
func (r *CacheLoadRecord) Finish(err error) {
r.baseRecord.finish(err)
getGlobalObserver().Observe(r)
}
type CacheEvictRecord struct {
bytes uint64
baseRecord
}
// NewCacheEvictRecord creates a new CacheEvictRecord.
func NewCacheEvictRecord(label SegmentLabel) *CacheEvictRecord {
return &CacheEvictRecord{
baseRecord: newBaseRecord(label),
}
}
// WithBytes sets the bytes of the record.
func (r *CacheEvictRecord) WithBytes(bytes uint64) *CacheEvictRecord {
r.bytes = bytes
return r
}
// getBytes returns the bytes of the record.
func (r *CacheEvictRecord) getBytes() float64 {
return float64(r.bytes)
}
// Finish finishes the record.
func (r *CacheEvictRecord) Finish(err error) {
r.baseRecord.finish(err)
getGlobalObserver().Observe(r)
}
// NewQuerySegmentAccessRecord creates a new QuerySegmentMetricRecorder.
func NewQuerySegmentAccessRecord(label SegmentLabel) QuerySegmentAccessRecord {
return QuerySegmentAccessRecord{
segmentAccessRecord: newSegmentAccessRecord(label),
}
}
// NewSearchSegmentAccessRecord creates a new SearchSegmentMetricRecorder.
func NewSearchSegmentAccessRecord(label SegmentLabel) SearchSegmentAccessRecord {
return SearchSegmentAccessRecord{
segmentAccessRecord: newSegmentAccessRecord(label),
}
}
// QuerySegmentAccessRecord records the metrics of a query segment.
type QuerySegmentAccessRecord struct {
*segmentAccessRecord
}
func (r QuerySegmentAccessRecord) Finish(err error) {
r.finish(err)
getGlobalObserver().Observe(r)
}
// SearchSegmentAccessRecord records the metrics of a search segment.
type SearchSegmentAccessRecord struct {
*segmentAccessRecord
}
func (r SearchSegmentAccessRecord) Finish(err error) {
r.finish(err)
getGlobalObserver().Observe(r)
}
// segmentAccessRecord records the metrics of the segment.
type segmentAccessRecord struct {
isCacheMiss bool // whether the access is a cache miss.
waitLoadCost time.Duration // time cost of waiting for loading data.
baseRecord
}
// newSegmentAccessRecord creates a new accessMetricRecorder.
func newSegmentAccessRecord(label SegmentLabel) *segmentAccessRecord {
return &segmentAccessRecord{
baseRecord: newBaseRecord(label),
}
}
// CacheMissing records the cache missing.
func (r *segmentAccessRecord) CacheMissing() {
r.isCacheMiss = true
r.waitLoadCost = r.timeRecorder.RecordSpan()
}
// getWaitLoadMilliseconds returns the wait load seconds of the recorder.
func (r *segmentAccessRecord) getWaitLoadMilliseconds() float64 {
return r.waitLoadCost.Seconds() * 1000
}
// getWaitLoadDuration returns the wait load duration of the recorder.
func (r *segmentAccessRecord) getWaitLoadDuration() time.Duration {
return r.waitLoadCost
}
// newBaseRecord returns a new baseRecord.
func newBaseRecord(label SegmentLabel) baseRecord {
return baseRecord{
label: label,
timeRecorder: timerecord.NewTimeRecorder(""),
}
}
// baseRecord records the metrics of the segment.
type baseRecord struct {
label SegmentLabel
duration time.Duration
err error
timeRecorder *timerecord.TimeRecorder
}
// Label returns the label of the recorder.
func (r *baseRecord) Label() SegmentLabel {
return r.label
}
// getError returns the error of the recorder.
func (r *baseRecord) getError() error {
return r.err
}
// getDuration returns the duration of the recorder.
func (r *baseRecord) getDuration() time.Duration {
return r.duration
}
// getMilliseconds returns the duration of the recorder in seconds.
func (r *baseRecord) getMilliseconds() float64 {
return r.duration.Seconds() * 1000
}
// finish finishes the record.
func (r *baseRecord) finish(err error) {
r.err = err
r.duration = r.timeRecorder.ElapseSpan()
}