-
Notifications
You must be signed in to change notification settings - Fork 59
/
Copy pathretrieval.go
829 lines (646 loc) · 22 KB
/
retrieval.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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
/*
2020 © Postgres.ai
*/
// Package retrieval provides data retrieval pipeline.
package retrieval
import (
"context"
"fmt"
"os"
"path/filepath"
"strings"
"time"
"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/filters"
"github.com/docker/docker/client"
"github.com/pkg/errors"
"github.com/robfig/cron/v3"
"gitlab.com/postgres-ai/database-lab/v3/internal/provision/pool"
"gitlab.com/postgres-ai/database-lab/v3/internal/provision/resources"
"gitlab.com/postgres-ai/database-lab/v3/internal/provision/runners"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/components"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/config"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/dbmarker"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine/postgres/logical"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine/postgres/physical"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine/postgres/snapshot"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine/postgres/tools"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine/postgres/tools/cont"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/engine/postgres/tools/db"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/options"
"gitlab.com/postgres-ai/database-lab/v3/internal/retrieval/status"
"gitlab.com/postgres-ai/database-lab/v3/internal/telemetry"
"gitlab.com/postgres-ai/database-lab/v3/pkg/util"
dblabCfg "gitlab.com/postgres-ai/database-lab/v3/pkg/config"
"gitlab.com/postgres-ai/database-lab/v3/pkg/config/global"
"gitlab.com/postgres-ai/database-lab/v3/pkg/log"
"gitlab.com/postgres-ai/database-lab/v3/pkg/models"
)
const (
parseOption = cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow
refreshJobs jobGroup = "refresh"
snapshotJobs jobGroup = "snapshot"
pendingFilename = "pending.retrieval"
)
type jobGroup string
// Retrieval describes a data retrieval.
type Retrieval struct {
Scheduler Scheduler
State State
imageState *db.ImageContent
cfg *config.Config
global *global.Config
engineProps *global.EngineProps
docker *client.Client
poolManager *pool.Manager
tm *telemetry.Agent
runner runners.Runner
ctxCancel context.CancelFunc
statefulJobs []components.JobRunner
}
// Scheduler defines a refresh scheduler.
type Scheduler struct {
Cron *cron.Cron
Spec cron.Schedule
}
// New creates a new data retrieval.
func New(cfg *dblabCfg.Config, engineProps *global.EngineProps, docker *client.Client, pm *pool.Manager, tm *telemetry.Agent,
runner runners.Runner) (*Retrieval, error) {
r := &Retrieval{
global: &cfg.Global,
engineProps: engineProps,
docker: docker,
poolManager: pm,
tm: tm,
runner: runner,
State: State{
Status: models.Inactive,
alerts: make(map[models.AlertType]models.Alert),
},
imageState: db.NewImageContent(*engineProps),
}
retrievalCfg, err := ValidateConfig(&cfg.Retrieval)
if err != nil {
return nil, err
}
r.setup(retrievalCfg)
if err := checkPendingMarker(r); err != nil {
return nil, fmt.Errorf("failed to check pending marker: %w", err)
}
return r, nil
}
// ImageContent provides the content of foundation Docker image.
func (r *Retrieval) ImageContent() *db.ImageContent {
return r.imageState
}
func checkPendingMarker(r *Retrieval) error {
pendingPath, err := util.GetMetaPath(pendingFilename)
if err != nil {
return fmt.Errorf("failed to build pending filename: %w", err)
}
if _, err := os.Stat(pendingPath); err != nil {
if errors.Is(err, os.ErrNotExist) {
return nil
}
return fmt.Errorf("failed to get pending file info: %w", err)
}
r.State.Status = models.Pending
return nil
}
// RemovePendingMarker removes the file from the metadata directory which specifies that retrieval is pending.
func (r *Retrieval) RemovePendingMarker() error {
pending, err := util.GetMetaPath(pendingFilename)
if err != nil {
return fmt.Errorf("failed to build pending filename: %w", err)
}
if err := os.Remove(pending); err != nil {
if errors.Is(err, os.ErrNotExist) {
return nil
}
return err
}
r.State.Status = models.Inactive
return nil
}
// Reload reloads retrieval configuration.
func (r *Retrieval) Reload(ctx context.Context, retrievalCfg *config.Config) {
r.setup(retrievalCfg)
r.reloadStatefulJobs()
r.stopScheduler()
r.setupScheduler(ctx)
}
func (r *Retrieval) setup(retrievalCfg *config.Config) {
r.cfg = retrievalCfg
r.defineRetrievalMode()
}
func (r *Retrieval) reloadStatefulJobs() {
for _, job := range r.statefulJobs {
cfg, ok := r.cfg.JobsSpec[job.Name()]
if !ok {
log.Msg("Skip reloading of the stateful retrieval job. Spec not found", job.Name())
continue
}
// todo should we remove if jobs are not there ?
// todo should we check for completion before ?
if err := job.Reload(cfg.Options); err != nil {
log.Err("Failed to reload configuration of the retrieval job", job.Name(), err)
}
}
}
// Run start retrieving process.
func (r *Retrieval) Run(ctx context.Context) error {
runCtx, cancel := context.WithCancel(ctx)
r.ctxCancel = cancel
log.Msg("Retrieval mode:", r.State.Mode)
if err := r.collectFoundationImageContent(); err != nil {
return fmt.Errorf("failed to collect content lists from the foundation Docker image of the logicalDump job: %w", err)
}
if r.cfg.Refresh != nil && r.cfg.Refresh.SkipStartRefresh {
log.Msg("Continue without performing initial data refresh because the `skipStartRefresh` option is enabled")
r.setupScheduler(ctx)
return nil
}
fsManager, err := r.getNextPoolToDataRetrieving()
if err != nil {
var skipError *SkipRefreshingError
if errors.As(err, &skipError) {
r.State.Status = models.Finished
log.Msg("Continue without performing a full refresh:", skipError.Error())
r.setupScheduler(ctx)
return nil
}
alert := telemetry.Alert{
Level: models.RefreshFailed,
Message: "Pool to perform data refresh not found",
}
r.State.Status = models.Failed
r.State.addAlert(alert)
r.tm.SendEvent(ctx, telemetry.AlertEvent, alert)
return fmt.Errorf("failed to choose pool to refresh: %w", err)
}
log.Msg("Pool to perform data retrieving: ", fsManager.Pool().Name)
if r.State.Status == models.Pending {
log.Msg("Data retrieving suspended because Retrieval state is pending")
return nil
}
if err := r.run(runCtx, fsManager); err != nil {
r.State.addAlert(telemetry.Alert{Level: models.RefreshFailed, Message: err.Error()})
// Build a generic message to avoid sending sensitive data.
r.tm.SendEvent(ctx, telemetry.AlertEvent, telemetry.Alert{Level: models.RefreshFailed,
Message: fmt.Sprintf("Failed to perform initial data retrieving: %s", r.State.Mode)})
return err
}
r.setupScheduler(ctx)
return nil
}
func (r *Retrieval) collectFoundationImageContent() error {
if _, ok := r.cfg.JobsSpec[logical.DumpJobType]; !ok {
if r.State.Mode == models.Logical {
log.Msg("logicalDump job is not enabled. Docker image extensions and locales will not be checked")
}
return nil
}
dumpOptions := &logical.DumpOptions{}
if err := r.JobConfig(logical.DumpJobType, &dumpOptions); err != nil {
return fmt.Errorf("failed to get config of %s job: %w", logical.DumpJobType, err)
}
if err := r.imageState.Collect(dumpOptions.DockerImage); err != nil {
return err
}
// Collect a list of databases mentioned in the Retrieval config. An empty list means all databases.
dbs := make([]string, 0)
if len(dumpOptions.Databases) != 0 {
dbs = append(dbs, collectDBList(dumpOptions.Databases)...)
restoreOptions := &logical.RestoreOptions{}
if err := r.JobConfig(logical.RestoreJobType, &restoreOptions); err == nil && len(restoreOptions.Databases) != 0 {
dbs = append(dbs, collectDBList(restoreOptions.Databases)...)
}
}
r.imageState.SetDatabases(dbs)
return nil
}
func collectDBList(definitions map[string]logical.DumpDefinition) []string {
dbs := []string{}
for dbName := range definitions {
dbs = append(dbs, dbName)
}
return dbs
}
func (r *Retrieval) getNextPoolToDataRetrieving() (pool.FSManager, error) {
firstPool := r.poolManager.First()
if firstPool == nil {
return nil, errors.New("no available pools")
}
if firstPool.Pool().Status() == resources.EmptyPool {
return firstPool, nil
}
// For physical or unknown modes, changing the pool is possible only by the refresh timetable.
if r.State.Mode != models.Logical {
return firstPool, nil
}
// For logical mode try to find another pool to avoid rewriting prepared data.
elementToRefresh := r.poolManager.GetPoolToUpdate()
if elementToRefresh == nil || elementToRefresh.Value == nil {
if firstPool.Pool().Status() == resources.ActivePool {
return nil, NewSkipRefreshingError("pool to refresh not found, but the current pool is active")
}
return nil, errors.New("pool to perform data refresh not found")
}
poolToRefresh, err := r.poolManager.GetFSManager(elementToRefresh.Value.(string))
if err != nil {
return nil, fmt.Errorf("failed to get FSManager: %w", err)
}
return poolToRefresh, nil
}
func (r *Retrieval) run(ctx context.Context, fsm pool.FSManager) (err error) {
if r.engineProps.GetEdition() == global.StandardEdition {
if err := r.engineProps.CheckBilling(); err != nil {
return fmt.Errorf("skip snapshotting: %w", err)
}
}
// Check the pool aliveness.
if _, err := fsm.GetFilesystemState(); err != nil {
return errors.Wrap(errors.Unwrap(err), "filesystem manager is not ready")
}
poolName := fsm.Pool().Name
poolElement := r.poolManager.GetPoolByName(poolName)
if poolElement == nil {
return errors.Errorf("pool %s not found", poolName)
}
if err := r.RefreshData(ctx, poolName); err != nil {
return err
}
if r.State.Status == models.Renewed {
r.State.cleanAlerts()
}
if err := r.SnapshotData(ctx, poolName); err != nil {
return err
}
if r.State.Status == models.Finished {
r.poolManager.MakeActive(poolElement)
r.State.cleanAlerts()
}
return nil
}
// RefreshData runs a group of data refresh jobs.
func (r *Retrieval) RefreshData(ctx context.Context, poolName string) error {
fsm, err := r.poolManager.GetFSManager(poolName)
if err != nil {
return fmt.Errorf("failed to get %q FSManager: %w", poolName, err)
}
if r.State.Status == models.Refreshing || r.State.Status == models.Snapshotting {
return fmt.Errorf("skip refreshing the data because the pool is still busy: %s", r.State.Status)
}
jobs, err := r.buildJobs(fsm, refreshJobs)
if err != nil {
return fmt.Errorf("failed to build refresh jobs for %s: %w", poolName, err)
}
if len(jobs) == 0 {
log.Dbg("no jobs to refresh pool:", fsm.Pool())
return nil
}
log.Dbg("Refreshing data pool: ", fsm.Pool())
fsm.Pool().SetStatus(resources.RefreshingPool)
r.State.Status = models.Refreshing
r.State.LastRefresh = models.NewLocalTime(time.Now().Truncate(time.Second))
defer func() {
r.State.Status = models.Renewed
if err != nil {
r.State.Status = models.Failed
r.State.addAlert(telemetry.Alert{
Level: models.RefreshFailed,
Message: err.Error(),
})
fsm.Pool().SetStatus(resources.EmptyPool)
}
r.State.CurrentJob = nil
}()
if r.State.Mode == models.Logical {
if err := preparePoolToRefresh(fsm, r.runner); err != nil {
return fmt.Errorf("failed to prepare pool for initial refresh: %w", err)
}
}
for _, j := range jobs {
r.State.CurrentJob = j
if err = j.Run(ctx); err != nil {
return err
}
}
r.State.CurrentJob = nil
return nil
}
// SnapshotData runs a group of data snapshot jobs.
func (r *Retrieval) SnapshotData(ctx context.Context, poolName string) error {
fsm, err := r.poolManager.GetFSManager(poolName)
if err != nil {
return fmt.Errorf("failed to get %q FSManager: %w", poolName, err)
}
if r.State.Status != models.Inactive && r.State.Status != models.Renewed && r.State.Status != models.Finished {
return fmt.Errorf("pool is not ready to take a snapshot: %s", r.State.Status)
}
jobs, err := r.buildJobs(fsm, snapshotJobs)
if err != nil {
return fmt.Errorf("failed to build snapshot jobs for %s: %w", poolName, err)
}
if r.State.Mode == models.Physical {
r.statefulJobs = jobs
}
if len(jobs) == 0 {
log.Dbg("no jobs to snapshot pool data:", fsm.Pool())
return nil
}
log.Dbg("Taking a snapshot on the pool: ", fsm.Pool())
r.State.Status = models.Snapshotting
defer func() {
r.State.Status = models.Finished
if err != nil {
r.State.Status = models.Failed
r.State.addAlert(telemetry.Alert{
Level: models.RefreshFailed,
Message: err.Error(),
})
fsm.Pool().SetStatus(resources.EmptyPool)
}
r.State.CurrentJob = nil
}()
for _, j := range jobs {
r.State.CurrentJob = j
if err = j.Run(ctx); err != nil {
return err
}
}
return nil
}
// buildJobs processes the configuration spec to build data retrieval jobs.
func (r *Retrieval) buildJobs(fsm pool.FSManager, groupName jobGroup) ([]components.JobRunner, error) {
retrievalRunner, err := engine.JobBuilder(r.global, r.engineProps, fsm, r.tm)
if err != nil {
return nil, errors.Wrap(err, "failed to get a job builder")
}
dbMarker := dbmarker.NewMarker(fsm.Pool().DataDir())
jobs := make([]components.JobRunner, 0)
for _, jobName := range r.cfg.Jobs {
jobSpec, ok := r.cfg.JobsSpec[jobName]
if !ok {
return nil, errors.Errorf("job %q not found", jobName)
}
if getJobGroup(jobSpec.Name) != groupName {
log.Dbg(fmt.Sprintf("Skip the %s job because it does not belong to the %s group", jobName, groupName))
continue
}
jobCfg := config.JobConfig{
Spec: jobSpec,
Docker: r.docker,
Marker: dbMarker,
FSPool: fsm.Pool(),
}
job, err := retrievalRunner.BuildJob(jobCfg)
if err != nil {
return nil, errors.Wrap(err, "failed to build job")
}
jobs = append(jobs, job)
}
return jobs, nil
}
func getJobGroup(name string) jobGroup {
switch name {
case logical.DumpJobType, logical.RestoreJobType, physical.RestoreJobType:
return refreshJobs
case snapshot.LogicalSnapshotType, snapshot.PhysicalSnapshotType:
return snapshotJobs
}
return ""
}
func (r *Retrieval) defineRetrievalMode() {
if hasPhysicalJob(r.cfg.JobsSpec) {
r.State.Mode = models.Physical
return
}
if hasLogicalJob(r.cfg.JobsSpec) {
r.State.Mode = models.Logical
return
}
r.State.Mode = models.Unknown
}
func (r *Retrieval) setupScheduler(ctx context.Context) {
r.stopScheduler()
if r.cfg.Refresh == nil || r.cfg.Refresh.Timetable == "" {
return
}
specParser := cron.NewParser(parseOption)
spec, err := specParser.Parse(r.cfg.Refresh.Timetable)
if err != nil {
log.Err(errors.Wrapf(err, "failed to parse schedule timetable %q", r.cfg.Refresh.Timetable))
return
}
r.Scheduler.Cron = cron.New()
r.Scheduler.Spec = spec
r.Scheduler.Cron.Schedule(r.Scheduler.Spec, cron.FuncJob(r.refreshFunc(ctx)))
r.Scheduler.Cron.Start()
}
func (r *Retrieval) refreshFunc(ctx context.Context) func() {
return func() {
if err := r.FullRefresh(ctx); err != nil {
alert := telemetry.Alert{Level: models.RefreshFailed, Message: err.Error()}
r.State.addAlert(alert)
r.tm.SendEvent(ctx, telemetry.AlertEvent, telemetry.Alert{Level: models.RefreshFailed, Message: "Failed to run full-refresh"})
log.Err(alert.Message)
}
}
}
// FullRefresh performs full refresh for an unused storage pool and makes it active.
func (r *Retrieval) FullRefresh(ctx context.Context) error {
if r.State.Status == models.Refreshing || r.State.Status == models.Snapshotting {
alert := telemetry.Alert{
Level: models.RefreshSkipped,
Message: "The data refresh/snapshot is currently in progress. Skip a new data refresh iteration",
}
r.State.addAlert(alert)
r.tm.SendEvent(ctx, telemetry.AlertEvent, alert)
log.Msg(alert.Message)
return nil
}
if r.State.Status == models.Pending {
log.Msg("Data retrieving suspended because Retrieval state is pending")
return nil
}
// Stop previous runs and snapshot schedulers.
if r.ctxCancel != nil {
r.ctxCancel()
}
runCtx, cancel := context.WithCancel(ctx)
r.ctxCancel = cancel
elementToUpdate := r.poolManager.GetPoolToUpdate()
if elementToUpdate == nil || elementToUpdate.Value == nil {
alert := telemetry.Alert{
Level: models.RefreshSkipped,
Message: "Pool to perform full refresh not found. Skip refreshing",
}
r.State.addAlert(alert)
r.tm.SendEvent(ctx, telemetry.AlertEvent, alert)
log.Msg(alert.Message + ". Hint: Check that there is at least one pool that does not have clones running. " +
"Refresh can be performed only to a pool without clones.")
return nil
}
poolToUpdate, err := r.poolManager.GetFSManager(elementToUpdate.Value.(string))
if err != nil {
return errors.Wrap(err, "failed to get FSManager")
}
log.Msg("Pool to a full refresh: ", poolToUpdate.Pool())
// Stop service containers: sync-instance, etc.
if cleanUpErr := cont.CleanUpControlContainers(runCtx, r.docker, r.engineProps.InstanceID); cleanUpErr != nil {
log.Err("Failed to clean up service containers:", cleanUpErr)
return cleanUpErr
}
if err := r.run(runCtx, poolToUpdate); err != nil {
return err
}
r.poolManager.MakeActive(elementToUpdate)
r.State.cleanAlerts()
return nil
}
// Stop stops a retrieval service.
func (r *Retrieval) Stop() {
r.stopScheduler()
}
func (r *Retrieval) stopScheduler() {
if r.Scheduler.Cron != nil {
r.Scheduler.Cron.Stop()
r.Scheduler.Spec = nil
}
}
func preparePoolToRefresh(poolToUpdate pool.FSManager, runner runners.Runner) error {
cloneList, err := poolToUpdate.ListClonesNames()
if err != nil {
return errors.Wrap(err, "failed to check running clones")
}
if len(cloneList) > 0 {
return errors.Errorf("there are active clones in the requested pool: %s\nDestroy them to perform a full refresh",
strings.Join(cloneList, " "))
}
if _, err := runner.Run(fmt.Sprintf("rm -rf %s %s",
filepath.Join(poolToUpdate.Pool().DataDir(), "*"),
filepath.Join(poolToUpdate.Pool().DataDir(), dbmarker.ConfigDir))); err != nil {
return errors.Wrap(err, "failed to clean unix socket directory")
}
poolToUpdate.RefreshSnapshotList()
snapshots := poolToUpdate.SnapshotList()
if len(snapshots) == 0 {
log.Msg(fmt.Sprintf("no snapshots for pool %s", poolToUpdate.Pool().Name))
return nil
}
log.Msg("Preparing pool for full data refresh; existing snapshots are to be destroyed")
for _, snapshotEntry := range snapshots {
log.Msg("Destroying snapshot:", snapshotEntry.ID)
if err := poolToUpdate.DestroySnapshot(snapshotEntry.ID); err != nil {
return errors.Wrap(err, "failed to destroy the existing snapshot")
}
}
return nil
}
// ReportState collects the current restore state.
func (r *Retrieval) ReportState() telemetry.Restore {
var refreshingTimetable string
if r.cfg.Refresh != nil {
refreshingTimetable = r.cfg.Refresh.Timetable
}
return telemetry.Restore{
Mode: r.State.Mode,
Refreshing: refreshingTimetable,
Jobs: r.cfg.Jobs,
}
}
// ErrStageNotFound means that the requested stage is not exist in the retrieval jobs config.
var ErrStageNotFound = errors.New("stage not found")
// JobConfig parses job configuration to the provided structure.
func (r *Retrieval) JobConfig(stage string, jobCfg any) error {
stageSpec, err := r.GetStageSpec(stage)
if err != nil {
return err
}
if err := options.Unmarshal(stageSpec.Options, jobCfg); err != nil {
return fmt.Errorf("failed to unmarshal configuration options: %w", err)
}
return nil
}
// GetStageSpec returns the stage spec if exists.
func (r *Retrieval) GetStageSpec(stage string) (config.JobSpec, error) {
stageSpec, ok := r.cfg.JobsSpec[stage]
if !ok {
return config.JobSpec{}, ErrStageNotFound
}
return stageSpec, nil
}
// ReportSyncStatus return status of sync containers.
func (r *Retrieval) ReportSyncStatus(ctx context.Context) (*models.Sync, error) {
if r.State.Mode != models.Physical {
return &models.Sync{
Status: models.Status{Code: models.SyncStatusNotAvailable},
}, nil
}
filterArgs := filters.NewArgs(
filters.KeyValuePair{Key: "label",
Value: fmt.Sprintf("%s=%s", cont.DBLabControlLabel, cont.DBLabSyncLabel)})
filterArgs.Add("label", fmt.Sprintf("%s=%s", cont.DBLabInstanceIDLabel, r.engineProps.InstanceID))
ids, err := tools.ListContainersByLabel(ctx, r.docker, filterArgs)
if err != nil {
return &models.Sync{
Status: models.Status{Code: models.SyncStatusError, Message: err.Error()},
}, fmt.Errorf("failed to list containers by label %w", err)
}
if len(ids) != 1 {
return &models.Sync{
Status: models.Status{Code: models.SyncStatusError},
}, fmt.Errorf("failed to match sync container")
}
id := ids[0]
sync, err := r.reportContainerSyncStatus(ctx, id)
return sync, err
}
func (r *Retrieval) reportContainerSyncStatus(ctx context.Context, containerID string) (*models.Sync, error) {
resp, err := r.docker.ContainerInspect(ctx, containerID)
if err != nil {
return nil, fmt.Errorf("failed to inspect container %w", err)
}
if resp.State == nil {
return nil, fmt.Errorf("failed to read container state")
}
if resp.State.Health != nil && resp.State.Health.Status == types.Unhealthy {
// in case of Unhealthy state, add health check output to status
var healthCheckOutput = ""
if healthCheckLength := len(resp.State.Health.Log); healthCheckLength > 0 {
if lastHealthCheck := resp.State.Health.Log[healthCheckLength-1]; lastHealthCheck.ExitCode > 1 {
healthCheckOutput = lastHealthCheck.Output
}
}
return &models.Sync{
Status: models.Status{
Code: models.SyncStatusDown,
Message: healthCheckOutput,
},
}, nil
}
firstPool := r.poolManager.First()
if firstPool == nil {
return &models.Sync{
Status: models.Status{
Code: models.SyncStatusError,
Message: "Data pool is not available",
},
}, nil
}
socketPath := filepath.Join(firstPool.Pool().SocketDir(), resp.Name)
value, err := status.FetchSyncMetrics(ctx, r.global, socketPath)
if err != nil {
log.Warn("Failed to fetch synchronization metrics", err)
return &models.Sync{
Status: models.Status{
Code: models.SyncStatusError,
Message: err.Error(),
},
}, nil
}
value.StartedAt = resp.State.StartedAt
return value, nil
}