forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
/
context.go
340 lines (299 loc) · 12.2 KB
/
context.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
// Copyright 2015 The Cockroach Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
//
// Author: Daniel Theophanes (kardianos@gmail.com)
package server
import (
"fmt"
"io/ioutil"
"math"
"runtime"
"strconv"
"strings"
"time"
"github.com/dustin/go-humanize"
"github.com/elastic/gosigar"
"github.com/cockroachdb/cockroach/base"
"github.com/cockroachdb/cockroach/gossip/resolver"
"github.com/cockroachdb/cockroach/roachpb"
"github.com/cockroachdb/cockroach/storage/engine"
"github.com/cockroachdb/cockroach/util/envutil"
"github.com/cockroachdb/cockroach/util/humanizeutil"
"github.com/cockroachdb/cockroach/util/log"
"github.com/cockroachdb/cockroach/util/stop"
)
// Context defaults.
const (
defaultCGroupMemPath = "/sys/fs/cgroup/memory/memory.limit_in_bytes"
defaultMaxOffset = 250 * time.Millisecond
defaultCacheSize = 512 << 20 // 512 MB
// defaultMemtableBudget controls how much memory can be used for memory
// tables. The way we initialize RocksDB, 150% (24 MB) of this setting can be
// used for memory tables and each memory table will be 25% of the size (4
// MB). This corresponds to the default RocksDB memtable size. Note that
// larger values do not necessarily improve performance, so benchmark any
// changes to this value.
defaultMemtableBudget = 16 << 20 // 16 MB
defaultScanInterval = 10 * time.Minute
defaultConsistencyCheckInterval = 24 * time.Hour
defaultScanMaxIdleTime = 5 * time.Second
defaultMetricsSampleInterval = 10 * time.Second
defaultTimeUntilStoreDead = 5 * time.Minute
defaultStorePath = "cockroach-data"
defaultReservationsEnabled = true
)
// Context holds parameters needed to setup a server.
type Context struct {
// Embed the base context.
*base.Context
// Unix socket: for postgres only.
SocketFile string
// Stores is specified to enable durable key-value storage.
Stores StoreSpecList
// Attrs specifies a colon-separated list of node topography or machine
// capabilities, used to match capabilities or location preferences specified
// in zone configs.
Attrs string
// JoinUsing is a comma-separated list of node addresses that
// act as bootstrap hosts for connecting to the gossip network.
JoinUsing string
// CacheSize is the amount of memory in bytes to use for caching data.
// The value is split evenly between the stores if there are more than one.
CacheSize int64
// MemtableBudget is the amount of memory, per store, in bytes to use for
// the memory table.
// This value is no longer settable by the end user.
MemtableBudget int64
// Parsed values.
// Engines is the storage instances specified by Stores.
Engines []engine.Engine
// NodeAttributes is the parsed representation of Attrs.
NodeAttributes roachpb.Attributes
// GossipBootstrapResolvers is a list of gossip resolvers used
// to find bootstrap nodes for connecting to the gossip network.
GossipBootstrapResolvers []resolver.Resolver
// The following values can only be set via environment variables and are
// for testing only. They are not meant to be set by the end user.
// Enables linearizable behaviour of operations on this node by making sure
// that no commit timestamp is reported back to the client until all other
// node clocks have necessarily passed it.
// Environment Variable: COCKROACH_LINEARIZABLE
Linearizable bool
// Maximum clock offset for the cluster.
// Environment Variable: COCKROACH_MAX_OFFSET
MaxOffset time.Duration
// RaftTickInterval is the resolution of the Raft timer.
RaftTickInterval time.Duration
// MetricsSamplePeriod determines the time between records of
// server internal metrics.
// Environment Variable: COCKROACH_METRICS_SAMPLE_INTERVAL
MetricsSampleInterval time.Duration
// ScanInterval determines a duration during which each range should be
// visited approximately once by the range scanner.
// Environment Variable: COCKROACH_SCAN_INTERVAL
ScanInterval time.Duration
// ScanMaxIdleTime is the maximum time the scanner will be idle between ranges.
// If enabled (> 0), the scanner may complete in less than ScanInterval for small
// stores.
// Environment Variable: COCKROACH_SCAN_MAX_IDLE_TIME
ScanMaxIdleTime time.Duration
// ConsistencyCheckInterval determines the time between range consistency checks.
// Environment Variable: COCKROACH_CONSISTENCY_CHECK_INTERVAL
ConsistencyCheckInterval time.Duration
// ConsistencyCheckPanicOnFailure causes the node to panic when it detects a
// replication consistency check failure.
ConsistencyCheckPanicOnFailure bool
// TimeUntilStoreDead is the time after which if there is no new gossiped
// information about a store, it is considered dead.
// Environment Variable: COCKROACH_TIME_UNTIL_STORE_DEAD
TimeUntilStoreDead time.Duration
// ReservationsEnabled is a switch used to enable the add replica
// reservation system.
ReservationsEnabled bool
// TestingKnobs is used for internal test controls only.
TestingKnobs base.TestingKnobs
}
// GetTotalMemory returns either the total system memory or if possible the
// cgroups available memory.
func GetTotalMemory() (int64, error) {
mem := gosigar.Mem{}
if err := mem.Get(); err != nil {
return 0, err
}
if mem.Total > math.MaxInt64 {
return 0, fmt.Errorf("inferred memory size %s exceeds maximum supported memory size %s",
humanize.IBytes(mem.Total), humanize.Bytes(math.MaxInt64))
}
totalMem := int64(mem.Total)
if runtime.GOOS == "linux" {
var err error
var buf []byte
if buf, err = ioutil.ReadFile(defaultCGroupMemPath); err != nil {
if log.V(1) {
log.Infof("can't read available memory from cgroups (%s), using system memory %s instead", err,
humanizeutil.IBytes(totalMem))
}
return totalMem, nil
}
var cgAvlMem uint64
if cgAvlMem, err = strconv.ParseUint(strings.TrimSpace(string(buf)), 10, 64); err != nil {
if log.V(1) {
log.Infof("can't parse available memory from cgroups (%s), using system memory %s instead", err,
humanizeutil.IBytes(totalMem))
}
return totalMem, nil
}
if cgAvlMem > math.MaxInt64 {
if log.V(1) {
log.Infof("available memory from cgroups is too large and unsupported %s using system memory %s instead",
humanize.IBytes(cgAvlMem), humanizeutil.IBytes(totalMem))
}
return totalMem, nil
}
if cgAvlMem > mem.Total {
if log.V(1) {
log.Infof("available memory from cgroups %s exceeds system memory %s, using system memory",
humanize.IBytes(cgAvlMem), humanizeutil.IBytes(totalMem))
}
return totalMem, nil
}
return int64(cgAvlMem), nil
}
return totalMem, nil
}
// MakeContext returns a Context with default values.
func MakeContext() Context {
ctx := Context{
Context: new(base.Context),
MaxOffset: defaultMaxOffset,
CacheSize: defaultCacheSize,
MemtableBudget: defaultMemtableBudget,
ScanInterval: defaultScanInterval,
ScanMaxIdleTime: defaultScanMaxIdleTime,
ConsistencyCheckInterval: defaultConsistencyCheckInterval,
MetricsSampleInterval: defaultMetricsSampleInterval,
TimeUntilStoreDead: defaultTimeUntilStoreDead,
ReservationsEnabled: defaultReservationsEnabled,
Stores: StoreSpecList{
Specs: []StoreSpec{{Path: defaultStorePath}},
},
}
ctx.Context.InitDefaults()
return ctx
}
// InitStores initializes ctx.Engines based on ctx.Stores.
func (ctx *Context) InitStores(stopper *stop.Stopper) error {
// TODO(peter): The comments and docs say that CacheSize and MemtableBudget
// are split evenly if there are multiple stores, but we aren't doing that
// currently. See #4979 and #4980.
for _, spec := range ctx.Stores.Specs {
var sizeInBytes = spec.SizeInBytes
if spec.InMemory {
if spec.SizePercent > 0 {
sysMem, err := GetTotalMemory()
if err != nil {
return fmt.Errorf("could not retrieve system memory")
}
sizeInBytes = int64(float64(sysMem) * spec.SizePercent / 100)
}
if sizeInBytes != 0 && sizeInBytes < minimumStoreSize {
return fmt.Errorf("%f%% of memory is only %s bytes, which is below the minimum requirement of %s",
spec.SizePercent, humanizeutil.IBytes(sizeInBytes), humanizeutil.IBytes(minimumStoreSize))
}
ctx.Engines = append(ctx.Engines, engine.NewInMem(spec.Attributes, sizeInBytes, stopper))
} else {
if spec.SizePercent > 0 {
fileSystemUsage := gosigar.FileSystemUsage{}
if err := fileSystemUsage.Get(spec.Path); err != nil {
return err
}
sizeInBytes = int64(float64(fileSystemUsage.Total) * spec.SizePercent / 100)
}
if sizeInBytes != 0 && sizeInBytes < minimumStoreSize {
return fmt.Errorf("%f%% of %s's total free space is only %s bytes, which is below the minimum requirement of %s",
spec.SizePercent, spec.Path, humanizeutil.IBytes(sizeInBytes), humanizeutil.IBytes(minimumStoreSize))
}
ctx.Engines = append(ctx.Engines, engine.NewRocksDB(spec.Attributes, spec.Path,
ctx.CacheSize/int64(len(ctx.Stores.Specs)), ctx.MemtableBudget, sizeInBytes, stopper))
}
}
if len(ctx.Engines) == 1 {
log.Infof("1 storage engine initialized")
} else {
log.Infof("%d storage engines initialized", len(ctx.Engines))
}
return nil
}
// InitNode parses node attributes and initializes the gossip bootstrap
// resolvers.
func (ctx *Context) InitNode() error {
ctx.readEnvironmentVariables()
// Initialize attributes.
ctx.NodeAttributes = parseAttributes(ctx.Attrs)
// Get the gossip bootstrap resolvers.
resolvers, err := ctx.parseGossipBootstrapResolvers()
if err != nil {
return err
}
if len(resolvers) > 0 {
ctx.GossipBootstrapResolvers = resolvers
}
return nil
}
// readEnvironmentVariables populates all context values that are environment
// variable based. Note that this only happens when initializing a node and not
// when NewContext is called.
func (ctx *Context) readEnvironmentVariables() {
// cockroach-linearizable
ctx.Linearizable = envutil.EnvOrDefaultBool("linearizable", ctx.Linearizable)
ctx.ConsistencyCheckPanicOnFailure = envutil.EnvOrDefaultBool("consistency_check_panic_on_failure", ctx.ConsistencyCheckPanicOnFailure)
ctx.MaxOffset = envutil.EnvOrDefaultDuration("max_offset", ctx.MaxOffset)
ctx.MetricsSampleInterval = envutil.EnvOrDefaultDuration("metrics_sample_interval", ctx.MetricsSampleInterval)
ctx.ScanInterval = envutil.EnvOrDefaultDuration("scan_interval", ctx.ScanInterval)
ctx.ScanMaxIdleTime = envutil.EnvOrDefaultDuration("scan_max_idle_time", ctx.ScanMaxIdleTime)
ctx.TimeUntilStoreDead = envutil.EnvOrDefaultDuration("time_until_store_dead", ctx.TimeUntilStoreDead)
ctx.ConsistencyCheckInterval = envutil.EnvOrDefaultDuration("consistency_check_interval", ctx.ConsistencyCheckInterval)
// TODO(bram): remove ReservationsEnabled once we've completed testing the
// feature.
ctx.ReservationsEnabled = envutil.EnvOrDefaultBool("reservations_enabled", ctx.ReservationsEnabled)
}
// parseGossipBootstrapResolvers parses a comma-separated list of
// gossip bootstrap resolvers.
func (ctx *Context) parseGossipBootstrapResolvers() ([]resolver.Resolver, error) {
var bootstrapResolvers []resolver.Resolver
addresses := strings.Split(ctx.JoinUsing, ",")
for _, address := range addresses {
if len(address) == 0 {
continue
}
resolver, err := resolver.NewResolver(ctx.Context, address)
if err != nil {
return nil, err
}
bootstrapResolvers = append(bootstrapResolvers, resolver)
}
return bootstrapResolvers, nil
}
// parseAttributes parses a colon-separated list of strings,
// filtering empty strings (i.e. "::" will yield no attributes.
// Returns the list of strings as Attributes.
func parseAttributes(attrsStr string) roachpb.Attributes {
var filtered []string
for _, attr := range strings.Split(attrsStr, ":") {
if len(attr) != 0 {
filtered = append(filtered, attr)
}
}
return roachpb.Attributes{Attrs: filtered}
}