replace global scoped otel tracers with function local ones

This fixes a issue where the trace spans were not being propagated
because the tracers were globally scoped.

Author: joelrebel

internal/collector/collector.go

@@ -16,7 +16,6 @@ import (
 	"github.com/metal-toolbox/alloy/internal/store"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
-	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/trace"
 )
 
@@ -269,11 +268,6 @@ func NewAssetIterCollectorWithStore(
 
 // Collect iterates over assets returned by the AssetIterator and collects their inventory, bios configuration data.
 func (d *AssetIterCollector) Collect(ctx context.Context) {
-	tracer := otel.Tracer("collector.AssetIteratorCollector")
-	ctx, span := tracer.Start(context.TODO(), "Collect()")
-
-	defer span.End()
-
 	// pauser helps throttle asset retrieval to match the data collection rate.
 	pauser := NewPauser()
 
@@ -339,7 +333,7 @@ Loop:
 			atomic.AddInt32(&dispatched, 1)
 
 			// throttle asset iterator based on dispatched vs concurrency limit
-			d.throttle(span, pauser, dispatched)
+			d.throttle(nil, pauser, dispatched)
 
 			// run collection in routine
 			go func(ctx context.Context, asset *model.Asset) {

internal/device/outofband/outofband.go

@@ -23,25 +23,21 @@ import (
 )
 
 var (
-	// The outofband collector tracer
-	tracer        trace.Tracer
 	ErrInventory  = errors.New("inventory collection error")
 	ErrBiosConfig = errors.New("BIOS configuration collection error")
 	ErrConnect    = errors.New("BMC connection error")
 	ErrBMCSession = errors.New("BMC session error")
 )
 
-func init() {
-	tracer = otel.Tracer("outofband.Queryor")
-}
-
 const (
 	// logoutTimeout is the timeout value for each bmc logout attempt.
 	logoutTimeout = "1m"
 
 	// bmclib will attempt multiple providers (drivers) - to perform an action,
 	// this is maximum amount of time bmclib will spend performing a query on a BMC.
 	bmclibProviderTimeout = 180 * time.Second
+
+	pkgName = "internal/outofband"
 )
 
 // OutOfBand collector collects hardware, firmware inventory out of band
@@ -84,7 +80,8 @@ func NewQueryor(logger *logrus.Logger) *Queryor {
 // Inventory retrieves device component and firmware information
 // and updates the given asset object with the inventory
 func (o *Queryor) Inventory(ctx context.Context, asset *model.Asset) error {
-	ctx, span := tracer.Start(ctx, "Inventory()")
+	// attach child span
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "Inventory")
 	defer span.End()
 
 	setTraceSpanAssetAttributes(span, asset)
@@ -119,9 +116,11 @@ func (o *Queryor) Inventory(ctx context.Context, asset *model.Asset) error {
 
 func (o *Queryor) BiosConfiguration(ctx context.Context, asset *model.Asset) error {
 	// attach child span
-	ctx, span := tracer.Start(ctx, "BiosConfiguration()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "BiosConfiguration")
 	defer span.End()
 
+	setTraceSpanAssetAttributes(span, asset)
+
 	// login
 	bmc, err := o.bmcLogin(ctx, asset)
 	if err != nil {
@@ -250,7 +249,7 @@ func (o *Queryor) bmcLogin(ctx context.Context, asset *model.Asset) (BMCQueryor,
 	var bmc BMCQueryor
 
 	// attach child span
-	ctx, span := tracer.Start(ctx, "bmcLogin()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "bmcLogin")
 	defer span.End()
 
 	if o.mockClient == nil {
@@ -298,8 +297,7 @@ func (o *Queryor) bmcLogout(bmc BMCQueryor, asset *model.Asset) {
 	ctx, cancel := context.WithTimeout(context.Background(), o.logoutTimeout)
 	defer cancel()
 
-	// attach child span
-	ctx, span := tracer.Start(ctx, "bmcLogout()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "bmclibLogOut")
 	defer span.End()
 
 	o.logger.WithFields(

internal/store/serverservice/serverservice.go

@@ -19,21 +19,14 @@ import (
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
-	"go.opentelemetry.io/otel/trace"
 
 	serverserviceapi "go.hollow.sh/serverservice/pkg/api/v1"
 )
 
-var (
-
-	// The serverservice asset getter tracer
-	tracer trace.Tracer
+const (
+	pkgName = "internal/store"
 )
 
-func init() {
-	tracer = otel.Tracer("store.serverservice")
-}
-
 // Store is an asset inventory store
 type Store struct {
 	*serverserviceapi.Client
@@ -100,8 +93,7 @@ func (r *Store) Kind() model.StoreKind {
 
 // assetByID queries serverService for the hardware asset by ID and returns an Asset object
 func (r *Store) AssetByID(ctx context.Context, id string, fetchBmcCredentials bool) (*model.Asset, error) {
-	// attach child span
-	ctx, span := tracer.Start(ctx, "AssetByID()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "Serverservice.AssetByID")
 	defer span.End()
 
 	sid, err := uuid.Parse(id)
@@ -136,8 +128,8 @@ func (r *Store) AssetByID(ctx context.Context, id string, fetchBmcCredentials bo
 
 // assetByID queries serverService for the hardware asset by ID and returns an Asset object
 func (r *Store) AssetsByOffsetLimit(ctx context.Context, offset, limit int) (assets []*model.Asset, totalAssets int, err error) {
-	// attach child span
-	ctx, span := tracer.Start(ctx, "AssetsByOffsetLimit()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "Serverservice.AssetByOffsetLimit")
+	defer span.End()
 
 	span.SetAttributes(
 		attribute.Int("offset", offset),
@@ -192,8 +184,7 @@ func (r *Store) AssetsByOffsetLimit(ctx context.Context, offset, limit int) (ass
 
 // AssetUpdate inserts/updates the asset data in the serverservice store
 func (r *Store) AssetUpdate(ctx context.Context, asset *model.Asset) error {
-	// attach child span
-	ctx, span := tracer.Start(ctx, "AssetUpdate()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "Serverservice.AssetUpdate")
 	defer span.End()
 
 	if asset == nil {
@@ -303,8 +294,7 @@ func (r *Store) createUpdateInventory(ctx context.Context, device *model.Asset,
 //
 // nolint:gocyclo // the method caries out all steps to have device data compared and registered, for now its accepted as cyclomatic.
 func (r *Store) createUpdateServerComponents(ctx context.Context, serverID uuid.UUID, device *model.Asset) error {
-	// attach child span
-	ctx, span := tracer.Start(ctx, "createUpdateServerComponents()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "Serverservice.createUpdateServerComponents")
 	defer span.End()
 
 	if device.Inventory == nil {
@@ -472,10 +462,6 @@ func diffFilter(_ []string, _ reflect.Type, field reflect.StructField) bool {
 // serverServiceChangeList compares the current vs newer slice of server components
 // and returns 3 lists - add, update, remove.
 func serverServiceChangeList(ctx context.Context, currentObjs, newObjs []*serverserviceapi.ServerComponent) (add, update, remove serverserviceapi.ServerComponentSlice, err error) {
-	// attach child span
-	_, span := tracer.Start(ctx, "serverServiceChangeList()")
-	defer span.End()
-
 	// 1. list updated and removed objects
 	for _, currentObj := range currentObjs {
 		// changeObj is the component changes to be registered
@@ -565,8 +551,7 @@ func serverServiceComponentsUpdated(currentObj, newObj *serverserviceapi.ServerC
 }
 
 func (r *Store) cacheServerComponentFirmwares(ctx context.Context) error {
-	// attach child span
-	ctx, span := tracer.Start(ctx, "cacheServerComponentFirmwares()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "Serverservice.cacheServerComponentFirmwares")
 	defer span.End()
 
 	// Query ServerService for all firmware
@@ -590,8 +575,7 @@ func (r *Store) cacheServerComponentFirmwares(ctx context.Context) error {
 }
 
 func (r *Store) cacheServerComponentTypes(ctx context.Context) error {
-	// attach child span
-	ctx, span := tracer.Start(ctx, "cacheServerComponentTypes()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "Serverservice.cacheServerComponentTypes")
 	defer span.End()
 
 	serverComponentTypes, _, err := r.ListServerComponentTypes(ctx, nil)
@@ -613,8 +597,7 @@ func (r *Store) cacheServerComponentTypes(ctx context.Context) error {
 }
 
 func (r *Store) createServerComponentTypes(ctx context.Context) error {
-	// attach child span
-	ctx, span := tracer.Start(ctx, "createServerComponentTypes()")
+	ctx, span := otel.Tracer(pkgName).Start(ctx, "Serverservice.createServerComponentTypes")
 	defer span.End()
 
 	existing, _, err := r.ListServerComponentTypes(ctx, nil)

internal/store/store.go

@@ -23,7 +23,6 @@ type Repository interface {
 	// AssetByID returns one asset from the inventory identified by its identifier.
 	AssetByID(ctx context.Context, assetID string, fetchBmcCredentials bool) (*model.Asset, error)
 
-	// AssetByOffsetLimit queries the inventory for the asset(s) at the given offset, limit values.
 	AssetsByOffsetLimit(ctx context.Context, offset, limit int) (assets []*model.Asset, totalAssets int, err error)
 
 	// AssetUpdate inserts and updates collected data for the asset in the store.