mirror of
https://github.com/restic/restic.git
synced 2024-12-23 00:07:25 +00:00
88f59fc2d6
This keeps backwards compatibility with the previous empty structs. And maybe we'd want to put other fields into the inner struct later, rather than the outer message.
248 lines
7.6 KiB
Go
248 lines
7.6 KiB
Go
package backup
|
|
|
|
import (
|
|
"sort"
|
|
"time"
|
|
|
|
"github.com/restic/restic/internal/archiver"
|
|
"github.com/restic/restic/internal/restic"
|
|
"github.com/restic/restic/internal/ui"
|
|
)
|
|
|
|
// JSONProgress reports progress for the `backup` command in JSON.
|
|
type JSONProgress struct {
|
|
*ui.Message
|
|
|
|
term ui.Terminal
|
|
v uint
|
|
}
|
|
|
|
// assert that Backup implements the ProgressPrinter interface
|
|
var _ ProgressPrinter = &JSONProgress{}
|
|
|
|
// NewJSONProgress returns a new backup progress reporter.
|
|
func NewJSONProgress(term ui.Terminal, verbosity uint) *JSONProgress {
|
|
return &JSONProgress{
|
|
Message: ui.NewMessage(term, verbosity),
|
|
term: term,
|
|
v: verbosity,
|
|
}
|
|
}
|
|
|
|
func (b *JSONProgress) print(status interface{}) {
|
|
b.term.Print(ui.ToJSONString(status))
|
|
}
|
|
|
|
func (b *JSONProgress) error(status interface{}) {
|
|
b.term.Error(ui.ToJSONString(status))
|
|
}
|
|
|
|
// Update updates the status lines.
|
|
func (b *JSONProgress) Update(total, processed Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) {
|
|
status := statusUpdate{
|
|
MessageType: "status",
|
|
SecondsElapsed: uint64(time.Since(start) / time.Second),
|
|
SecondsRemaining: secs,
|
|
TotalFiles: total.Files,
|
|
FilesDone: processed.Files,
|
|
TotalBytes: total.Bytes,
|
|
BytesDone: processed.Bytes,
|
|
ErrorCount: errors,
|
|
}
|
|
|
|
if total.Bytes > 0 {
|
|
status.PercentDone = float64(processed.Bytes) / float64(total.Bytes)
|
|
}
|
|
|
|
for filename := range currentFiles {
|
|
status.CurrentFiles = append(status.CurrentFiles, filename)
|
|
}
|
|
sort.Strings(status.CurrentFiles)
|
|
|
|
b.print(status)
|
|
}
|
|
|
|
// ScannerError is the error callback function for the scanner, it prints the
|
|
// error in verbose mode and returns nil.
|
|
func (b *JSONProgress) ScannerError(item string, err error) error {
|
|
b.error(errorUpdate{
|
|
MessageType: "error",
|
|
Error: errorObject{err.Error()},
|
|
During: "scan",
|
|
Item: item,
|
|
})
|
|
return nil
|
|
}
|
|
|
|
// Error is the error callback function for the archiver, it prints the error and returns nil.
|
|
func (b *JSONProgress) Error(item string, err error) error {
|
|
b.error(errorUpdate{
|
|
MessageType: "error",
|
|
Error: errorObject{err.Error()},
|
|
During: "archival",
|
|
Item: item,
|
|
})
|
|
return nil
|
|
}
|
|
|
|
// CompleteItem is the status callback function for the archiver when a
|
|
// file/dir has been saved successfully.
|
|
func (b *JSONProgress) CompleteItem(messageType, item string, s archiver.ItemStats, d time.Duration) {
|
|
if b.v < 2 {
|
|
return
|
|
}
|
|
|
|
switch messageType {
|
|
case "dir new":
|
|
b.print(verboseUpdate{
|
|
MessageType: "verbose_status",
|
|
Action: "new",
|
|
Item: item,
|
|
Duration: d.Seconds(),
|
|
DataSize: s.DataSize,
|
|
DataSizeInRepo: s.DataSizeInRepo,
|
|
MetadataSize: s.TreeSize,
|
|
MetadataSizeInRepo: s.TreeSizeInRepo,
|
|
})
|
|
case "dir unchanged":
|
|
b.print(verboseUpdate{
|
|
MessageType: "verbose_status",
|
|
Action: "unchanged",
|
|
Item: item,
|
|
})
|
|
case "dir modified":
|
|
b.print(verboseUpdate{
|
|
MessageType: "verbose_status",
|
|
Action: "modified",
|
|
Item: item,
|
|
Duration: d.Seconds(),
|
|
DataSize: s.DataSize,
|
|
DataSizeInRepo: s.DataSizeInRepo,
|
|
MetadataSize: s.TreeSize,
|
|
MetadataSizeInRepo: s.TreeSizeInRepo,
|
|
})
|
|
case "file new":
|
|
b.print(verboseUpdate{
|
|
MessageType: "verbose_status",
|
|
Action: "new",
|
|
Item: item,
|
|
Duration: d.Seconds(),
|
|
DataSize: s.DataSize,
|
|
DataSizeInRepo: s.DataSizeInRepo,
|
|
})
|
|
case "file unchanged":
|
|
b.print(verboseUpdate{
|
|
MessageType: "verbose_status",
|
|
Action: "unchanged",
|
|
Item: item,
|
|
})
|
|
case "file modified":
|
|
b.print(verboseUpdate{
|
|
MessageType: "verbose_status",
|
|
Action: "modified",
|
|
Item: item,
|
|
Duration: d.Seconds(),
|
|
DataSize: s.DataSize,
|
|
DataSizeInRepo: s.DataSizeInRepo,
|
|
})
|
|
}
|
|
}
|
|
|
|
// ReportTotal sets the total stats up to now
|
|
func (b *JSONProgress) ReportTotal(start time.Time, s archiver.ScanStats) {
|
|
if b.v >= 2 {
|
|
b.print(verboseUpdate{
|
|
MessageType: "verbose_status",
|
|
Action: "scan_finished",
|
|
Duration: time.Since(start).Seconds(),
|
|
DataSize: s.Bytes,
|
|
TotalFiles: s.Files,
|
|
})
|
|
}
|
|
}
|
|
|
|
// Finish prints the finishing messages.
|
|
func (b *JSONProgress) Finish(snapshotID restic.ID, start time.Time, summary *archiver.Summary, dryRun bool) {
|
|
id := ""
|
|
// empty if snapshot creation was skipped
|
|
if !snapshotID.IsNull() {
|
|
id = snapshotID.String()
|
|
}
|
|
b.print(summaryOutput{
|
|
MessageType: "summary",
|
|
FilesNew: summary.Files.New,
|
|
FilesChanged: summary.Files.Changed,
|
|
FilesUnmodified: summary.Files.Unchanged,
|
|
DirsNew: summary.Dirs.New,
|
|
DirsChanged: summary.Dirs.Changed,
|
|
DirsUnmodified: summary.Dirs.Unchanged,
|
|
DataBlobs: summary.ItemStats.DataBlobs,
|
|
TreeBlobs: summary.ItemStats.TreeBlobs,
|
|
DataAdded: summary.ItemStats.DataSize + summary.ItemStats.TreeSize,
|
|
DataAddedPacked: summary.ItemStats.DataSizeInRepo + summary.ItemStats.TreeSizeInRepo,
|
|
TotalFilesProcessed: summary.Files.New + summary.Files.Changed + summary.Files.Unchanged,
|
|
TotalBytesProcessed: summary.ProcessedBytes,
|
|
TotalDuration: time.Since(start).Seconds(),
|
|
SnapshotID: id,
|
|
DryRun: dryRun,
|
|
})
|
|
}
|
|
|
|
// Reset no-op
|
|
func (b *JSONProgress) Reset() {
|
|
}
|
|
|
|
type statusUpdate struct {
|
|
MessageType string `json:"message_type"` // "status"
|
|
SecondsElapsed uint64 `json:"seconds_elapsed,omitempty"`
|
|
SecondsRemaining uint64 `json:"seconds_remaining,omitempty"`
|
|
PercentDone float64 `json:"percent_done"`
|
|
TotalFiles uint64 `json:"total_files,omitempty"`
|
|
FilesDone uint64 `json:"files_done,omitempty"`
|
|
TotalBytes uint64 `json:"total_bytes,omitempty"`
|
|
BytesDone uint64 `json:"bytes_done,omitempty"`
|
|
ErrorCount uint `json:"error_count,omitempty"`
|
|
CurrentFiles []string `json:"current_files,omitempty"`
|
|
}
|
|
|
|
type errorObject struct {
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
type errorUpdate struct {
|
|
MessageType string `json:"message_type"` // "error"
|
|
Error errorObject `json:"error"`
|
|
During string `json:"during"`
|
|
Item string `json:"item"`
|
|
}
|
|
|
|
type verboseUpdate struct {
|
|
MessageType string `json:"message_type"` // "verbose_status"
|
|
Action string `json:"action"`
|
|
Item string `json:"item"`
|
|
Duration float64 `json:"duration"` // in seconds
|
|
DataSize uint64 `json:"data_size"`
|
|
DataSizeInRepo uint64 `json:"data_size_in_repo"`
|
|
MetadataSize uint64 `json:"metadata_size"`
|
|
MetadataSizeInRepo uint64 `json:"metadata_size_in_repo"`
|
|
TotalFiles uint `json:"total_files"`
|
|
}
|
|
|
|
type summaryOutput struct {
|
|
MessageType string `json:"message_type"` // "summary"
|
|
FilesNew uint `json:"files_new"`
|
|
FilesChanged uint `json:"files_changed"`
|
|
FilesUnmodified uint `json:"files_unmodified"`
|
|
DirsNew uint `json:"dirs_new"`
|
|
DirsChanged uint `json:"dirs_changed"`
|
|
DirsUnmodified uint `json:"dirs_unmodified"`
|
|
DataBlobs int `json:"data_blobs"`
|
|
TreeBlobs int `json:"tree_blobs"`
|
|
DataAdded uint64 `json:"data_added"`
|
|
DataAddedPacked uint64 `json:"data_added_packed"`
|
|
TotalFilesProcessed uint `json:"total_files_processed"`
|
|
TotalBytesProcessed uint64 `json:"total_bytes_processed"`
|
|
TotalDuration float64 `json:"total_duration"` // in seconds
|
|
SnapshotID string `json:"snapshot_id,omitempty"`
|
|
DryRun bool `json:"dry_run,omitempty"`
|
|
}
|