sourcegraph: codeintel: Fix observability on upload/lsifstore (#44865)

Commit: d61f40b2f1aed793d13c393e66bf8d10fc8fff41

Author: Eric Fritz

sourcegraph/enterprise/internal/codeintel/uploads/internal/lsifstore/lsifstore_delete.go

@@ -7,7 +7,7 @@ import (
 	"strings"
 
 	"github.com/keegancsmith/sqlf"
-	"github.com/opentracing/opentracing-go/log"
+	otlog "github.com/opentracing/opentracing-go/log"
 
 	"github.com/sourcegraph/sourcegraph/internal/observation"
 )
@@ -28,9 +28,9 @@ var tableNames = []string{
 
 // DeleteLsifDataByUploadIds deletes LSIF data by UploadIds from the lsif database.
 func (s *store) DeleteLsifDataByUploadIds(ctx context.Context, bundleIDs ...int) (err error) {
-	ctx, trace, endObservation := s.operations.deleteLsifDataByUploadIds.With(ctx, &err, observation.Args{LogFields: []log.Field{
-		log.Int("numBundleIDs", len(bundleIDs)),
-		log.String("bundleIDs", intsToString(bundleIDs)),
+	ctx, trace, endObservation := s.operations.deleteLsifDataByUploadIds.With(ctx, &err, observation.Args{LogFields: []otlog.Field{
+		otlog.Int("numBundleIDs", len(bundleIDs)),
+		otlog.String("bundleIDs", intsToString(bundleIDs)),
 	}})
 	defer endObservation(1, observation.Args{})
 
@@ -57,7 +57,7 @@ func (s *store) DeleteLsifDataByUploadIds(ctx context.Context, bundleIDs ...int)
 	}()
 
 	for _, tableName := range tableNames {
-		trace.Log(log.String("tableName", tableName))
+		trace.Log(otlog.String("tableName", tableName))
 
 		query := sqlf.Sprintf(deleteQuery, sqlf.Sprintf(tableName), sqlf.Join(ids, ","))
 		if err := tx.Exec(ctx, query); err != nil {

sourcegraph/enterprise/internal/codeintel/uploads/internal/lsifstore/lsifstore_documents.go

@@ -4,13 +4,21 @@ import (
 	"context"
 
 	"github.com/keegancsmith/sqlf"
+	otlog "github.com/opentracing/opentracing-go/log"
 
 	"github.com/sourcegraph/sourcegraph/internal/database/basestore"
+	"github.com/sourcegraph/sourcegraph/internal/observation"
 )
 
 const documentsLimit = 100
 
-func (s *store) GetUploadDocumentsForPath(ctx context.Context, bundleID int, pathPattern string) ([]string, int, error) {
+func (s *store) GetUploadDocumentsForPath(ctx context.Context, bundleID int, pathPattern string) (_ []string, _ int, err error) {
+	ctx, _, endObservation := s.operations.getUploadDocumentsForPath.With(ctx, &err, observation.Args{LogFields: []otlog.Field{
+		otlog.Int("bundleID", bundleID),
+		otlog.String("pathPattern", pathPattern),
+	}})
+	defer endObservation(1, observation.Args{})
+
 	totalCount, _, err := basestore.ScanFirstInt(s.db.Query(ctx, sqlf.Sprintf(documentsCountQuery, bundleID, pathPattern)))
 	if err != nil {
 		return nil, 0, err

sourcegraph/enterprise/internal/codeintel/uploads/internal/lsifstore/lsifstore_reconcile.go

@@ -5,11 +5,19 @@ import (
 
 	"github.com/keegancsmith/sqlf"
 	"github.com/lib/pq"
+	otlog "github.com/opentracing/opentracing-go/log"
 
 	"github.com/sourcegraph/sourcegraph/internal/database/basestore"
+	"github.com/sourcegraph/sourcegraph/internal/observation"
 )
 
-func (s *store) IDsWithMeta(ctx context.Context, ids []int) (_ []int, error error) {
+func (s *store) IDsWithMeta(ctx context.Context, ids []int) (_ []int, err error) {
+	ctx, _, endObservation := s.operations.idsWithMeta.With(ctx, &err, observation.Args{LogFields: []otlog.Field{
+		otlog.Int("numIDs", len(ids)),
+		otlog.String("ids", intsToString(ids)),
+	}})
+	defer endObservation(1, observation.Args{})
+
 	return basestore.ScanInts(s.db.Query(ctx, sqlf.Sprintf(idsWithMetaQuery, pq.Array(ids))))
 }
 
@@ -18,6 +26,11 @@ SELECT m.dump_id FROM lsif_data_metadata m WHERE m.dump_id = ANY(%s)
 `
 
 func (s *store) ReconcileCandidates(ctx context.Context, batchSize int) (_ []int, err error) {
+	ctx, _, endObservation := s.operations.reconcileCandidates.With(ctx, &err, observation.Args{LogFields: []otlog.Field{
+		otlog.Int("batchSize", batchSize),
+	}})
+	defer endObservation(1, observation.Args{})
+
 	return basestore.ScanInts(s.db.Query(ctx, sqlf.Sprintf(reconcileQuery, batchSize)))
 }
 

sourcegraph/enterprise/internal/codeintel/uploads/internal/lsifstore/observability.go

@@ -9,6 +9,12 @@ import (
 
 type operations struct {
 	deleteLsifDataByUploadIds *observation.Operation
+	idsWithMeta               *observation.Operation
+	reconcileCandidates       *observation.Operation
+	getUploadDocumentsForPath *observation.Operation
+	scanDocuments             *observation.Operation
+	scanResultChunks          *observation.Operation
+	scanLocations             *observation.Operation
 	writeMeta                 *observation.Operation
 	writeDocuments            *observation.Operation
 	writeResultChunks         *observation.Operation
@@ -35,6 +41,12 @@ func newOperations(observationContext *observation.Context) *operations {
 
 	return &operations{
 		deleteLsifDataByUploadIds: op("DeleteLsifDataByUploadIds"),
+		idsWithMeta:               op("IDsWithMeta"),
+		reconcileCandidates:       op("ReconcileCandidates"),
+		getUploadDocumentsForPath: op("GetUploadDocumentsForPath"),
+		scanDocuments:             op("ScanDocuments"),
+		scanResultChunks:          op("ScanResultChunks"),
+		scanLocations:             op("ScanLocations"),
 		writeMeta:                 op("WriteMeta"),
 		writeDocuments:            op("WriteDocuments"),
 		writeResultChunks:         op("WriteResultChunks"),

sourcegraph/enterprise/internal/codeintel/uploads/internal/lsifstore/stream.go

@@ -4,13 +4,20 @@ import (
 	"context"
 
 	"github.com/keegancsmith/sqlf"
+	otlog "github.com/opentracing/opentracing-go/log"
 
 	"github.com/sourcegraph/sourcegraph/internal/database/basestore"
 	"github.com/sourcegraph/sourcegraph/internal/database/dbutil"
+	"github.com/sourcegraph/sourcegraph/internal/observation"
 	"github.com/sourcegraph/sourcegraph/lib/codeintel/precise"
 )
 
 func (s *store) ScanDocuments(ctx context.Context, id int, f func(path string, ranges map[precise.ID]precise.RangeData) error) (err error) {
+	ctx, _, endObservation := s.operations.scanDocuments.With(ctx, &err, observation.Args{LogFields: []otlog.Field{
+		otlog.Int("id", id),
+	}})
+	defer endObservation(1, observation.Args{})
+
 	return runQuery(ctx, s.db, sqlf.Sprintf(scanDocumentsQuery, id), func(dbs dbutil.Scanner) error {
 		var path string
 		var rawRanges []byte
@@ -35,6 +42,11 @@ ORDER BY path
 `
 
 func (s *store) ScanResultChunks(ctx context.Context, id int, f func(idx int, resultChunk precise.ResultChunkData) error) (err error) {
+	ctx, _, endObservation := s.operations.scanResultChunks.With(ctx, &err, observation.Args{LogFields: []otlog.Field{
+		otlog.Int("id", id),
+	}})
+	defer endObservation(1, observation.Args{})
+
 	return runQuery(ctx, s.db, sqlf.Sprintf(scanResultChunksQuery, id), func(dbs dbutil.Scanner) error {
 		var idx int
 		var rawData []byte
@@ -59,6 +71,11 @@ ORDER BY idx
 `
 
 func (s *store) ScanLocations(ctx context.Context, id int, f func(scheme, identifier, monikerType string, locations []precise.LocationData) error) (err error) {
+	ctx, _, endObservation := s.operations.scanLocations.With(ctx, &err, observation.Args{LogFields: []otlog.Field{
+		otlog.Int("id", id),
+	}})
+	defer endObservation(1, observation.Args{})
+
 	return runQuery(ctx, s.db, sqlf.Sprintf(scanLocationsQuery, id, id), func(dbs dbutil.Scanner) error {
 		var scheme, identifier, monikerType string
 		var rawData []byte