Optional tracing in azblob

.github/workflows/vulncheck.yml

@@ -6,8 +6,6 @@ on:
   push:
     branches:
       - main
-  schedule: # every Tuesday at 3 a.m UTC
-    - cron '0 3 * * 2'
 
 permissions:
   contents: read # to fetch code (actions/checkout)

azblob/error.go

@@ -49,14 +49,14 @@ func (e *Error) StatusCode() int {
 		if resp.Body != nil {
 			defer resp.Body.Close()
 		}
-		logger.Sugar.Debugf("Azblob StatusCode %d", resp.StatusCode)
+		logger.Sugar.Debugf("AZBlob downstream statusCode %d", resp.StatusCode)
 		return resp.StatusCode
 	}
 	if e.statusCode != 0 {
-		logger.Sugar.Debugf("Return statusCode %d", e.statusCode)
+		logger.Sugar.Debugf("AZBlob internal statusCode %d", e.statusCode)
 		return e.statusCode
 	}
-	logger.Sugar.Debugf("Return InternalServerError")
+	logger.Sugar.Debugf("AZBlob InternalServerError: %v", e)
 	return http.StatusInternalServerError
 }
 

azblob/list.go

@@ -6,8 +6,6 @@ import (
 	"context"
 
 	azStorageBlob "github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
-
-	"github.com/datatrails/go-datatrails-common/tracing"
 )
 
 // Count counts the number of blobs filtered by the given tags filter
@@ -63,8 +61,11 @@ type FilterResponse struct {
 //
 // Returns all blobs with the specific tag filter.
 func (azp *Storer) FilteredList(ctx context.Context, tagsFilter string, opts ...Option) (*FilterResponse, error) {
-	span, ctx := tracing.StartSpanFromContext(ctx, "FilteredList")
-	defer span.Finish()
+	var span Spanner
+	if azp.startSpanFromContext != nil {
+		span, ctx = azp.startSpanFromContext(ctx, azp.log, "FilteredList")
+		defer span.Close()
+	}
 
 	var err error
 
@@ -73,7 +74,7 @@ func (azp *Storer) FilteredList(ctx context.Context, tagsFilter string, opts ...
 		opt(options)
 	}
 
-	if options.listMarker != nil {
+	if options.listMarker != nil && span != nil {
 		span.SetTag("marker", *options.listMarker)
 	}
 	o := &azStorageBlob.ServiceFilterBlobsOptions{
@@ -83,7 +84,9 @@ func (azp *Storer) FilteredList(ctx context.Context, tagsFilter string, opts ...
 
 	if options.listMaxResults > 0 {
 		o.MaxResults = &options.listMaxResults
-		span.SetTag("maxResults", options.listMaxResults)
+		if span != nil {
+			span.SetTag("maxResults", options.listMaxResults)
+		}
 	}
 
 	resp, err := azp.serviceClient.FindBlobsByTags(ctx, o)
@@ -98,7 +101,7 @@ func (azp *Storer) FilteredList(ctx context.Context, tagsFilter string, opts ...
 		Items:      resp.Blobs,
 	}
 
-	if r.Marker != nil {
+	if r.Marker != nil && span != nil {
 		span.SetTag("nextmarker", *r.Marker)
 	}
 
@@ -118,22 +121,26 @@ type ListerResponse struct {
 
 func (azp *Storer) List(ctx context.Context, opts ...Option) (*ListerResponse, error) {
 
-	span, ctx := tracing.StartSpanFromContext(ctx, "ListBlobsFlat")
-	defer span.Finish()
-
+	var span Spanner
+	if azp.startSpanFromContext != nil {
+		span, ctx = azp.startSpanFromContext(ctx, azp.log, "ListBlobsFlat")
+		defer span.Close()
+	}
 	options := &StorerOptions{}
 	for _, opt := range opts {
 		opt(options)
 	}
-	if options.listMarker != nil {
+	if options.listMarker != nil && span != nil {
 		span.SetTag("marker", *options.listMarker)
 	}
 	o := azStorageBlob.ContainerListBlobsFlatOptions{
 		Marker: options.listMarker,
 	}
 	if options.listPrefix != "" {
 		o.Prefix = &options.listPrefix
-		span.SetTag("prefix", options.listPrefix)
+		if span != nil {
+			span.SetTag("prefix", options.listPrefix)
+		}
 	}
 	if options.listIncludeTags {
 		o.Include = append(o.Include, azStorageBlob.ListBlobsIncludeItemTags)
@@ -143,7 +150,9 @@ func (azp *Storer) List(ctx context.Context, opts ...Option) (*ListerResponse, e
 	}
 	if options.listMaxResults > 0 {
 		o.MaxResults = &options.listMaxResults
-		span.SetTag("maxResults", options.listMaxResults)
+		if span != nil {
+			span.SetTag("maxResults", options.listMaxResults)
+		}
 	}
 
 	// TODO: v1.21 feature which would be great
@@ -163,7 +172,7 @@ func (azp *Storer) List(ctx context.Context, opts ...Option) (*ListerResponse, e
 	}
 
 	r.Marker = resp.NextMarker
-	if r.Marker != nil {
+	if r.Marker != nil && span != nil {
 		span.SetTag("nextmarker", *r.Marker)
 	}
 

azblob/reader.go

@@ -44,7 +44,7 @@ type Reader interface {
 // example:
 //
 //	url: https://app.datatrails.ai/verifiabledata
-func NewReaderNoAuth(url string, opts ...ReaderOption) (Reader, error) {
+func NewReaderNoAuth(log Logger, url string, opts ...ReaderOption) (Reader, error) {
 	var err error
 	if url == "" {
 		return nil, errors.New("url is a required parameter and cannot be empty")
@@ -53,12 +53,14 @@ func NewReaderNoAuth(url string, opts ...ReaderOption) (Reader, error) {
 	readerOptions := ParseReaderOptions(opts...)
 
 	azp := &Storer{
-		AccountName:   readerOptions.accountName, // just for logging
-		ResourceGroup: "",                        // just for logging
-		Subscription:  "",                        // just for logging
-		Container:     readerOptions.container,
-		credential:    nil,
-		rootURL:       url,
+		AccountName:          readerOptions.accountName, // just for logging
+		ResourceGroup:        "",                        // just for logging
+		Subscription:         "",                        // just for logging
+		Container:            readerOptions.container,
+		credential:           nil,
+		rootURL:              url,
+		startSpanFromContext: readerOptions.startSpanFromContext,
+		log:                  log,
 	}
 
 	azp.serviceClient, err = azStorageBlob.NewServiceClientWithNoCredential(
@@ -93,7 +95,7 @@ func NewReaderNoAuth(url string, opts ...ReaderOption) (Reader, error) {
 
 // NewReaderDefaultAuth is a azure blob reader client that obtains credentials from the
 // environment - including aad pod identity / workload identity.
-func NewReaderDefaultAuth(url string, opts ...ReaderOption) (Reader, error) {
+func NewReaderDefaultAuth(log Logger, url string, opts ...ReaderOption) (Reader, error) {
 	var err error
 	if url == "" {
 		return nil, errors.New("url is a required parameter and cannot be empty")
@@ -102,12 +104,14 @@ func NewReaderDefaultAuth(url string, opts ...ReaderOption) (Reader, error) {
 	readerOptions := ParseReaderOptions(opts...)
 
 	azp := &Storer{
-		AccountName:   readerOptions.accountName, // just for logging
-		ResourceGroup: "",                        // just for logging
-		Subscription:  "",                        // just for logging
-		Container:     readerOptions.container,
-		credential:    nil,
-		rootURL:       url,
+		AccountName:          readerOptions.accountName, // just for logging
+		ResourceGroup:        "",                        // just for logging
+		Subscription:         "",                        // just for logging
+		Container:            readerOptions.container,
+		credential:           nil,
+		rootURL:              url,
+		startSpanFromContext: readerOptions.startSpanFromContext,
+		log:                  log,
 	}
 
 	credentials, err := azidentity.NewDefaultAzureCredential(nil)

azblob/readeroptions.go

@@ -7,6 +7,8 @@ type ReaderOptions struct {
 	accountName string
 
 	container string
+
+	startSpanFromContext startSpanFromContextFunc
 }
 
 type ReaderOption func(*ReaderOptions)
@@ -25,6 +27,12 @@ func WithContainer(container string) ReaderOption {
 	}
 }
 
+func WithReaderSpanFromContext(s startSpanFromContextFunc) ReaderOption {
+	return func(a *ReaderOptions) {
+		a.startSpanFromContext = s
+	}
+}
+
 // ParseReaderOptions parses the given options into a ReaderOptions struct
 func ParseReaderOptions(options ...ReaderOption) ReaderOptions {
 	readerOptions := ReaderOptions{}

azblob/spanner.go

@@ -0,0 +1,12 @@
+package azblob
+
+import (
+	"context"
+
+	"github.com/datatrails/go-datatrails-common/logger"
+	"github.com/datatrails/go-datatrails-common/spanner"
+)
+
+type Spanner = spanner.Spanner
+
+type startSpanFromContextFunc func(context.Context, logger.Logger, string) (spanner.Spanner, context.Context)

azblob/storer.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 
 	azStorageBlob "github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
-	"github.com/datatrails/go-datatrails-common/logger"
 )
 
 var (
@@ -34,6 +33,8 @@ type Storer struct {
 
 	log                          Logger
 	setReadResponseScannedStatus ReadResponseScannedStatus
+
+	startSpanFromContext startSpanFromContextFunc
 }
 
 type StorerOption func(*Storer)
@@ -44,8 +45,15 @@ func WithSetScannedStatus(s ReadResponseScannedStatus) StorerOption {
 	}
 }
 
+func WithStorerSpanFromContext(s startSpanFromContextFunc) StorerOption {
+	return func(a *Storer) {
+		a.startSpanFromContext = s
+	}
+}
+
 // New returns new az blob read/write object
 func New(
+	log Logger,
 	accountName string,
 	resourceGroup string,
 	subscription string,
@@ -54,7 +62,7 @@ func New(
 ) (*Storer, error) {
 
 	var err error
-	logger.Sugar.Debugf("New Storer: %s/%s/%s/%s",
+	log.Debugf("New Storer: %s/%s/%s/%s",
 		accountName,
 		resourceGroup,
 		subscription,
@@ -72,7 +80,7 @@ func New(
 	rootURL := secret.URL
 
 	if container == "" {
-		logger.Sugar.Infof("Storer: %v", ErrUnspecifiedContainer)
+		log.Infof("Storer: %v", ErrUnspecifiedContainer)
 		return nil, ErrUnspecifiedContainer
 	}
 	azp := Storer{
@@ -82,6 +90,7 @@ func New(
 		Container:     container,
 		credential:    credential,
 		rootURL:       rootURL,
+		log:           log,
 	}
 	for _, option := range options {
 		option(&azp)
@@ -98,12 +107,12 @@ func New(
 		nil,
 	)
 	if err != nil {
-		logger.Sugar.Infof("unable to create serviceclient %s: %v", azp.containerURL, err)
+		log.Infof("unable to create serviceclient %s: %v", azp.containerURL, err)
 		return nil, err
 	}
 	azp.containerClient, err = azp.serviceClient.NewContainerClient(container)
 	if err != nil {
-		logger.Sugar.Infof("unable to create containerclient %s: %v", container, err)
+		log.Infof("unable to create containerclient %s: %v", container, err)
 		return nil, err
 	}
 

azblob/storerazurite.go

@@ -85,6 +85,7 @@ func NewDev(cfg DevConfig, container string) (*Storer, error) {
 		Container:     container,
 		credential:    cred,
 		rootURL:       cfg.URL,
+		log:           logger.Sugar,
 	}
 
 	azp.containerURL = fmt.Sprintf(