-
Notifications
You must be signed in to change notification settings - Fork 24
/
backup_raw.go
259 lines (230 loc) · 9.05 KB
/
backup_raw.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
// Copyright 2020 PingCAP, Inc. Licensed under Apache-2.0.
package task
import (
"context"
"github.com/coreos/go-semver/semver"
"github.com/opentracing/opentracing-go"
"github.com/pingcap/errors"
backuppb "github.com/pingcap/kvproto/pkg/brpb"
"github.com/pingcap/kvproto/pkg/kvrpcpb"
"github.com/pingcap/log"
"github.com/spf13/cobra"
"github.com/tikv/client-go/v2/rawkv"
"github.com/tikv/migration/br/pkg/backup"
"github.com/tikv/migration/br/pkg/checksum"
"github.com/tikv/migration/br/pkg/feature"
"github.com/tikv/migration/br/pkg/glue"
"github.com/tikv/migration/br/pkg/metautil"
"github.com/tikv/migration/br/pkg/rtree"
"github.com/tikv/migration/br/pkg/storage"
"github.com/tikv/migration/br/pkg/summary"
"github.com/tikv/migration/br/pkg/utils"
"go.uber.org/zap"
)
const (
flagKeyFormat = "format"
flagStartKey = "start"
flagEndKey = "end"
flagDstAPIVersion = "dst-api-version"
flagSafeInterval = "safe-interval"
flagGCTTL = "gcttl"
)
// DefineRawBackupFlags defines common flags for the backup command.
func DefineRawBackupFlags(command *cobra.Command) {
command.Flags().StringP(flagStartKey, "", "",
"The start key of the backup task, key is inclusive.")
command.Flags().StringP(flagEndKey, "", "",
"The end key of the backup task, key is exclusive.")
command.Flags().StringP(flagKeyFormat, "", "hex",
"The format of start and end key. Available options: \"raw\", \"escaped\", \"hex\".")
command.Flags().StringP(flagDstAPIVersion, "", "",
`The encoding method of backuped SST files for destination TiKV cluster. Available options: "v1", "v1ttl", "v2".`)
command.Flags().String(flagCompressionType, "zstd",
"The compression algorithm of the backuped SST files. Available options: \"lz4\", \"zstd\", \"snappy\".")
command.Flags().Bool(flagRemoveSchedulers, false,
"disable the balance, shuffle and region-merge schedulers in PD to speed up backup.")
command.Flags().Duration(flagSafeInterval, utils.DefaultBRSafeInterval,
"The interval between backup-ts and current tso.")
command.Flags().Duration(flagGCTTL, utils.DefaultBRGCSafePointTTL, "The TTL of BR's GC safepoint")
// safe-interval is difficult for common users to set one suitable value. Hide it.
_ = command.Flags().MarkHidden(flagSafeInterval)
// This flag can impact the online cluster, so hide it in case of abuse.
_ = command.Flags().MarkHidden(flagCompressionType)
_ = command.Flags().MarkHidden(flagRemoveSchedulers)
}
// CalcChecksumFromBackupMeta read the backup meta and return Checksum
func CalcChecksumAndRangeFromBackupMeta(ctx context.Context, backupMeta *backuppb.BackupMeta, curAPIVersion kvrpcpb.APIVersion) (rawkv.RawChecksum, []*utils.KeyRange) {
fileChecksum := rawkv.RawChecksum{}
keyRanges := make([]*utils.KeyRange, 0, len(backupMeta.Files))
for _, file := range backupMeta.Files {
checksum.UpdateChecksum(&fileChecksum, file.Crc64Xor, file.TotalKvs, file.TotalBytes)
keyRange := utils.ConvertBackupConfigKeyRange(file.StartKey, file.EndKey, backupMeta.ApiVersion, curAPIVersion)
keyRanges = append(keyRanges, keyRange)
}
return fileChecksum, keyRanges
}
// RunBackupRaw starts a backup task inside the current goroutine.
func RunBackupRaw(c context.Context, g glue.Glue, cmdName string, cfg *RawKvConfig) error {
cfg.adjust()
defer summary.Summary(cmdName)
ctx, cancel := context.WithCancel(c)
defer cancel()
if span := opentracing.SpanFromContext(ctx); span != nil && span.Tracer() != nil {
span1 := span.Tracer().StartSpan("task.RunBackupRaw", opentracing.ChildOf(span.Context()))
defer span1.Finish()
ctx = opentracing.ContextWithSpan(ctx, span1)
}
u, err := storage.ParseBackend(cfg.Storage, &cfg.BackendOptions)
if err != nil {
return errors.Trace(err)
}
mgr, err := NewMgr(ctx, g, cfg.PD, cfg.TLS, GetKeepalive(&cfg.Config), cfg.CheckRequirements)
if err != nil {
return errors.Trace(err)
}
defer mgr.Close()
client, err := backup.NewBackupClient(ctx, mgr, mgr.GetTLSConfig())
if err != nil {
return errors.Trace(err)
}
clusterVersion, err := mgr.GetClusterVersion(ctx)
if err != nil {
return errors.Trace(err)
}
brVersion := g.GetVersion()
curAPIVersion := client.GetCurAPIVersion()
cfg.adjustBackupRange(curAPIVersion)
if len(cfg.DstAPIVersion) == 0 { // if no DstAPIVersion is specified, backup to same api-version.
cfg.DstAPIVersion = curAPIVersion.String()
}
dstAPIVersion := kvrpcpb.APIVersion(kvrpcpb.APIVersion_value[cfg.DstAPIVersion])
featureGate := feature.NewFeatureGate(semver.New(clusterVersion))
if !CheckBackupAPIVersion(featureGate, curAPIVersion, dstAPIVersion) {
return errors.Errorf("Unsupported backup api version in current cluster, cur:%s, dst:%s, cluster version:%s",
curAPIVersion.String(), cfg.DstAPIVersion, clusterVersion)
}
if cfg.Checksum && !featureGate.IsEnabled(feature.Checksum) {
log.Error("TiKV cluster does not support checksum, please disable checksum", zap.String("version", clusterVersion))
return errors.Errorf("Current tikv cluster version %s does not support checksum, please disable checksum", clusterVersion)
}
opts := storage.ExternalStorageOptions{
NoCredentials: cfg.NoCreds,
SendCredentials: cfg.SendCreds,
}
if err = client.SetStorage(ctx, u, &opts); err != nil {
return errors.Trace(err)
}
client.SetGCTTL(cfg.GCTTL)
if featureGate.IsEnabled(feature.BackupTs) && curAPIVersion == kvrpcpb.APIVersion_V2 {
// set safepoint to avoid the logical deletion data to gc.
backupTs, err := client.UpdateBRGCSafePoint(ctx, cfg.SafeInterval)
if err != nil {
return errors.Trace(err)
}
g.Record("backup-ts", backupTs)
}
backupRange := rtree.Range{StartKey: cfg.StartKey, EndKey: cfg.EndKey}
if cfg.RemoveSchedulers {
restore, e := mgr.RemoveSchedulers(ctx)
defer func() {
if ctx.Err() != nil {
log.Warn("context canceled, try shutdown")
ctx = context.Background()
}
if restoreE := restore(ctx); restoreE != nil {
log.Warn("failed to restore removed schedulers, you may need to restore them manually", zap.Error(restoreE))
}
}()
if e != nil {
return errors.Trace(err)
}
}
// The number of regions need to backup
approximateRegions, err := mgr.GetRegionCount(ctx, backupRange.StartKey, backupRange.EndKey)
if err != nil {
return errors.Trace(err)
}
summary.CollectInt("backup total regions", approximateRegions)
// Backup
// Redirect to log if there is no log file to avoid unreadable output.
updateCh := g.StartProgress(
ctx, cmdName, int64(approximateRegions), !cfg.LogProgress)
progressCallBack := func(unit backup.ProgressUnit) {
if unit == backup.RangeUnit {
return
}
updateCh.Inc()
}
req := backuppb.BackupRequest{
ClusterId: client.GetClusterID(),
StartVersion: 0,
EndVersion: 0,
RateLimit: cfg.RateLimit,
Concurrency: cfg.Concurrency,
IsRawKv: true,
Cf: "default",
DstApiVersion: dstAPIVersion,
CompressionType: cfg.CompressionType,
CompressionLevel: cfg.CompressionLevel,
CipherInfo: &cfg.CipherInfo,
}
metaWriter := metautil.NewMetaWriter(client.GetStorage(), metautil.MetaFileSize, false, &cfg.CipherInfo)
metaWriter.StartWriteMetasAsync(ctx, metautil.AppendDataFile)
err = client.BackupRange(ctx, backupRange.StartKey, backupRange.EndKey, req, metaWriter, progressCallBack)
if err != nil {
return errors.Trace(err)
}
// Backup has finished
updateCh.Close()
// backup meta range should in DstAPIVersion format
metaRange := utils.ConvertBackupConfigKeyRange(cfg.StartKey, cfg.EndKey, curAPIVersion, dstAPIVersion)
if metaRange == nil {
return errors.Errorf("fail to convert key. curAPIVer:%d, dstAPIVer:%d", curAPIVersion, dstAPIVersion)
}
rawRanges := []*backuppb.RawRange{{StartKey: metaRange.Start, EndKey: metaRange.End, Cf: "default"}}
metaWriter.Update(func(m *backuppb.BackupMeta) {
m.StartVersion = req.StartVersion
m.EndVersion = req.EndVersion
m.IsRawKv = req.IsRawKv
m.RawRanges = rawRanges
m.ClusterId = req.ClusterId
m.ClusterVersion = clusterVersion
m.BrVersion = brVersion
m.ApiVersion = dstAPIVersion
})
err = metaWriter.FinishWriteMetas(ctx, metautil.AppendDataFile)
if err != nil {
return errors.Trace(err)
}
err = metaWriter.FlushBackupMeta(ctx)
if err != nil {
return errors.Trace(err)
}
g.Record(summary.BackupDataSize, metaWriter.ArchiveSize())
if cfg.Checksum {
_, _, backupMeta, err := ReadBackupMeta(ctx, metautil.MetaFile, &cfg.Config)
if err != nil {
log.Error("fail to read backup meta", zap.Error(err))
return errors.Trace(err)
}
fileChecksum, keyRanges := CalcChecksumAndRangeFromBackupMeta(ctx, backupMeta, curAPIVersion)
checksumMethod := checksum.StorageChecksumCommand
if curAPIVersion.String() != cfg.DstAPIVersion {
checksumMethod = checksum.StorageScanCommand
}
executor, err := checksum.NewExecutor(ctx, keyRanges, cfg.PD, curAPIVersion,
cfg.ChecksumConcurrency, cfg.TLS)
if err != nil {
return errors.Trace(err)
}
defer executor.Close()
err = checksum.Run(ctx, cmdName, executor,
checksumMethod, fileChecksum)
if err != nil {
return errors.Trace(err)
}
}
// Set task summary to success status.
summary.SetSuccessStatus(true)
return nil
}