X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0bb53c1cbcbcb8b3be50e6ecf3fdf0bb7cbd96b5..8a27fe370239ecb8e50d53f46b45ed61203a35ca:/services/keepstore/s3_volume.go diff --git a/services/keepstore/s3_volume.go b/services/keepstore/s3_volume.go index 9fc87045e0..ee89b156f7 100644 --- a/services/keepstore/s3_volume.go +++ b/services/keepstore/s3_volume.go @@ -2,9 +2,10 @@ // // SPDX-License-Identifier: AGPL-3.0 -package main +package keepstore import ( + "bufio" "bytes" "context" "crypto/sha256" @@ -15,7 +16,6 @@ import ( "fmt" "io" "io/ioutil" - "log" "net/http" "os" "regexp" @@ -24,7 +24,7 @@ import ( "sync/atomic" "time" - "git.curoverse.com/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/arvados" "github.com/AdRoll/goamz/aws" "github.com/AdRoll/goamz/s3" "github.com/prometheus/client_golang/prometheus" @@ -32,21 +32,22 @@ import ( ) func init() { - driver["S3"] = newS3Volume + driver["S3"] = chooseS3VolumeDriver } func newS3Volume(cluster *arvados.Cluster, volume arvados.Volume, logger logrus.FieldLogger, metrics *volumeMetricsVecs) (Volume, error) { - v := &S3Volume{cluster: cluster, volume: volume, logger: logger, metrics: metrics} - err := json.Unmarshal(volume.DriverParameters, &v) + v := &S3Volume{cluster: cluster, volume: volume, metrics: metrics} + err := json.Unmarshal(volume.DriverParameters, v) if err != nil { return nil, err } + v.logger = logger.WithField("Volume", v.String()) return v, v.check() } func (v *S3Volume) check() error { - if v.Bucket == "" || v.AccessKey == "" || v.SecretKey == "" { - return errors.New("DriverParameters: Bucket, AccessKey, and SecretKey must be provided") + if v.Bucket == "" { + return errors.New("DriverParameters: Bucket must be provided") } if v.IndexPageSize == 0 { v.IndexPageSize = 1000 @@ -55,7 +56,8 @@ func (v *S3Volume) check() error { return errors.New("DriverParameters: RaceWindow must not be negative") } - region, ok := aws.Regions[v.Region] + var ok bool + v.region, ok = aws.Regions[v.Region] if v.Endpoint == "" { if !ok { return fmt.Errorf("unrecognized region %+q; try specifying endpoint instead", v.Region) @@ -64,18 +66,13 @@ func (v *S3Volume) check() error { return fmt.Errorf("refusing to use AWS region name %+q with endpoint %+q; "+ "specify empty endpoint or use a different region name", v.Region, v.Endpoint) } else { - region = aws.Region{ + v.region = aws.Region{ Name: v.Region, S3Endpoint: v.Endpoint, S3LocationConstraint: v.LocationConstraint, } } - auth := aws.Auth{ - AccessKey: v.AccessKey, - SecretKey: v.SecretKey, - } - // Zero timeouts mean "wait forever", which is a bad // default. Default to long timeouts instead. if v.ConnectTimeout == 0 { @@ -85,16 +82,9 @@ func (v *S3Volume) check() error { v.ReadTimeout = s3DefaultReadTimeout } - client := s3.New(auth, region) - if region.EC2Endpoint.Signer == aws.V4Signature { - // Currently affects only eu-central-1 - client.Signature = aws.V4Signature - } - client.ConnectTimeout = time.Duration(v.ConnectTimeout) - client.ReadTimeout = time.Duration(v.ReadTimeout) v.bucket = &s3bucket{ - Bucket: &s3.Bucket{ - S3: client, + bucket: &s3.Bucket{ + S3: v.newS3Client(), Name: v.Bucket, }, } @@ -102,6 +92,11 @@ func (v *S3Volume) check() error { lbls := prometheus.Labels{"device_id": v.GetDeviceID()} v.bucket.stats.opsCounters, v.bucket.stats.errCounters, v.bucket.stats.ioBytes = v.metrics.getCounterVecsFor(lbls) + err := v.bootstrapIAMCredentials() + if err != nil { + return fmt.Errorf("error getting IAM credentials: %s", err) + } + return nil } @@ -134,23 +129,16 @@ func s3regions() (okList []string) { // S3Volume implements Volume using an S3 bucket. type S3Volume struct { - AccessKey string - SecretKey string - Endpoint string - Region string - Bucket string - LocationConstraint bool - IndexPageSize int - ConnectTimeout arvados.Duration - ReadTimeout arvados.Duration - RaceWindow arvados.Duration - UnsafeDelete bool + arvados.S3VolumeDriverParameters + AuthToken string // populated automatically when IAMRole is used + AuthExpiration time.Time // populated automatically when IAMRole is used cluster *arvados.Cluster volume arvados.Volume logger logrus.FieldLogger metrics *volumeMetricsVecs bucket *s3bucket + region aws.Region startOnce sync.Once } @@ -159,17 +147,151 @@ func (v *S3Volume) GetDeviceID() string { return "s3://" + v.Endpoint + "/" + v.Bucket } -func (v *S3Volume) getReaderWithContext(ctx context.Context, loc string) (rdr io.ReadCloser, err error) { +func (v *S3Volume) bootstrapIAMCredentials() error { + if v.AccessKeyID != "" || v.SecretAccessKey != "" { + if v.IAMRole != "" { + return errors.New("invalid DriverParameters: AccessKeyID and SecretAccessKey must be blank if IAMRole is specified") + } + return nil + } + ttl, err := v.updateIAMCredentials() + if err != nil { + return err + } + go func() { + for { + time.Sleep(ttl) + ttl, err = v.updateIAMCredentials() + if err != nil { + v.logger.WithError(err).Warnf("failed to update credentials for IAM role %q", v.IAMRole) + ttl = time.Second + } else if ttl < time.Second { + v.logger.WithField("TTL", ttl).Warnf("received stale credentials for IAM role %q", v.IAMRole) + ttl = time.Second + } + } + }() + return nil +} + +func (v *S3Volume) newS3Client() *s3.S3 { + auth := aws.NewAuth(v.AccessKeyID, v.SecretAccessKey, v.AuthToken, v.AuthExpiration) + client := s3.New(*auth, v.region) + if !v.V2Signature { + client.Signature = aws.V4Signature + } + client.ConnectTimeout = time.Duration(v.ConnectTimeout) + client.ReadTimeout = time.Duration(v.ReadTimeout) + return client +} + +// returned by AWS metadata endpoint .../security-credentials/${rolename} +type iamCredentials struct { + Code string + LastUpdated time.Time + Type string + AccessKeyID string + SecretAccessKey string + Token string + Expiration time.Time +} + +// Returns TTL of updated credentials, i.e., time to sleep until next +// update. +func (v *S3Volume) updateIAMCredentials() (time.Duration, error) { + ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(time.Minute)) + defer cancel() + + metadataBaseURL := "http://169.254.169.254/latest/meta-data/iam/security-credentials/" + + var url string + if strings.Contains(v.IAMRole, "://") { + // Configuration provides complete URL (used by tests) + url = v.IAMRole + } else if v.IAMRole != "" { + // Configuration provides IAM role name and we use the + // AWS metadata endpoint + url = metadataBaseURL + v.IAMRole + } else { + url = metadataBaseURL + v.logger.WithField("URL", url).Debug("looking up IAM role name") + req, err := http.NewRequest("GET", url, nil) + if err != nil { + return 0, fmt.Errorf("error setting up request %s: %s", url, err) + } + resp, err := http.DefaultClient.Do(req.WithContext(ctx)) + if err != nil { + return 0, fmt.Errorf("error getting %s: %s", url, err) + } + defer resp.Body.Close() + if resp.StatusCode == http.StatusNotFound { + return 0, fmt.Errorf("this instance does not have an IAM role assigned -- either assign a role, or configure AccessKeyID and SecretAccessKey explicitly in DriverParameters (error getting %s: HTTP status %s)", url, resp.Status) + } else if resp.StatusCode != http.StatusOK { + return 0, fmt.Errorf("error getting %s: HTTP status %s", url, resp.Status) + } + body := bufio.NewReader(resp.Body) + var role string + _, err = fmt.Fscanf(body, "%s\n", &role) + if err != nil { + return 0, fmt.Errorf("error reading response from %s: %s", url, err) + } + if n, _ := body.Read(make([]byte, 64)); n > 0 { + v.logger.Warnf("ignoring additional data returned by metadata endpoint %s after the single role name that we expected", url) + } + v.logger.WithField("Role", role).Debug("looked up IAM role name") + url = url + role + } + + v.logger.WithField("URL", url).Debug("getting credentials") + req, err := http.NewRequest("GET", url, nil) + if err != nil { + return 0, fmt.Errorf("error setting up request %s: %s", url, err) + } + resp, err := http.DefaultClient.Do(req.WithContext(ctx)) + if err != nil { + return 0, fmt.Errorf("error getting %s: %s", url, err) + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return 0, fmt.Errorf("error getting %s: HTTP status %s", url, resp.Status) + } + var cred iamCredentials + err = json.NewDecoder(resp.Body).Decode(&cred) + if err != nil { + return 0, fmt.Errorf("error decoding credentials from %s: %s", url, err) + } + v.AccessKeyID, v.SecretAccessKey, v.AuthToken, v.AuthExpiration = cred.AccessKeyID, cred.SecretAccessKey, cred.Token, cred.Expiration + v.bucket.SetBucket(&s3.Bucket{ + S3: v.newS3Client(), + Name: v.Bucket, + }) + // TTL is time from now to expiration, minus 5m. "We make new + // credentials available at least five minutes before the + // expiration of the old credentials." -- + // https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#instance-metadata-security-credentials + // (If that's not true, the returned ttl might be zero or + // negative, which the caller can handle.) + ttl := cred.Expiration.Sub(time.Now()) - 5*time.Minute + v.logger.WithFields(logrus.Fields{ + "AccessKeyID": cred.AccessKeyID, + "LastUpdated": cred.LastUpdated, + "Expiration": cred.Expiration, + "TTL": arvados.Duration(ttl), + }).Debug("updated credentials") + return ttl, nil +} + +func (v *S3Volume) getReaderWithContext(ctx context.Context, key string) (rdr io.ReadCloser, err error) { ready := make(chan bool) go func() { - rdr, err = v.getReader(loc) + rdr, err = v.getReader(key) close(ready) }() select { case <-ready: return case <-ctx.Done(): - v.logger.Debugf("s3: abandoning getReader(): %s", ctx.Err()) + v.logger.Debugf("s3: abandoning getReader(%s): %s", key, ctx.Err()) go func() { <-ready if err == nil { @@ -185,28 +307,28 @@ func (v *S3Volume) getReaderWithContext(ctx context.Context, loc string) (rdr io // In situations where (Bucket)GetReader would fail because the block // disappeared in a Trash race, getReader calls fixRace to recover the // data, and tries again. -func (v *S3Volume) getReader(loc string) (rdr io.ReadCloser, err error) { - rdr, err = v.bucket.GetReader(loc) +func (v *S3Volume) getReader(key string) (rdr io.ReadCloser, err error) { + rdr, err = v.bucket.GetReader(key) err = v.translateError(err) if err == nil || !os.IsNotExist(err) { return } - _, err = v.bucket.Head("recent/"+loc, nil) + _, err = v.bucket.Head("recent/"+key, nil) err = v.translateError(err) if err != nil { // If we can't read recent/X, there's no point in // trying fixRace. Give up. return } - if !v.fixRace(loc) { + if !v.fixRace(key) { err = os.ErrNotExist return } - rdr, err = v.bucket.GetReader(loc) + rdr, err = v.bucket.GetReader(key) if err != nil { - log.Printf("warning: reading %s after successful fixRace: %s", loc, err) + v.logger.Warnf("reading %s after successful fixRace: %s", key, err) err = v.translateError(err) } return @@ -215,7 +337,8 @@ func (v *S3Volume) getReader(loc string) (rdr io.ReadCloser, err error) { // Get a block: copy the block data into buf, and return the number of // bytes copied. func (v *S3Volume) Get(ctx context.Context, loc string, buf []byte) (int, error) { - rdr, err := v.getReaderWithContext(ctx, loc) + key := v.key(loc) + rdr, err := v.getReaderWithContext(ctx, key) if err != nil { return 0, err } @@ -251,9 +374,10 @@ func (v *S3Volume) Get(ctx context.Context, loc string, buf []byte) (int, error) // Compare the given data with the stored data. func (v *S3Volume) Compare(ctx context.Context, loc string, expect []byte) error { + key := v.key(loc) errChan := make(chan error, 1) go func() { - _, err := v.bucket.Head("recent/"+loc, nil) + _, err := v.bucket.Head("recent/"+key, nil) errChan <- err }() var err error @@ -285,7 +409,7 @@ func (v *S3Volume) Compare(ctx context.Context, loc string, expect []byte) error // problem on to our clients. return v.translateError(err) } - rdr, err := v.getReaderWithContext(ctx, loc) + rdr, err := v.getReaderWithContext(ctx, key) if err != nil { return err } @@ -316,6 +440,8 @@ func (v *S3Volume) Put(ctx context.Context, loc string, block []byte) error { opts.ContentSHA256 = fmt.Sprintf("%x", sha256.Sum256(block)) } + key := v.key(loc) + // Send the block data through a pipe, so that (if we need to) // we can close the pipe early and abandon our PutReader() // goroutine, without worrying about PutReader() accessing our @@ -331,19 +457,19 @@ func (v *S3Volume) Put(ctx context.Context, loc string, block []byte) error { go func() { defer func() { if ctx.Err() != nil { - v.logger.Debugf("%s: abandoned PutReader goroutine finished with err: %s", v, err) + v.logger.Debugf("abandoned PutReader goroutine finished with err: %s", err) } }() defer close(ready) - err = v.bucket.PutReader(loc, bufr, int64(size), "application/octet-stream", s3ACL, opts) + err = v.bucket.PutReader(key, bufr, int64(size), "application/octet-stream", s3ACL, opts) if err != nil { return } - err = v.bucket.PutReader("recent/"+loc, nil, 0, "application/octet-stream", s3ACL, s3.Options{}) + err = v.bucket.PutReader("recent/"+key, nil, 0, "application/octet-stream", s3ACL, s3.Options{}) }() select { case <-ctx.Done(): - v.logger.Debugf("%s: taking PutReader's input away: %s", v, ctx.Err()) + v.logger.Debugf("taking PutReader's input away: %s", ctx.Err()) // Our pipe might be stuck in Write(), waiting for // PutReader() to read. If so, un-stick it. This means // PutReader will get corrupt data, but that's OK: the @@ -351,7 +477,7 @@ func (v *S3Volume) Put(ctx context.Context, loc string, block []byte) error { go io.Copy(ioutil.Discard, bufr) // CloseWithError() will return once pending I/O is done. bufw.CloseWithError(ctx.Err()) - v.logger.Debugf("%s: abandoning PutReader goroutine", v) + v.logger.Debugf("abandoning PutReader goroutine") return ctx.Err() case <-ready: // Unblock pipe in case PutReader did not consume it. @@ -365,37 +491,39 @@ func (v *S3Volume) Touch(loc string) error { if v.volume.ReadOnly { return MethodDisabledError } - _, err := v.bucket.Head(loc, nil) + key := v.key(loc) + _, err := v.bucket.Head(key, nil) err = v.translateError(err) - if os.IsNotExist(err) && v.fixRace(loc) { + if os.IsNotExist(err) && v.fixRace(key) { // The data object got trashed in a race, but fixRace // rescued it. } else if err != nil { return err } - err = v.bucket.PutReader("recent/"+loc, nil, 0, "application/octet-stream", s3ACL, s3.Options{}) + err = v.bucket.PutReader("recent/"+key, nil, 0, "application/octet-stream", s3ACL, s3.Options{}) return v.translateError(err) } // Mtime returns the stored timestamp for the given locator. func (v *S3Volume) Mtime(loc string) (time.Time, error) { - _, err := v.bucket.Head(loc, nil) + key := v.key(loc) + _, err := v.bucket.Head(key, nil) if err != nil { return zeroTime, v.translateError(err) } - resp, err := v.bucket.Head("recent/"+loc, nil) + resp, err := v.bucket.Head("recent/"+key, nil) err = v.translateError(err) if os.IsNotExist(err) { // The data object X exists, but recent/X is missing. - err = v.bucket.PutReader("recent/"+loc, nil, 0, "application/octet-stream", s3ACL, s3.Options{}) + err = v.bucket.PutReader("recent/"+key, nil, 0, "application/octet-stream", s3ACL, s3.Options{}) if err != nil { - log.Printf("error: creating %q: %s", "recent/"+loc, err) + v.logger.WithError(err).Errorf("error creating %q", "recent/"+key) return zeroTime, v.translateError(err) } - log.Printf("info: created %q to migrate existing block to new storage scheme", "recent/"+loc) - resp, err = v.bucket.Head("recent/"+loc, nil) + v.logger.Infof("created %q to migrate existing block to new storage scheme", "recent/"+key) + resp, err = v.bucket.Head("recent/"+key, nil) if err != nil { - log.Printf("error: created %q but HEAD failed: %s", "recent/"+loc, err) + v.logger.WithError(err).Errorf("HEAD failed after creating %q", "recent/"+key) return zeroTime, v.translateError(err) } } else if err != nil { @@ -410,14 +538,16 @@ func (v *S3Volume) Mtime(loc string) (time.Time, error) { func (v *S3Volume) IndexTo(prefix string, writer io.Writer) error { // Use a merge sort to find matching sets of X and recent/X. dataL := s3Lister{ - Bucket: v.bucket.Bucket, - Prefix: prefix, + Logger: v.logger, + Bucket: v.bucket.Bucket(), + Prefix: v.key(prefix), PageSize: v.IndexPageSize, Stats: &v.bucket.stats, } recentL := s3Lister{ - Bucket: v.bucket.Bucket, - Prefix: "recent/" + prefix, + Logger: v.logger, + Bucket: v.bucket.Bucket(), + Prefix: "recent/" + v.key(prefix), PageSize: v.IndexPageSize, Stats: &v.bucket.stats, } @@ -429,7 +559,8 @@ func (v *S3Volume) IndexTo(prefix string, writer io.Writer) error { // over all of them needlessly with dataL. break } - if !v.isKeepBlock(data.Key) { + loc, isBlk := v.isKeepBlock(data.Key) + if !isBlk { continue } @@ -462,7 +593,10 @@ func (v *S3Volume) IndexTo(prefix string, writer io.Writer) error { if err != nil { return err } - fmt.Fprintf(writer, "%s+%d %d\n", data.Key, data.Size, t.UnixNano()) + // We truncate sub-second precision here. Otherwise + // timestamps will never match the RFC1123-formatted + // Last-Modified values parsed by Mtime(). + fmt.Fprintf(writer, "%s+%d %d\n", loc, data.Size, t.Unix()*1000000000) } return dataL.Error() } @@ -477,27 +611,28 @@ func (v *S3Volume) Trash(loc string) error { } else if time.Since(t) < v.cluster.Collections.BlobSigningTTL.Duration() { return nil } + key := v.key(loc) if v.cluster.Collections.BlobTrashLifetime == 0 { if !v.UnsafeDelete { return ErrS3TrashDisabled } - return v.translateError(v.bucket.Del(loc)) + return v.translateError(v.bucket.Del(key)) } - err := v.checkRaceWindow(loc) + err := v.checkRaceWindow(key) if err != nil { return err } - err = v.safeCopy("trash/"+loc, loc) + err = v.safeCopy("trash/"+key, key) if err != nil { return err } - return v.translateError(v.bucket.Del(loc)) + return v.translateError(v.bucket.Del(key)) } -// checkRaceWindow returns a non-nil error if trash/loc is, or might -// be, in the race window (i.e., it's not safe to trash loc). -func (v *S3Volume) checkRaceWindow(loc string) error { - resp, err := v.bucket.Head("trash/"+loc, nil) +// checkRaceWindow returns a non-nil error if trash/key is, or might +// be, in the race window (i.e., it's not safe to trash key). +func (v *S3Volume) checkRaceWindow(key string) error { + resp, err := v.bucket.Head("trash/"+key, nil) err = v.translateError(err) if os.IsNotExist(err) { // OK, trash/X doesn't exist so we're not in the race @@ -519,7 +654,7 @@ func (v *S3Volume) checkRaceWindow(loc string) error { // trash/X's lifetime. The new timestamp might not // become visible until now+raceWindow, and EmptyTrash // is allowed to delete trash/X before then. - return fmt.Errorf("same block is already in trash, and safe window ended %s ago", -safeWindow) + return fmt.Errorf("%s: same block is already in trash, and safe window ended %s ago", key, -safeWindow) } // trash/X exists, but it won't be eligible for deletion until // after now+raceWindow, so it's safe to overwrite it. @@ -531,15 +666,15 @@ func (v *S3Volume) checkRaceWindow(loc string) error { // (PutCopy returns 200 OK if the request was received, even if the // copy failed). func (v *S3Volume) safeCopy(dst, src string) error { - resp, err := v.bucket.PutCopy(dst, s3ACL, s3.CopyOptions{ + resp, err := v.bucket.Bucket().PutCopy(dst, s3ACL, s3.CopyOptions{ ContentType: "application/octet-stream", MetadataDirective: "REPLACE", - }, v.bucket.Name+"/"+src) + }, v.bucket.Bucket().Name+"/"+src) err = v.translateError(err) if os.IsNotExist(err) { return err } else if err != nil { - return fmt.Errorf("PutCopy(%q ← %q): %s", dst, v.bucket.Name+"/"+src, err) + return fmt.Errorf("PutCopy(%q ← %q): %s", dst, v.bucket.Bucket().Name+"/"+src, err) } if t, err := time.Parse(time.RFC3339Nano, resp.LastModified); err != nil { return fmt.Errorf("PutCopy succeeded but did not return a timestamp: %q: %s", resp.LastModified, err) @@ -567,11 +702,12 @@ func (v *S3Volume) lastModified(resp *http.Response) (t time.Time, err error) { // Untrash moves block from trash back into store func (v *S3Volume) Untrash(loc string) error { - err := v.safeCopy(loc, "trash/"+loc) + key := v.key(loc) + err := v.safeCopy(key, "trash/"+key) if err != nil { return err } - err = v.bucket.PutReader("recent/"+loc, nil, 0, "application/octet-stream", s3ACL, s3.Options{}) + err = v.bucket.PutReader("recent/"+key, nil, 0, "application/octet-stream", s3ACL, s3.Options{}) return v.translateError(err) } @@ -598,36 +734,50 @@ func (v *S3Volume) String() string { var s3KeepBlockRegexp = regexp.MustCompile(`^[0-9a-f]{32}$`) -func (v *S3Volume) isKeepBlock(s string) bool { - return s3KeepBlockRegexp.MatchString(s) +func (v *S3Volume) isKeepBlock(s string) (string, bool) { + if v.PrefixLength > 0 && len(s) == v.PrefixLength+33 && s[:v.PrefixLength] == s[v.PrefixLength+1:v.PrefixLength*2+1] { + s = s[v.PrefixLength+1:] + } + return s, s3KeepBlockRegexp.MatchString(s) +} + +// Return the key used for a given loc. If PrefixLength==0 then +// key("abcdef0123") is "abcdef0123", if PrefixLength==3 then key is +// "abc/abcdef0123", etc. +func (v *S3Volume) key(loc string) string { + if v.PrefixLength > 0 && v.PrefixLength < len(loc)-1 { + return loc[:v.PrefixLength] + "/" + loc + } else { + return loc + } } // fixRace(X) is called when "recent/X" exists but "X" doesn't -// exist. If the timestamps on "recent/"+loc and "trash/"+loc indicate -// there was a race between Put and Trash, fixRace recovers from the -// race by Untrashing the block. -func (v *S3Volume) fixRace(loc string) bool { - trash, err := v.bucket.Head("trash/"+loc, nil) +// exist. If the timestamps on "recent/X" and "trash/X" indicate there +// was a race between Put and Trash, fixRace recovers from the race by +// Untrashing the block. +func (v *S3Volume) fixRace(key string) bool { + trash, err := v.bucket.Head("trash/"+key, nil) if err != nil { if !os.IsNotExist(v.translateError(err)) { - log.Printf("error: fixRace: HEAD %q: %s", "trash/"+loc, err) + v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "trash/"+key) } return false } trashTime, err := v.lastModified(trash) if err != nil { - log.Printf("error: fixRace: parse %q: %s", trash.Header.Get("Last-Modified"), err) + v.logger.WithError(err).Errorf("fixRace: error parsing time %q", trash.Header.Get("Last-Modified")) return false } - recent, err := v.bucket.Head("recent/"+loc, nil) + recent, err := v.bucket.Head("recent/"+key, nil) if err != nil { - log.Printf("error: fixRace: HEAD %q: %s", "recent/"+loc, err) + v.logger.WithError(err).Errorf("fixRace: HEAD %q failed", "recent/"+key) return false } recentTime, err := v.lastModified(recent) if err != nil { - log.Printf("error: fixRace: parse %q: %s", recent.Header.Get("Last-Modified"), err) + v.logger.WithError(err).Errorf("fixRace: error parsing time %q", recent.Header.Get("Last-Modified")) return false } @@ -638,11 +788,11 @@ func (v *S3Volume) fixRace(loc string) bool { return false } - log.Printf("notice: fixRace: %q: trashed at %s but touched at %s (age when trashed = %s < %s)", loc, trashTime, recentTime, ageWhenTrashed, v.cluster.Collections.BlobSigningTTL) - log.Printf("notice: fixRace: copying %q to %q to recover from race between Put/Touch and Trash", "recent/"+loc, loc) - err = v.safeCopy(loc, "trash/"+loc) + v.logger.Infof("fixRace: %q: trashed at %s but touched at %s (age when trashed = %s < %s)", key, trashTime, recentTime, ageWhenTrashed, v.cluster.Collections.BlobSigningTTL) + v.logger.Infof("fixRace: copying %q to %q to recover from race between Put/Touch and Trash", "recent/"+key, key) + err = v.safeCopy(key, "trash/"+key) if err != nil { - log.Printf("error: fixRace: %s", err) + v.logger.WithError(err).Error("fixRace: copy failed") return false } return true @@ -676,8 +826,9 @@ func (v *S3Volume) EmptyTrash() { startT := time.Now() emptyOneKey := func(trash *s3.Key) { - loc := trash.Key[6:] - if !v.isKeepBlock(loc) { + key := trash.Key[6:] + loc, isBlk := v.isKeepBlock(key) + if !isBlk { return } atomic.AddInt64(&bytesInTrash, trash.Size) @@ -685,24 +836,24 @@ func (v *S3Volume) EmptyTrash() { trashT, err := time.Parse(time.RFC3339, trash.LastModified) if err != nil { - log.Printf("warning: %s: EmptyTrash: %q: parse %q: %s", v, trash.Key, trash.LastModified, err) + v.logger.Warnf("EmptyTrash: %q: parse %q: %s", trash.Key, trash.LastModified, err) return } - recent, err := v.bucket.Head("recent/"+loc, nil) + recent, err := v.bucket.Head("recent/"+key, nil) if err != nil && os.IsNotExist(v.translateError(err)) { - log.Printf("warning: %s: EmptyTrash: found trash marker %q but no %q (%s); calling Untrash", v, trash.Key, "recent/"+loc, err) + v.logger.Warnf("EmptyTrash: found trash marker %q but no %q (%s); calling Untrash", trash.Key, "recent/"+loc, err) err = v.Untrash(loc) if err != nil { - log.Printf("error: %s: EmptyTrash: Untrash(%q): %s", v, loc, err) + v.logger.WithError(err).Errorf("EmptyTrash: Untrash(%q) failed", loc) } return } else if err != nil { - log.Printf("warning: %s: EmptyTrash: HEAD %q: %s", v, "recent/"+loc, err) + v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", "recent/"+key) return } recentT, err := v.lastModified(recent) if err != nil { - log.Printf("warning: %s: EmptyTrash: %q: parse %q: %s", v, "recent/"+loc, recent.Header.Get("Last-Modified"), err) + v.logger.WithError(err).Warnf("EmptyTrash: %q: error parsing %q", "recent/"+key, recent.Header.Get("Last-Modified")) return } if trashT.Sub(recentT) < v.cluster.Collections.BlobSigningTTL.Duration() { @@ -715,18 +866,18 @@ func (v *S3Volume) EmptyTrash() { // Note this means (TrashSweepInterval // < BlobSigningTTL - raceWindow) is // necessary to avoid starvation. - log.Printf("notice: %s: EmptyTrash: detected old race for %q, calling fixRace + Touch", v, loc) - v.fixRace(loc) + v.logger.Infof("EmptyTrash: detected old race for %q, calling fixRace + Touch", loc) + v.fixRace(key) v.Touch(loc) return } - _, err := v.bucket.Head(loc, nil) + _, err := v.bucket.Head(key, nil) if os.IsNotExist(err) { - log.Printf("notice: %s: EmptyTrash: detected recent race for %q, calling fixRace", v, loc) - v.fixRace(loc) + v.logger.Infof("EmptyTrash: detected recent race for %q, calling fixRace", loc) + v.fixRace(key) return } else if err != nil { - log.Printf("warning: %s: EmptyTrash: HEAD %q: %s", v, loc, err) + v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", loc) return } } @@ -735,24 +886,24 @@ func (v *S3Volume) EmptyTrash() { } err = v.bucket.Del(trash.Key) if err != nil { - log.Printf("warning: %s: EmptyTrash: deleting %q: %s", v, trash.Key, err) + v.logger.WithError(err).Errorf("EmptyTrash: error deleting %q", trash.Key) return } atomic.AddInt64(&bytesDeleted, trash.Size) atomic.AddInt64(&blocksDeleted, 1) - _, err = v.bucket.Head(loc, nil) + _, err = v.bucket.Head(key, nil) if err == nil { - log.Printf("warning: %s: EmptyTrash: HEAD %q succeeded immediately after deleting %q", v, loc, loc) + v.logger.Warnf("EmptyTrash: HEAD %q succeeded immediately after deleting %q", key, key) return } if !os.IsNotExist(v.translateError(err)) { - log.Printf("warning: %s: EmptyTrash: HEAD %q: %s", v, loc, err) + v.logger.WithError(err).Warnf("EmptyTrash: HEAD %q failed", key) return } - err = v.bucket.Del("recent/" + loc) + err = v.bucket.Del("recent/" + key) if err != nil { - log.Printf("warning: %s: EmptyTrash: deleting %q: %s", v, "recent/"+loc, err) + v.logger.WithError(err).Warnf("EmptyTrash: error deleting %q", "recent/"+key) } } @@ -769,7 +920,8 @@ func (v *S3Volume) EmptyTrash() { } trashL := s3Lister{ - Bucket: v.bucket.Bucket, + Logger: v.logger, + Bucket: v.bucket.Bucket(), Prefix: "trash/", PageSize: v.IndexPageSize, Stats: &v.bucket.stats, @@ -781,12 +933,13 @@ func (v *S3Volume) EmptyTrash() { wg.Wait() if err := trashL.Error(); err != nil { - log.Printf("error: %s: EmptyTrash: lister: %s", v, err) + v.logger.WithError(err).Error("EmptyTrash: lister failed") } - log.Printf("EmptyTrash stats for %v: Deleted %v bytes in %v blocks. Remaining in trash: %v bytes in %v blocks.", v.String(), bytesDeleted, blocksDeleted, bytesInTrash-bytesDeleted, blocksInTrash-blocksDeleted) + v.logger.Infof("EmptyTrash stats for %v: Deleted %v bytes in %v blocks. Remaining in trash: %v bytes in %v blocks.", v.String(), bytesDeleted, blocksDeleted, bytesInTrash-bytesDeleted, blocksInTrash-blocksDeleted) } type s3Lister struct { + Logger logrus.FieldLogger Bucket *s3.Bucket Prefix string PageSize int @@ -833,7 +986,7 @@ func (lister *s3Lister) getPage() { lister.buf = make([]s3.Key, 0, len(resp.Contents)) for _, key := range resp.Contents { if !strings.HasPrefix(key.Key, lister.Prefix) { - log.Printf("warning: s3Lister: S3 Bucket.List(prefix=%q) returned key %q", lister.Prefix, key.Key) + lister.Logger.Warnf("s3Lister: S3 Bucket.List(prefix=%q) returned key %q", lister.Prefix, key.Key) continue } lister.buf = append(lister.buf, key) @@ -848,14 +1001,29 @@ func (lister *s3Lister) pop() (k *s3.Key) { return } -// s3bucket wraps s3.bucket and counts I/O and API usage stats. +// s3bucket wraps s3.bucket and counts I/O and API usage stats. The +// wrapped bucket can be replaced atomically with SetBucket in order +// to update credentials. type s3bucket struct { - *s3.Bucket - stats s3bucketStats + bucket *s3.Bucket + stats s3bucketStats + mu sync.Mutex +} + +func (b *s3bucket) Bucket() *s3.Bucket { + b.mu.Lock() + defer b.mu.Unlock() + return b.bucket +} + +func (b *s3bucket) SetBucket(bucket *s3.Bucket) { + b.mu.Lock() + defer b.mu.Unlock() + b.bucket = bucket } func (b *s3bucket) GetReader(path string) (io.ReadCloser, error) { - rdr, err := b.Bucket.GetReader(path) + rdr, err := b.Bucket().GetReader(path) b.stats.TickOps("get") b.stats.Tick(&b.stats.Ops, &b.stats.GetOps) b.stats.TickErr(err) @@ -863,7 +1031,7 @@ func (b *s3bucket) GetReader(path string) (io.ReadCloser, error) { } func (b *s3bucket) Head(path string, headers map[string][]string) (*http.Response, error) { - resp, err := b.Bucket.Head(path, headers) + resp, err := b.Bucket().Head(path, headers) b.stats.TickOps("head") b.stats.Tick(&b.stats.Ops, &b.stats.HeadOps) b.stats.TickErr(err) @@ -882,7 +1050,7 @@ func (b *s3bucket) PutReader(path string, r io.Reader, length int64, contType st } else { r = NewCountingReader(r, b.stats.TickOutBytes) } - err := b.Bucket.PutReader(path, r, length, contType, perm, options) + err := b.Bucket().PutReader(path, r, length, contType, perm, options) b.stats.TickOps("put") b.stats.Tick(&b.stats.Ops, &b.stats.PutOps) b.stats.TickErr(err) @@ -890,7 +1058,7 @@ func (b *s3bucket) PutReader(path string, r io.Reader, length int64, contType st } func (b *s3bucket) Del(path string) error { - err := b.Bucket.Del(path) + err := b.Bucket().Del(path) b.stats.TickOps("delete") b.stats.Tick(&b.stats.Ops, &b.stats.DelOps) b.stats.TickErr(err)