mirror/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2024-12-22 07:43:03 +00:00
Code Issues Releases Wiki Activity

cmd_rewrite: add capability to add snapshot summary data to an existing snapshot.

Browse source 
Changes to the code as requested.
This commit is contained in:
Winfried Plappert 2024-12-19 21:43:20 +00:00
parent 1d4d9388f8
commit edde316a14
2 changed files with 33 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
changelog/unreleased/issue-4942
View file

@ -1,10 +1,8 @@
Enhancement: create snapshot summary statistics for snapshots which don't have them
When restic rewrite is used with the --snapshot-summary [-s] option,
When restic rewrite is used with the --snapshot-summary option,
a new snapshot is created containing statistics summary data. Only two fields
will be non-zero: TotalFilesProcessed and TotalBytesProcessed.
There is a logic change in cmd_rewrite: statistics data will always be attached,
even if the old snapshot(s) did not contain summary data.
https://github.com/restic/restic/issues/4942
https://github.com/restic/restic/pull/5185

54
cmd/restic/cmd_rewrite.go
View file

@ -35,7 +35,8 @@ Please note that the --forget option only removes the snapshots and not the actu
data stored in the repository. In order to delete the no longer referenced data,
use the "prune" command.
The option --snapshot-summary [-s] creates a new snapshot with snapshot summary data attached.
The option --snapshot-summary creates a new snapshot with snapshot summary data attached.
This will only happen when there is no pre-existing snapshot summary record.
Only the two fields TotalFilesProcessed and TotalBytesProcessed are non-zero.
EXIT STATUS
@ -130,7 +131,15 @@ func rewriteSnapshot(ctx context.Context, repo *repository.Repository, sn *resti
}
var filter rewriteFilterFunc
var rewriteNode walker.NodeRewriteFunc
rewriteTag := "rewrite"
if opts.SnapshotSummary && sn.Summary != nil {
// skip snapshots which already have a summary section
return false, nil
}
if len(rejectByNameFuncs) > 0 || opts.SnapshotSummary {
if len(rejectByNameFuncs) > 0 {
selectByName := func(nodepath string) bool {
for _, reject := range rejectByNameFuncs {
@ -141,39 +150,20 @@ func rewriteSnapshot(ctx context.Context, repo *repository.Repository, sn *resti
return true
}
rewriteNode := func(node *restic.Node, path string) *restic.Node {
rewriteNode = func(node *restic.Node, path string) *restic.Node {
if selectByName(path) {
return node
}
Verbosef("excluding %s\n", path)
return nil
}
rewriter, querySize := walker.NewSnapshotSizeRewriter(rewriteNode)
filter = func(ctx context.Context, sn *restic.Snapshot) (restic.ID, error) {
id, err := rewriter.RewriteTree(ctx, repo, "/", *sn.Tree)
if err != nil {
return restic.ID{}, err
}
ss := querySize()
if sn.Summary == nil { // change of logic: create summary if it wasn't there before
sn.Summary = &restic.SnapshotSummary{}
}
sn.Summary.TotalFilesProcessed = ss.FileCount
sn.Summary.TotalBytesProcessed = ss.FileSize
return id, err
}
} else if opts.SnapshotSummary {
if sn.Summary != nil {
Printf("snapshot %s has already got snapshot summary data\n", sn.ID().Str())
return false, nil
}
rewriteNode := func(node *restic.Node, path string) *restic.Node {
} else {
rewriteNode = func(node *restic.Node, path string) *restic.Node {
return node
}
rewriteTag = "snap-summary"
}
rewriter, querySize := walker.NewSnapshotSizeRewriter(rewriteNode)
@ -188,22 +178,17 @@ func rewriteSnapshot(ctx context.Context, repo *repository.Repository, sn *resti
}
sn.Summary.TotalFilesProcessed = ss.FileCount
sn.Summary.TotalBytesProcessed = ss.FileSize
Verbosef("totalFilesProcessed %12d\n", ss.FileCount)
Verbosef("totalBytesProcessed %12d\n", ss.FileSize)
return id, nil
return id, err
}
} else {
// TODO: question: should metadata modification be changed so that
// snapshot summary data always will be created??
filter = func(_ context.Context, sn *restic.Snapshot) (restic.ID, error) {
return *sn.Tree, nil
}
}
return filterAndReplaceSnapshot(ctx, repo, sn,
filter, opts.DryRun, opts.Forget, metadata, "rewrite")
filter, opts.DryRun, opts.Forget, metadata, rewriteTag)
}
func filterAndReplaceSnapshot(ctx context.Context, repo restic.Repository, sn *restic.Snapshot,
@ -240,7 +225,7 @@ func filterAndReplaceSnapshot(ctx context.Context, repo restic.Repository, sn *r
return true, nil
}
if filteredTree == *sn.Tree && newMetadata == nil && sn.Summary == nil {
if filteredTree == *sn.Tree && newMetadata == nil && addTag != "snap-summary" {
debug.Log("Snapshot %v not modified", sn)
return false, nil
}
@ -267,7 +252,6 @@ func filterAndReplaceSnapshot(ctx context.Context, repo restic.Repository, sn *r
// Always set the original snapshot id as this essentially a new snapshot.
sn.Original = sn.ID()
sn.Tree = &filteredTree
sn.ProgramVersion = version
if !forget {
sn.AddTags([]string{addTag})