-
Notifications
You must be signed in to change notification settings - Fork 451
/
cluster.go
391 lines (338 loc) · 11.4 KB
/
cluster.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
// 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 m3
import (
"errors"
"fmt"
"io"
"sync"
"time"
"github.com/m3db/m3/src/dbnode/client"
"github.com/m3db/m3/src/query/storage/m3/storagemetadata"
xerrors "github.com/m3db/m3/src/x/errors"
"github.com/m3db/m3/src/x/ident"
)
var (
errNamespaceIDNotSet = errors.New("namespace ID not set")
errSessionNotSet = errors.New("session not set")
errRetentionNotSet = errors.New("retention not set")
errResolutionNotSet = errors.New("resolution not set")
defaultClusterNamespaceDownsampleOptions = ClusterNamespaceDownsampleOptions{
All: true,
}
)
// Clusters is a flattened collection of local storage clusters and namespaces.
type Clusters interface {
io.Closer
// ClusterNamespaces returns all known and ready cluster namespaces.
ClusterNamespaces() ClusterNamespaces
// NonReadyClusterNamespaces returns all cluster namespaces not in the ready state.
NonReadyClusterNamespaces() ClusterNamespaces
// UnaggregatedClusterNamespace returns the valid unaggregated
// cluster namespace.
UnaggregatedClusterNamespace() ClusterNamespace
// AggregatedClusterNamespace returns an aggregated cluster namespace
// at a specific retention and resolution.
AggregatedClusterNamespace(attrs RetentionResolution) (ClusterNamespace, bool)
}
// RetentionResolution is a tuple of retention and resolution that describes
// an aggregated metrics policy.
type RetentionResolution struct {
Retention time.Duration
Resolution time.Duration
}
// ClusterNamespace is a local storage cluster namespace.
type ClusterNamespace interface {
NamespaceID() ident.ID
Options() ClusterNamespaceOptions
Session() client.Session
}
// ClusterNamespaceOptions is a set of options
type ClusterNamespaceOptions struct {
// Note: Don't allow direct access, as we want to provide defaults
// and/or error if call to access a field is not relevant/correct.
attributes storagemetadata.Attributes
downsample *ClusterNamespaceDownsampleOptions
}
// Attributes returns the storage attributes of the cluster namespace.
func (o ClusterNamespaceOptions) Attributes() storagemetadata.Attributes {
return o.attributes
}
// DownsampleOptions returns the downsample options for a cluster namespace,
// which is only valid if the namespace is an aggregated cluster namespace.
func (o ClusterNamespaceOptions) DownsampleOptions() (
ClusterNamespaceDownsampleOptions,
error,
) {
if o.attributes.MetricsType != storagemetadata.AggregatedMetricsType {
return ClusterNamespaceDownsampleOptions{}, errNotAggregatedClusterNamespace
}
if o.downsample == nil {
return defaultClusterNamespaceDownsampleOptions, nil
}
return *o.downsample, nil
}
// ClusterNamespaceDownsampleOptions is the downsample options for
// a cluster namespace.
type ClusterNamespaceDownsampleOptions struct {
All bool
}
// ClusterNamespaces is a slice of ClusterNamespace instances.
type ClusterNamespaces []ClusterNamespace
// ClusterNamespacesByResolutionAsc is a slice of ClusterNamespace instances is
// sortable by resolution.
type ClusterNamespacesByResolutionAsc []ClusterNamespace
func (a ClusterNamespacesByResolutionAsc) Len() int { return len(a) }
func (a ClusterNamespacesByResolutionAsc) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a ClusterNamespacesByResolutionAsc) Less(i, j int) bool {
return a[i].Options().Attributes().Resolution < a[j].Options().Attributes().Resolution
}
// ClusterNamespacesByRetentionAsc is a slice of ClusterNamespace instances is
// sortable by retention.
type ClusterNamespacesByRetentionAsc []ClusterNamespace
func (a ClusterNamespacesByRetentionAsc) Len() int { return len(a) }
func (a ClusterNamespacesByRetentionAsc) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a ClusterNamespacesByRetentionAsc) Less(i, j int) bool {
return a[i].Options().Attributes().Retention < a[j].Options().Attributes().Retention
}
// NumAggregatedClusterNamespaces returns the number of aggregated
// cluster namespaces.
func (n ClusterNamespaces) NumAggregatedClusterNamespaces() int {
count := 0
for _, namespace := range n {
if namespace.Options().Attributes().MetricsType == storagemetadata.AggregatedMetricsType {
count++
}
}
return count
}
// UnaggregatedClusterNamespaceDefinition is the definition for the
// cluster namespace that holds unaggregated metrics data.
type UnaggregatedClusterNamespaceDefinition struct {
NamespaceID ident.ID
Session client.Session
Retention time.Duration
}
// Validate will validate the cluster namespace definition.
func (def UnaggregatedClusterNamespaceDefinition) Validate() error {
if def.NamespaceID == nil || len(def.NamespaceID.String()) == 0 {
return errNamespaceIDNotSet
}
if def.Session == nil {
return errSessionNotSet
}
if def.Retention <= 0 {
return errRetentionNotSet
}
return nil
}
// AggregatedClusterNamespaceDefinition is a definition for a
// cluster namespace that holds aggregated metrics data at a
// specific retention and resolution.
type AggregatedClusterNamespaceDefinition struct {
NamespaceID ident.ID
Session client.Session
Retention time.Duration
Resolution time.Duration
Downsample *ClusterNamespaceDownsampleOptions
}
// Validate validates the cluster namespace definition.
func (def AggregatedClusterNamespaceDefinition) Validate() error {
if def.NamespaceID == nil || len(def.NamespaceID.String()) == 0 {
return errNamespaceIDNotSet
}
if def.Session == nil {
return errSessionNotSet
}
if def.Retention <= 0 {
return errRetentionNotSet
}
if def.Resolution <= 0 {
return errResolutionNotSet
}
return nil
}
type clusters struct {
namespaces []ClusterNamespace
unaggregatedNamespace ClusterNamespace
aggregatedNamespaces map[RetentionResolution]ClusterNamespace
}
// NewClusters instantiates a new Clusters instance.
func NewClusters(
unaggregatedClusterNamespace UnaggregatedClusterNamespaceDefinition,
aggregatedClusterNamespaces ...AggregatedClusterNamespaceDefinition,
) (Clusters, error) {
expectedAggregated := len(aggregatedClusterNamespaces)
expectedAll := 1 + expectedAggregated
namespaces := make(ClusterNamespaces, 0, expectedAll)
aggregatedNamespaces := make(map[RetentionResolution]ClusterNamespace,
expectedAggregated)
def := unaggregatedClusterNamespace
unaggregatedNamespace, err := newUnaggregatedClusterNamespace(def)
if err != nil {
return nil, err
}
namespaces = append(namespaces, unaggregatedNamespace)
for _, def := range aggregatedClusterNamespaces {
namespace, err := newAggregatedClusterNamespace(def)
if err != nil {
return nil, err
}
namespaces = append(namespaces, namespace)
key := RetentionResolution{
Retention: namespace.Options().Attributes().Retention,
Resolution: namespace.Options().Attributes().Resolution,
}
_, exists := aggregatedNamespaces[key]
if exists {
return nil, fmt.Errorf("duplicate aggregated namespace exists for: "+
"retention=%s, resolution=%s",
key.Retention.String(), key.Resolution.String())
}
aggregatedNamespaces[key] = namespace
}
return &clusters{
namespaces: namespaces,
unaggregatedNamespace: unaggregatedNamespace,
aggregatedNamespaces: aggregatedNamespaces,
}, nil
}
func (c *clusters) ClusterNamespaces() ClusterNamespaces {
return c.namespaces
}
func (c *clusters) NonReadyClusterNamespaces() ClusterNamespaces {
// statically configured cluster namespaces are always considered ready.
return nil
}
func (c *clusters) UnaggregatedClusterNamespace() ClusterNamespace {
return c.unaggregatedNamespace
}
func (c *clusters) AggregatedClusterNamespace(
attrs RetentionResolution,
) (ClusterNamespace, bool) {
namespace, ok := c.aggregatedNamespaces[attrs]
return namespace, ok
}
func (c *clusters) Close() error {
var (
wg sync.WaitGroup
syncMultiErrs syncMultiErrs
uniqueSessions []client.Session
)
// Collect unique sessions, some namespaces may share same
// client session (same cluster)
uniqueSessions = append(uniqueSessions, c.unaggregatedNamespace.Session())
for _, namespace := range c.aggregatedNamespaces {
unique := true
for _, session := range uniqueSessions {
if namespace.Session() == session {
unique = false
break
}
}
if unique {
uniqueSessions = append(uniqueSessions, namespace.Session())
}
}
for _, session := range uniqueSessions {
session := session // Capture for lambda
wg.Add(1)
go func() {
defer wg.Done()
err := session.Close()
syncMultiErrs.add(err)
}()
}
wg.Wait()
return syncMultiErrs.lastError()
}
type clusterNamespace struct {
namespaceID ident.ID
options ClusterNamespaceOptions
session client.Session
}
func newUnaggregatedClusterNamespace(
def UnaggregatedClusterNamespaceDefinition,
) (ClusterNamespace, error) {
if err := def.Validate(); err != nil {
return nil, err
}
ns := def.NamespaceID
// Set namespace to NoFinalize to avoid cloning it in write operations
ns.NoFinalize()
return &clusterNamespace{
namespaceID: ns,
options: ClusterNamespaceOptions{
attributes: storagemetadata.Attributes{
MetricsType: storagemetadata.UnaggregatedMetricsType,
Retention: def.Retention,
},
},
session: def.Session,
}, nil
}
func newAggregatedClusterNamespace(
def AggregatedClusterNamespaceDefinition,
) (ClusterNamespace, error) {
if err := def.Validate(); err != nil {
return nil, err
}
ns := def.NamespaceID
// Set namespace to NoFinalize to avoid cloning it in write operations
ns.NoFinalize()
return &clusterNamespace{
namespaceID: ns,
options: ClusterNamespaceOptions{
attributes: storagemetadata.Attributes{
MetricsType: storagemetadata.AggregatedMetricsType,
Retention: def.Retention,
Resolution: def.Resolution,
},
downsample: def.Downsample,
},
session: def.Session,
}, nil
}
func (n *clusterNamespace) NamespaceID() ident.ID {
return n.namespaceID
}
func (n *clusterNamespace) Options() ClusterNamespaceOptions {
return n.options
}
func (n *clusterNamespace) Session() client.Session {
return n.session
}
type syncMultiErrs struct {
sync.Mutex
multiErr xerrors.MultiError
}
func (errs *syncMultiErrs) add(err error) {
errs.Lock()
errs.multiErr = errs.multiErr.Add(err)
errs.Unlock()
}
func (errs *syncMultiErrs) lastError() error {
errs.Lock()
defer errs.Unlock()
// TODO: consider taking a debug param when building a syncMultiErrs
// which would determine wether to return only the last error message
// or the consolidated list of errors.
return errs.multiErr.LastError()
}