-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
184 lines (147 loc) · 5.51 KB
/
types.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
// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package generate
import (
"os"
"time"
"github.com/m3db/m3/src/dbnode/clock"
"github.com/m3db/m3/src/dbnode/encoding"
ns "github.com/m3db/m3/src/dbnode/namespace"
"github.com/m3db/m3/src/dbnode/sharding"
"github.com/m3db/m3/src/dbnode/ts"
"github.com/m3db/m3/src/x/ident"
xtime "github.com/m3db/m3/src/x/time"
)
// AnnotationGenerator generates the next annotation.
type AnnotationGenerator interface {
Next() []byte
}
// BlockConfig represents the configuration to generate a SeriesBlock.
type BlockConfig struct {
IDs []string
Tags ident.Tags
NumPoints int
Start time.Time
AnnGen AnnotationGenerator
}
// UpdateBlockConfig is a function used o update BlockConfigs.
type UpdateBlockConfig func([]BlockConfig)
// TestValue is a test datapoint and an annotation.
type TestValue struct {
ts.Datapoint
ts.Annotation
}
// Series represents a generated series of data.
type Series struct {
ID ident.ID
Tags ident.Tags
Data []TestValue
}
// SeriesDataPoint represents a single data point of a generated series of data.
type SeriesDataPoint struct {
Value TestValue
ID ident.ID
}
// SeriesDataPointsByTime are a sorted list of SeriesDataPoints.
type SeriesDataPointsByTime []SeriesDataPoint
// SeriesBlock is a collection of Series.
type SeriesBlock []Series
// SeriesBlocksByStart is a map of time -> SeriesBlock.
type SeriesBlocksByStart map[xtime.UnixNano]SeriesBlock
// Writer writes generated data to disk.
type Writer interface {
// WriteData writes the data as data files.
WriteData(
nsCtx ns.Context,
shards sharding.ShardSet,
data SeriesBlocksByStart,
volume int,
) error
// WriteSnapshot writes the data as snapshot files.
WriteSnapshot(
nsCtx ns.Context,
shards sharding.ShardSet,
data SeriesBlocksByStart,
volume int,
snapshotInterval time.Duration,
) error
// WriteDataWithPredicate writes all data that passes the predicate test as data files.
WriteDataWithPredicate(
nsCtx ns.Context,
shards sharding.ShardSet,
data SeriesBlocksByStart,
volume int,
pred WriteDatapointPredicate,
) error
// WriteSnapshotWithPredicate writes all data that passes the predicate test as snapshot files.
WriteSnapshotWithPredicate(
nsCtx ns.Context,
shards sharding.ShardSet,
data SeriesBlocksByStart,
volume int,
pred WriteDatapointPredicate,
snapshotInterval time.Duration,
) error
}
// Options represent the parameters needed for the Writer.
type Options interface {
// SetClockOptions sets the clock options.
SetClockOptions(value clock.Options) Options
// ClockOptions returns the clock options.
ClockOptions() clock.Options
// SetRetentionPeriod sets how long we intend to keep data in memory.
SetRetentionPeriod(value time.Duration) Options
// RetentionPeriod returns how long we intend to keep data in memory.
RetentionPeriod() time.Duration
// SetBlockSize sets the blockSize.
SetBlockSize(value time.Duration) Options
// BlockSize returns the blockSize.
BlockSize() time.Duration
// SetFilePathPrefix sets the file path prefix for sharded TSDB files.
SetFilePathPrefix(value string) Options
// FilePathPrefix returns the file path prefix for sharded TSDB files.
FilePathPrefix() string
// SetNewFileMode sets the new file mode.
SetNewFileMode(value os.FileMode) Options
// NewFileMode returns the new file mode.
NewFileMode() os.FileMode
// SetNewDirectoryMode sets the new directory mode.
SetNewDirectoryMode(value os.FileMode) Options
// NewDirectoryMode returns the new directory mode.
NewDirectoryMode() os.FileMode
// SetWriterBufferSize sets the buffer size for writing TSDB files.
SetWriterBufferSize(value int) Options
// WriterBufferSize returns the buffer size for writing TSDB files.
WriterBufferSize() int
// SetWriteEmptyShards sets whether writes are done even for empty start periods.
SetWriteEmptyShards(bool) Options
// WriteEmptyShards returns whether writes are done even for empty start periods.
WriteEmptyShards() bool
// SetWriteSnapshot sets whether writes are written as snapshot files.
SetWriteSnapshot(bool) Options
// WriteSnapshots returns whether writes are written as snapshot files.
WriteSnapshot() bool
// SetEncoderPool sets the contextPool.
SetEncoderPool(value encoding.EncoderPool) Options
// EncoderPool returns the contextPool.
EncoderPool() encoding.EncoderPool
}
// WriteDatapointPredicate returns a boolean indicating whether a datapoint should be written.
type WriteDatapointPredicate func(dp TestValue) bool