Skip to content

Commit

Permalink
feat(s3client): Add debug logs and forgotten trace
Browse files Browse the repository at this point in the history 
Related to #442
  • Loading branch information
@oxyno-zeta
oxyno-zeta committed Jul 27, 2024
1 parent 7391d11 commit db31d28
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 10 deletions.
127 changes: 117 additions & 10 deletions pkg/s3-proxy/s3client/s3-client.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/aws/aws-sdk-go/service/s3/s3manager"
"github.com/aws/aws-sdk-go/service/s3/s3manager/s3manageriface"
"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/config"
"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/log"
"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/metrics"
"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/tracing"
)
Expand Down Expand Up @@ -68,10 +69,34 @@ func (s3cl *s3client) buildGetObjectInputFromInput(input *GetInput) *s3.GetObjec
return s3Input
}

func (s3cl *s3client) GetObjectSignedURL(_ context.Context, input *GetInput, expiration time.Duration) (string, error) {
func (s3cl *s3client) GetObjectSignedURL(ctx context.Context, input *GetInput, expiration time.Duration) (string, error) {
// Build input
s3Input := s3cl.buildGetObjectInputFromInput(input)

// Get trace
parentTrace := tracing.GetTraceFromContext(ctx)
// Create child trace
childTrace := parentTrace.GetChildTrace("s3-bucket.get-object-signed-url-request")
childTrace.SetTag("s3-bucket.bucket-name", s3cl.target.Bucket.Name)
childTrace.SetTag("s3-bucket.bucket-region", s3cl.target.Bucket.Region)
childTrace.SetTag("s3-bucket.bucket-prefix", s3cl.target.Bucket.Prefix)
childTrace.SetTag("s3-bucket.bucket-s3-endpoint", s3cl.target.Bucket.S3Endpoint)
childTrace.SetTag("s3-bucket.bucket-key", *s3Input.Key)
childTrace.SetTag("s3-proxy.target-name", s3cl.target.Name)

defer childTrace.Finish()

// Get logger
logger := log.GetLoggerFromContext(ctx)
// Build logger
logger = logger.WithFields(map[string]interface{}{
"bucket": s3cl.target.Bucket.Name,
"key": *s3Input.Key,
"region": s3cl.target.Bucket.Region,
})
// Log
logger.Debugf("Trying to get object presigned url")

// Build object request
req, _ := s3cl.svcClient.GetObjectRequest(s3Input)
// Build url
Expand All @@ -93,11 +118,17 @@ func (s3cl *s3client) GetObjectSignedURL(_ context.Context, input *GetInput, exp
return "", errors.WithStack(err)
}

// Log
logger.Debug("Get object presigned url with success")

return urlStr, nil
}

// ListFilesAndDirectories List files and directories.
func (s3cl *s3client) ListFilesAndDirectories(ctx context.Context, key string) ([]*ListElementOutput, *ResultInfo, error) {
// Get logger
logger := log.GetLoggerFromContext(ctx)

// List files on path
folders := make([]*ListElementOutput, 0)
files := make([]*ListElementOutput, 0)
Expand Down Expand Up @@ -131,8 +162,19 @@ func (s3cl *s3client) ListFilesAndDirectories(ctx context.Context, key string) (
childTrace.SetTag("s3-bucket.bucket-region", s3cl.target.Bucket.Region)
childTrace.SetTag("s3-bucket.bucket-prefix", s3cl.target.Bucket.Prefix)
childTrace.SetTag("s3-bucket.bucket-s3-endpoint", s3cl.target.Bucket.S3Endpoint)
childTrace.SetTag("s3-bucket.bucket-key", key)
childTrace.SetTag("s3-proxy.target-name", s3cl.target.Name)

// Build logger
logger = logger.WithFields(map[string]interface{}{
"bucket": s3cl.target.Bucket.Name,
"key": key,
"region": s3cl.target.Bucket.Region,
"maxKeys": maxKeys,
})
// Log
logger.Debugf("Trying to list objects")

// Request S3
err := s3cl.svcClient.ListObjectsV2PagesWithContext(
ctx,
Expand Down Expand Up @@ -200,6 +242,9 @@ func (s3cl *s3client) ListFilesAndDirectories(ctx context.Context, key string) (
if err != nil {
return nil, nil, errors.WithStack(err)
}

// Log
logger.Debugf("List objects done with success")
}

// Concat folders and files
Expand All @@ -219,6 +264,9 @@ func (s3cl *s3client) ListFilesAndDirectories(ctx context.Context, key string) (

// GetObject Get object from S3 bucket.
func (s3cl *s3client) GetObject(ctx context.Context, input *GetInput) (*GetOutput, *ResultInfo, error) {
// Build input
s3Input := s3cl.buildGetObjectInputFromInput(input)

// Get trace
parentTrace := tracing.GetTraceFromContext(ctx)
// Create child trace
Expand All @@ -227,19 +275,28 @@ func (s3cl *s3client) GetObject(ctx context.Context, input *GetInput) (*GetOutpu
childTrace.SetTag("s3-bucket.bucket-region", s3cl.target.Bucket.Region)
childTrace.SetTag("s3-bucket.bucket-prefix", s3cl.target.Bucket.Prefix)
childTrace.SetTag("s3-bucket.bucket-s3-endpoint", s3cl.target.Bucket.S3Endpoint)
childTrace.SetTag("s3-bucket.bucket-key", *s3Input.Key)
childTrace.SetTag("s3-proxy.target-name", s3cl.target.Name)

defer childTrace.Finish()

// Build input
s3Input := s3cl.buildGetObjectInputFromInput(input)

// Init & get request headers
var requestHeaders map[string]string
if s3cl.target.Bucket.RequestConfig != nil {
requestHeaders = s3cl.target.Bucket.RequestConfig.GetHeaders
}

// Get logger
logger := log.GetLoggerFromContext(ctx)
// Build logger
logger = logger.WithFields(map[string]interface{}{
"bucket": s3cl.target.Bucket.Name,
"key": *s3Input.Key,
"region": s3cl.target.Bucket.Region,
})
// Log
logger.Debugf("Trying to get object")

obj, err := s3cl.svcClient.GetObjectWithContext(
ctx,
s3Input,
Expand Down Expand Up @@ -324,10 +381,21 @@ func (s3cl *s3client) GetObject(ctx context.Context, input *GetInput) (*GetOutpu
Key: input.Key,
}

// Log
logger.Debugf("Get object done with success")

return output, info, nil
}

func (s3cl *s3client) PutObject(ctx context.Context, input *PutInput) (*ResultInfo, error) {
// Build input
inp := &s3manager.UploadInput{
Body: input.Body,
Bucket: aws.String(s3cl.target.Bucket.Name),
Key: aws.String(input.Key),
Expires: input.Expires,
}

// Get trace
parentTrace := tracing.GetTraceFromContext(ctx)
// Create child trace
Expand All @@ -336,16 +404,21 @@ func (s3cl *s3client) PutObject(ctx context.Context, input *PutInput) (*ResultIn
childTrace.SetTag("s3-bucket.bucket-region", s3cl.target.Bucket.Region)
childTrace.SetTag("s3-bucket.bucket-prefix", s3cl.target.Bucket.Prefix)
childTrace.SetTag("s3-bucket.bucket-s3-endpoint", s3cl.target.Bucket.S3Endpoint)
childTrace.SetTag("s3-bucket.bucket-key", *inp.Key)
childTrace.SetTag("s3-proxy.target-name", s3cl.target.Name)

defer childTrace.Finish()

inp := &s3manager.UploadInput{
Body: input.Body,
Bucket: aws.String(s3cl.target.Bucket.Name),
Key: aws.String(input.Key),
Expires: input.Expires,
}
// Get logger
logger := log.GetLoggerFromContext(ctx)
// Build logger
logger = logger.WithFields(map[string]interface{}{
"bucket": s3cl.target.Bucket.Name,
"key": *inp.Key,
"region": s3cl.target.Bucket.Region,
})
// Log
logger.Debugf("Trying to put object")

// Manage ACL
if s3cl.target.Actions != nil &&
Expand Down Expand Up @@ -416,6 +489,9 @@ func (s3cl *s3client) PutObject(ctx context.Context, input *PutInput) (*ResultIn
Key: input.Key,
}

// Log
logger.Debugf("Put object done with success")

// Return
return info, nil
}
Expand All @@ -429,10 +505,22 @@ func (s3cl *s3client) HeadObject(ctx context.Context, key string) (*HeadOutput,
childTrace.SetTag("s3-bucket.bucket-region", s3cl.target.Bucket.Region)
childTrace.SetTag("s3-bucket.bucket-prefix", s3cl.target.Bucket.Prefix)
childTrace.SetTag("s3-bucket.bucket-s3-endpoint", s3cl.target.Bucket.S3Endpoint)
childTrace.SetTag("s3-bucket.bucket-key", key)
childTrace.SetTag("s3-proxy.target-name", s3cl.target.Name)

defer childTrace.Finish()

// Get logger
logger := log.GetLoggerFromContext(ctx)
// Build logger
logger = logger.WithFields(map[string]interface{}{
"bucket": s3cl.target.Bucket.Name,
"key": key,
"region": s3cl.target.Bucket.Region,
})
// Log
logger.Debugf("Trying to head object")

// Init & get request headers
var requestHeaders map[string]string
if s3cl.target.Bucket.RequestConfig != nil {
Expand Down Expand Up @@ -469,6 +557,10 @@ func (s3cl *s3client) HeadObject(ctx context.Context, key string) (*HeadOutput,
Type: FileType,
Key: key,
}

// Log
logger.Debugf("Head object done with success")

// Return output
return output, nil
}
Expand All @@ -482,10 +574,22 @@ func (s3cl *s3client) DeleteObject(ctx context.Context, key string) (*ResultInfo
childTrace.SetTag("s3-bucket.bucket-region", s3cl.target.Bucket.Region)
childTrace.SetTag("s3-bucket.bucket-prefix", s3cl.target.Bucket.Prefix)
childTrace.SetTag("s3-bucket.bucket-s3-endpoint", s3cl.target.Bucket.S3Endpoint)
childTrace.SetTag("s3-bucket.bucket-key", key)
childTrace.SetTag("s3-proxy.target-name", s3cl.target.Name)

defer childTrace.Finish()

// Get logger
logger := log.GetLoggerFromContext(ctx)
// Build logger
logger = logger.WithFields(map[string]interface{}{
"bucket": s3cl.target.Bucket.Name,
"key": key,
"region": s3cl.target.Bucket.Region,
})
// Log
logger.Debugf("Trying to delete object")

// Init & get request headers
var requestHeaders map[string]string
if s3cl.target.Bucket.RequestConfig != nil {
Expand Down Expand Up @@ -517,6 +621,9 @@ func (s3cl *s3client) DeleteObject(ctx context.Context, key string) (*ResultInfo
Key: key,
}

// Log
logger.Debugf("Delete object done with success")

// Return
return info, nil
}
Expand Down
1 change: 1 addition & 0 deletions pkg/s3-proxy/server/server_integration_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3698,6 +3698,7 @@ func TestPublicRouter(t *testing.T) {
cfgManagerMock.EXPECT().GetConfig().AnyTimes().Return(tt.args.cfg)

logger := log.NewLogger()
logger.Configure("DEBUG", "human", "")
// Create tracing service
tsvc, err := tracing.New(cfgManagerMock, logger)
assert.NoError(t, err)
Expand Down

0 comments on commit db31d28

Please sign in to comment.