forked from tikv/pd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.go
575 lines (473 loc) · 17.4 KB
/
config.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
// Copyright 2016 PingCAP, Inc.
//
// 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,
// See the License for the specific language governing permissions and
// limitations under the License.
package server
import (
"flag"
"fmt"
"net/url"
"reflect"
"strings"
"sync/atomic"
"time"
"github.com/BurntSushi/toml"
"github.com/coreos/etcd/embed"
"github.com/juju/errors"
"github.com/pingcap/pd/pkg/logutil"
"github.com/pingcap/pd/pkg/metricutil"
"github.com/pingcap/pd/pkg/typeutil"
"github.com/pingcap/pd/server/core"
"github.com/pingcap/pd/server/schedule"
)
// Config is the pd server configuration.
type Config struct {
*flag.FlagSet `json:"-"`
Version bool `json:"-"`
ClientUrls string `toml:"client-urls" json:"client-urls"`
PeerUrls string `toml:"peer-urls" json:"peer-urls"`
AdvertiseClientUrls string `toml:"advertise-client-urls" json:"advertise-client-urls"`
AdvertisePeerUrls string `toml:"advertise-peer-urls" json:"advertise-peer-urls"`
Name string `toml:"name" json:"name"`
DataDir string `toml:"data-dir" json:"data-dir"`
InitialCluster string `toml:"initial-cluster" json:"initial-cluster"`
InitialClusterState string `toml:"initial-cluster-state" json:"initial-cluster-state"`
// Join to an existing pd cluster, a string of endpoints.
Join string `toml:"join" json:"join"`
// LeaderLease time, if leader doesn't update its TTL
// in etcd after lease time, etcd will expire the leader key
// and other servers can campaign the leader again.
// Etcd onlys support seoncds TTL, so here is second too.
LeaderLease int64 `toml:"lease" json:"lease"`
// Log related config.
Log logutil.LogConfig `toml:"log" json:"log"`
// Backward compatibility.
LogFileDeprecated string `toml:"log-file" json:"log-file"`
LogLevelDeprecated string `toml:"log-level" json:"log-level"`
// TsoSaveInterval is the interval to save timestamp.
TsoSaveInterval typeutil.Duration `toml:"tso-save-interval" json:"tso-save-interval"`
Metric metricutil.MetricConfig `toml:"metric" json:"metric"`
Schedule ScheduleConfig `toml:"schedule" json:"schedule"`
Replication ReplicationConfig `toml:"replication" json:"replication"`
// QuotaBackendBytes Raise alarms when backend size exceeds the given quota. 0 means use the default quota.
// the default size is 2GB, the maximum is 8GB.
QuotaBackendBytes typeutil.ByteSize `toml:"quota-backend-bytes" json:"quota-backend-bytes"`
// AutoCompactionRetention for mvcc key value store in hour. 0 means disable auto compaction.
// the default retention is 1 hour
AutoCompactionRetention int `toml:"auto-compaction-retention" json:"auto-compaction-retention"`
// TickInterval is the interval for etcd Raft tick.
TickInterval typeutil.Duration `toml:"tick-interval"`
// ElectionInterval is the interval for etcd Raft election.
ElectionInterval typeutil.Duration `toml:"election-interval"`
configFile string
// For all warnings during parsing.
WarningMsgs []string
// Enable namespace isolation.
EnableNamespace bool `toml:"enable-namespace" json:"enable-namespace"`
// Only test can change them.
nextRetryDelay time.Duration
disableStrictReconfigCheck bool
heartbeatStreamBindInterval typeutil.Duration
}
// NewConfig creates a new config.
func NewConfig() *Config {
cfg := &Config{}
cfg.FlagSet = flag.NewFlagSet("pd", flag.ContinueOnError)
fs := cfg.FlagSet
fs.BoolVar(&cfg.Version, "V", false, "print version information and exit")
fs.BoolVar(&cfg.Version, "version", false, "print version information and exit")
fs.StringVar(&cfg.configFile, "config", "", "Config file")
fs.StringVar(&cfg.Name, "name", defaultName, "human-readable name for this pd member")
fs.StringVar(&cfg.DataDir, "data-dir", "", "path to the data directory (default 'default.${name}')")
fs.StringVar(&cfg.ClientUrls, "client-urls", defaultClientUrls, "url for client traffic")
fs.StringVar(&cfg.AdvertiseClientUrls, "advertise-client-urls", "", "advertise url for client traffic (default '${client-urls}')")
fs.StringVar(&cfg.PeerUrls, "peer-urls", defaultPeerUrls, "url for peer traffic")
fs.StringVar(&cfg.AdvertisePeerUrls, "advertise-peer-urls", "", "advertise url for peer traffic (default '${peer-urls}')")
fs.StringVar(&cfg.InitialCluster, "initial-cluster", "", "initial cluster configuration for bootstrapping, e,g. pd=http://127.0.0.1:2380")
fs.StringVar(&cfg.Join, "join", "", "join to an existing cluster (usage: cluster's '${advertise-client-urls}'")
fs.StringVar(&cfg.Log.Level, "L", "", "log level: debug, info, warn, error, fatal (default 'info')")
fs.StringVar(&cfg.Log.File.Filename, "log-file", "", "log file path")
fs.BoolVar(&cfg.Log.File.LogRotate, "log-rotate", true, "rotate log")
fs.BoolVar(&cfg.EnableNamespace, "enable-namespace", false, "enable namespace isolation (default 'false')")
return cfg
}
const (
defaultLeaderLease = int64(3)
defaultNextRetryDelay = time.Second
defaultAutoCompactionRetention = 1
defaultName = "pd"
defaultClientUrls = "http://127.0.0.1:2379"
defaultPeerUrls = "http://127.0.0.1:2380"
defualtInitialClusterState = embed.ClusterStateFlagNew
// etcd use 100ms for heartbeat and 1s for election timeout.
// We can enlarge both a little to reduce the network aggression.
// now embed etcd use TickMs for heartbeat, we will update
// after embed etcd decouples tick and heartbeat.
defaultTickInterval = 500 * time.Millisecond
// embed etcd has a check that `5 * tick > election`
defaultElectionInterval = 3000 * time.Millisecond
defaultHeartbeatStreamRebindInterval = time.Minute
)
func adjustString(v *string, defValue string) {
if len(*v) == 0 {
*v = defValue
}
}
func adjustUint64(v *uint64, defValue uint64) {
if *v == 0 {
*v = defValue
}
}
func adjustInt64(v *int64, defValue int64) {
if *v == 0 {
*v = defValue
}
}
func adjustFloat64(v *float64, defValue float64) {
if *v == 0 {
*v = defValue
}
}
func adjustDuration(v *typeutil.Duration, defValue time.Duration) {
if v.Duration == 0 {
v.Duration = defValue
}
}
func adjustSchedulers(v *SchedulerConfigs, defValue SchedulerConfigs) {
if len(*v) == 0 {
*v = defValue
}
}
// Parse parses flag definitions from the argument list.
func (c *Config) Parse(arguments []string) error {
// Parse first to get config file.
err := c.FlagSet.Parse(arguments)
if err != nil {
return errors.Trace(err)
}
// Load config file if specified.
if c.configFile != "" {
err = c.configFromFile(c.configFile)
if err != nil {
return errors.Trace(err)
}
// Backward compatibility for toml config
if c.LogFileDeprecated != "" && c.Log.File.Filename == "" {
c.Log.File.Filename = c.LogFileDeprecated
msg := fmt.Sprintf("log-file in %s is deprecated, use [log.file] instead", c.configFile)
c.WarningMsgs = append(c.WarningMsgs, msg)
}
if c.LogLevelDeprecated != "" && c.Log.Level == "" {
c.Log.Level = c.LogLevelDeprecated
msg := fmt.Sprintf("log-level in %s is deprecated, use [log] instead", c.configFile)
c.WarningMsgs = append(c.WarningMsgs, msg)
}
}
// Parse again to replace with command line options.
err = c.FlagSet.Parse(arguments)
if err != nil {
return errors.Trace(err)
}
if len(c.FlagSet.Args()) != 0 {
return errors.Errorf("'%s' is an invalid flag", c.FlagSet.Arg(0))
}
err = c.adjust()
return errors.Trace(err)
}
func (c *Config) validate() error {
if c.Join != "" && c.InitialCluster != "" {
return errors.New("-initial-cluster and -join can not be provided at the same time")
}
return nil
}
func (c *Config) adjust() error {
if err := c.validate(); err != nil {
return errors.Trace(err)
}
adjustString(&c.Name, defaultName)
adjustString(&c.DataDir, fmt.Sprintf("default.%s", c.Name))
adjustString(&c.ClientUrls, defaultClientUrls)
adjustString(&c.AdvertiseClientUrls, c.ClientUrls)
adjustString(&c.PeerUrls, defaultPeerUrls)
adjustString(&c.AdvertisePeerUrls, c.PeerUrls)
if len(c.InitialCluster) == 0 {
// The advertise peer urls may be http://127.0.0.1:2380,http://127.0.0.1:2381
// so the initial cluster is pd=http://127.0.0.1:2380,pd=http://127.0.0.1:2381
items := strings.Split(c.AdvertisePeerUrls, ",")
sep := ""
for _, item := range items {
c.InitialCluster += fmt.Sprintf("%s%s=%s", sep, c.Name, item)
sep = ","
}
}
adjustString(&c.InitialClusterState, defualtInitialClusterState)
adjustInt64(&c.LeaderLease, defaultLeaderLease)
adjustDuration(&c.TsoSaveInterval, time.Duration(defaultLeaderLease)*time.Second)
if c.nextRetryDelay == 0 {
c.nextRetryDelay = defaultNextRetryDelay
}
if c.AutoCompactionRetention == 0 {
c.AutoCompactionRetention = defaultAutoCompactionRetention
}
adjustDuration(&c.TickInterval, defaultTickInterval)
adjustDuration(&c.ElectionInterval, defaultElectionInterval)
adjustString(&c.Metric.PushJob, c.Name)
c.Schedule.adjust()
c.Replication.adjust()
adjustDuration(&c.heartbeatStreamBindInterval, defaultHeartbeatStreamRebindInterval)
return nil
}
func (c *Config) clone() *Config {
cfg := &Config{}
*cfg = *c
return cfg
}
func (c *Config) String() string {
if c == nil {
return "<nil>"
}
return fmt.Sprintf("Config(%+v)", *c)
}
// configFromFile loads config from file.
func (c *Config) configFromFile(path string) error {
_, err := toml.DecodeFile(path, c)
return errors.Trace(err)
}
// ScheduleConfig is the schedule configuration.
type ScheduleConfig struct {
// If the snapshot count of one store is greater than this value,
// it will never be used as a source or target store.
MaxSnapshotCount uint64 `toml:"max-snapshot-count,omitempty" json:"max-snapshot-count"`
// MaxStoreDownTime is the max duration after which
// a store will be considered to be down if it hasn't reported heartbeats.
MaxStoreDownTime typeutil.Duration `toml:"max-store-down-time,omitempty" json:"max-store-down-time"`
// LeaderScheduleLimit is the max coexist leader schedules.
LeaderScheduleLimit uint64 `toml:"leader-schedule-limit,omitempty" json:"leader-schedule-limit"`
// RegionScheduleLimit is the max coexist region schedules.
RegionScheduleLimit uint64 `toml:"region-schedule-limit,omitempty" json:"region-schedule-limit"`
// ReplicaScheduleLimit is the max coexist replica schedules.
ReplicaScheduleLimit uint64 `toml:"replica-schedule-limit,omitempty" json:"replica-schedule-limit"`
// Schedulers support for loding customized schedulers
Schedulers SchedulerConfigs `toml:"schedulers,omitempty" json:"schedulers-v2"` // json v2 is for the sake of compatible upgrade
}
func (c *ScheduleConfig) clone() *ScheduleConfig {
schedulers := make(SchedulerConfigs, len(c.Schedulers))
copy(schedulers, c.Schedulers)
return &ScheduleConfig{
MaxSnapshotCount: c.MaxSnapshotCount,
MaxStoreDownTime: c.MaxStoreDownTime,
LeaderScheduleLimit: c.LeaderScheduleLimit,
RegionScheduleLimit: c.RegionScheduleLimit,
ReplicaScheduleLimit: c.ReplicaScheduleLimit,
Schedulers: schedulers,
}
}
// SchedulerConfigs is a slice of customized scheduler configuration.
type SchedulerConfigs []SchedulerConfig
// SchedulerConfig is customized scheduler configuration
type SchedulerConfig struct {
Type string `toml:"type" json:"type"`
Args []string `toml:"args,omitempty" json:"args"`
}
const (
defaultMaxReplicas = 3
defaultMaxSnapshotCount = 3
defaultMaxStoreDownTime = time.Hour
defaultLeaderScheduleLimit = 64
defaultRegionScheduleLimit = 12
defaultReplicaScheduleLimit = 16
)
var defaultSchedulers = SchedulerConfigs{
{Type: "balance-region"},
{Type: "balance-leader"},
{Type: "hot-region"},
}
func (c *ScheduleConfig) adjust() {
adjustUint64(&c.MaxSnapshotCount, defaultMaxSnapshotCount)
adjustDuration(&c.MaxStoreDownTime, defaultMaxStoreDownTime)
adjustUint64(&c.LeaderScheduleLimit, defaultLeaderScheduleLimit)
adjustUint64(&c.RegionScheduleLimit, defaultRegionScheduleLimit)
adjustUint64(&c.ReplicaScheduleLimit, defaultReplicaScheduleLimit)
adjustSchedulers(&c.Schedulers, defaultSchedulers)
}
// ReplicationConfig is the replication configuration.
type ReplicationConfig struct {
// MaxReplicas is the number of replicas for each region.
MaxReplicas uint64 `toml:"max-replicas,omitempty" json:"max-replicas"`
// The label keys specified the location of a store.
// The placement priorities is implied by the order of label keys.
// For example, ["zone", "rack"] means that we should place replicas to
// different zones first, then to different racks if we don't have enough zones.
LocationLabels typeutil.StringSlice `toml:"location-labels,omitempty" json:"location-labels"`
}
func (c *ReplicationConfig) clone() *ReplicationConfig {
locationLabels := make(typeutil.StringSlice, len(c.LocationLabels))
copy(locationLabels, c.LocationLabels)
return &ReplicationConfig{
MaxReplicas: c.MaxReplicas,
LocationLabels: locationLabels,
}
}
func (c *ReplicationConfig) adjust() {
adjustUint64(&c.MaxReplicas, defaultMaxReplicas)
}
// scheduleOption is a wrapper to access the configuration safely.
type scheduleOption struct {
v atomic.Value
rep *Replication
}
func newScheduleOption(cfg *Config) *scheduleOption {
o := &scheduleOption{}
o.store(&cfg.Schedule)
o.rep = newReplication(&cfg.Replication)
return o
}
func (o *scheduleOption) load() *ScheduleConfig {
return o.v.Load().(*ScheduleConfig)
}
func (o *scheduleOption) store(cfg *ScheduleConfig) {
o.v.Store(cfg)
}
func (o *scheduleOption) GetReplication() *Replication {
return o.rep
}
func (o *scheduleOption) GetMaxReplicas() int {
return o.rep.GetMaxReplicas()
}
func (o *scheduleOption) GetLocationLabels() []string {
return o.rep.GetLocationLabels()
}
func (o *scheduleOption) SetMaxReplicas(replicas int) {
o.rep.SetMaxReplicas(replicas)
}
func (o *scheduleOption) GetMaxSnapshotCount() uint64 {
return o.load().MaxSnapshotCount
}
func (o *scheduleOption) GetMaxStoreDownTime() time.Duration {
return o.load().MaxStoreDownTime.Duration
}
func (o *scheduleOption) GetLeaderScheduleLimit() uint64 {
return o.load().LeaderScheduleLimit
}
func (o *scheduleOption) GetRegionScheduleLimit() uint64 {
return o.load().RegionScheduleLimit
}
func (o *scheduleOption) GetReplicaScheduleLimit() uint64 {
return o.load().ReplicaScheduleLimit
}
func (o *scheduleOption) GetSchedulers() SchedulerConfigs {
return o.load().Schedulers
}
func (o *scheduleOption) AddSchedulerCfg(tp string, args []string) error {
c := o.load()
v := c.clone()
for _, schedulerCfg := range v.Schedulers {
// comparing args is to cover the case that there are schedulers in same type but not with same name
// such as two schedulers of type "evict-leader",
// one name is "evict-leader-scheduler-1" and the other is "evict-leader-scheduler-2"
if reflect.DeepEqual(schedulerCfg, SchedulerConfig{tp, args}) {
return nil
}
}
v.Schedulers = append(v.Schedulers, SchedulerConfig{Type: tp, Args: args})
o.store(v)
return nil
}
func (o *scheduleOption) RemoveSchedulerCfg(name string) error {
c := o.load()
v := c.clone()
for i, schedulerCfg := range v.Schedulers {
// To create a temporary scheduler is just used to get scheduler's name
tmp, err := schedule.CreateScheduler(schedulerCfg.Type, o, schedulerCfg.Args...)
if err != nil {
return errors.Trace(err)
}
if tmp.GetName() == name {
v.Schedulers = append(v.Schedulers[:i], v.Schedulers[i+1:]...)
o.store(v)
return nil
}
}
return nil
}
func (o *scheduleOption) persist(kv *core.KV) error {
cfg := &Config{
Schedule: *o.load(),
Replication: *o.rep.load(),
}
err := kv.SaveConfig(cfg)
return errors.Trace(err)
}
func (o *scheduleOption) reload(kv *core.KV) error {
cfg := &Config{
Schedule: *o.load(),
Replication: *o.rep.load(),
}
isExist, err := kv.LoadConfig(cfg)
if err != nil {
return errors.Trace(err)
}
if isExist {
o.store(&cfg.Schedule)
o.rep.store(&cfg.Replication)
}
return nil
}
func (o *scheduleOption) GetHotRegionLowThreshold() int {
return hotRegionLowThreshold
}
// ParseUrls parse a string into multiple urls.
// Export for api.
func ParseUrls(s string) ([]url.URL, error) {
items := strings.Split(s, ",")
urls := make([]url.URL, 0, len(items))
for _, item := range items {
u, err := url.Parse(item)
if err != nil {
return nil, errors.Trace(err)
}
urls = append(urls, *u)
}
return urls, nil
}
// generates a configuration for embedded etcd.
func (c *Config) genEmbedEtcdConfig() (*embed.Config, error) {
cfg := embed.NewConfig()
cfg.Name = c.Name
cfg.Dir = c.DataDir
cfg.WalDir = ""
cfg.InitialCluster = c.InitialCluster
cfg.ClusterState = c.InitialClusterState
cfg.EnablePprof = true
cfg.StrictReconfigCheck = !c.disableStrictReconfigCheck
cfg.TickMs = uint(c.TickInterval.Duration / time.Millisecond)
cfg.ElectionMs = uint(c.ElectionInterval.Duration / time.Millisecond)
cfg.AutoCompactionRetention = c.AutoCompactionRetention
cfg.QuotaBackendBytes = int64(c.QuotaBackendBytes)
var err error
cfg.LPUrls, err = ParseUrls(c.PeerUrls)
if err != nil {
return nil, errors.Trace(err)
}
cfg.APUrls, err = ParseUrls(c.AdvertisePeerUrls)
if err != nil {
return nil, errors.Trace(err)
}
cfg.LCUrls, err = ParseUrls(c.ClientUrls)
if err != nil {
return nil, errors.Trace(err)
}
cfg.ACUrls, err = ParseUrls(c.AdvertiseClientUrls)
if err != nil {
return nil, errors.Trace(err)
}
return cfg, nil
}