mirror of
https://github.com/kopia/kopia.git
synced 2025-12-23 22:57:50 -05:00
0f7253eb66
This is a breaking change to users who might be using Kopia as a library.
### Log Format
```json
{"t":"<timestamp-rfc-3389-microseconds>", "span:T1":"V1", "span:T2":"V2", "n":"<source>", "m":"<message>", /*parameters*/}
```
Where each record is associated with one or more spans that describe its scope:
* `"span:client": "<hash-of-username@hostname>"`
* `"span:repo": "<random>"` - random identifier of a repository connection (from `repo.Open`)
* `"span:maintenance": "<random>"` - random identifier of a maintenance session
* `"span:upload": "<hash-of-username@host:/path>"` - uniquely identifies upload session of a given directory
* `"span:checkpoint": "<random>"` - encapsulates each checkpoint operation during Upload
* `"span:server-session": "<random>"` -single client connection to the server
* `"span:flush": "<random>"` - encapsulates each Flush session
* `"span:maintenance": "<random>"` - encapsulates each maintenance operation
* `"span:loadIndex" : "<random>"` - encapsulates index loading operation
* `"span:emr" : "<random>"` - encapsulates epoch manager refresh
* `"span:writePack": "<pack-blob-ID>"` - encapsulates pack blob preparation and writing
(plus additional minor spans for various phases of the maintenance).
Notable points:
- Used internal zero allocation JSON writer for reduced memory usage.
- renamed `--disable-internal-log` to `--disable-repository-log` (controls saving blobs to repository)
- added `--disable-content-log` (controls writing of `content-log` files)
- all storage operations are also logged in a structural way and associated with the corresponding spans.
- all content IDs are logged in a truncated format (since first N bytes that are usually enough to be unique) to improve compressibility of logs (blob IDs are frequently repeated but content IDs usually appear just once).
This format should make it possible to recreate the journey of any single content throughout pack blobs, indexes and compaction events.
56 lines
1.4 KiB
Go
56 lines
1.4 KiB
Go
package cli
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/kopia/kopia/repo"
|
|
"github.com/kopia/kopia/repo/maintenance"
|
|
)
|
|
|
|
type commandLogsCleanup struct {
|
|
maxTotalSizeMB int64
|
|
maxCount int
|
|
maxAge time.Duration
|
|
dryRun bool
|
|
}
|
|
|
|
func (c *commandLogsCleanup) setup(svc appServices, parent commandParent) {
|
|
cmd := parent.Command("cleanup", "Clean up logs")
|
|
|
|
cmd.Flag("max-age", "Maximal age").Default("720h").DurationVar(&c.maxAge)
|
|
cmd.Flag("max-count", "Maximal number of files to keep").Default("10000").IntVar(&c.maxCount)
|
|
cmd.Flag("max-total-size-mb", "Maximal total size in MiB").Default("1024").Int64Var(&c.maxTotalSizeMB)
|
|
cmd.Flag("dry-run", "Do not delete").BoolVar(&c.dryRun)
|
|
|
|
cmd.Action(svc.directRepositoryWriteAction(c.run))
|
|
}
|
|
|
|
func (c *commandLogsCleanup) run(ctx context.Context, rep repo.DirectRepositoryWriter) error {
|
|
rep.LogManager().Disable()
|
|
|
|
toDelete, err := maintenance.CleanupLogs(ctx, rep, maintenance.LogRetentionOptions{
|
|
MaxTotalSize: c.maxTotalSizeMB << 20, //nolint:mnd
|
|
MaxCount: c.maxCount,
|
|
MaxAge: c.maxAge,
|
|
DryRun: c.dryRun,
|
|
})
|
|
if err != nil {
|
|
return errors.Wrap(err, "error expiring logs")
|
|
}
|
|
|
|
if len(toDelete) > 0 {
|
|
if c.dryRun {
|
|
log(ctx).Infof("Would delete %v logs.", len(toDelete))
|
|
} else {
|
|
log(ctx).Infof("Deleted %v logs.", len(toDelete))
|
|
}
|
|
} else {
|
|
log(ctx).Info("No logs found to delete.")
|
|
}
|
|
|
|
return nil
|
|
}
|