all: prefix span attributes with "achgateway."

moov-io · Nov 7, 2023 · 001b4f4 · 001b4f4
1 parent e01516f
commit 001b4f4
Show file tree

Hide file tree

Showing 15 changed files with 58 additions and 58 deletions.
diff --git a/internal/audittrail/storage_blob.go b/internal/audittrail/storage_blob.go
@@ -66,8 +66,8 @@ func (bs *blobStorage) Close() error {
 
 func (bs *blobStorage) SaveFile(ctx context.Context, path string, data []byte) error {
 	ctx, span := telemetry.StartSpan(ctx, "audittrail-save-file", trace.WithAttributes(
-		attribute.String("path", path),
-		attribute.Int("data_bytes", len(data)),
+		attribute.String("achgateway.path", path),
+		attribute.Int("achgateway.data_bytes", len(data)),
 	))
 	defer span.End()
 
@@ -114,7 +114,7 @@ func (bs *blobStorage) SaveFile(ctx context.Context, path string, data []byte) e
 
 func (bs *blobStorage) GetFile(ctx context.Context, path string) (io.ReadCloser, error) {
 	ctx, span := telemetry.StartSpan(ctx, "audittrail-get-file", trace.WithAttributes(
-		attribute.String("path", path),
+		attribute.String("achgateway.path", path),
 	))
 	defer span.End()
 

diff --git a/internal/incoming/odfi/cleanup.go b/internal/incoming/odfi/cleanup.go
@@ -76,8 +76,8 @@ func deleteFilesOnRemote(ctx context.Context, logger log.Logger, agent upload.Ag
 	}
 
 	ctx, span := telemetry.StartSpan(ctx, "odfi-delete-files-on-remote", trace.WithAttributes(
-		attribute.String("dir", baseDir),
-		attribute.Int("files", len(infos)),
+		attribute.String("achgateway.dir", baseDir),
+		attribute.Int("achgateway.files", len(infos)),
 	))
 	defer span.End()
 
@@ -110,8 +110,8 @@ func deleteEmptyFiles(ctx context.Context, logger log.Logger, agent upload.Agent
 	}
 
 	ctx, span := telemetry.StartSpan(ctx, "odfi-delete-empty-files", trace.WithAttributes(
-		attribute.String("dir", baseDir),
-		attribute.Int("files", len(entries)),
+		attribute.String("achgateway.dir", baseDir),
+		attribute.Int("achgateway.files", len(entries)),
 	))
 	defer span.End()
 

diff --git a/internal/incoming/odfi/corrections.go b/internal/incoming/odfi/corrections.go
@@ -76,8 +76,8 @@ func (pc *correctionProcessor) Handle(ctx context.Context, logger log.Logger, fi
 	}
 
 	ctx, span := telemetry.StartSpan(ctx, "odfi-correction-file", trace.WithAttributes(
-		attribute.String("filepath", file.Filepath),
-		attribute.Int("corrections", len(file.ACHFile.NotificationOfChange)),
+		attribute.String("achgateway.filepath", file.Filepath),
+		attribute.Int("achgateway.corrections", len(file.ACHFile.NotificationOfChange)),
 	))
 	defer span.End()
 

diff --git a/internal/incoming/odfi/download.go b/internal/incoming/odfi/download.go
@@ -82,8 +82,8 @@ func (d *downloadedFiles) deleteEmptyDirs(ctx context.Context, agent upload.Agen
 		}
 
 		_, span := telemetry.StartSpan(ctx, "odfi-delete-empty-dirs", trace.WithAttributes(
-			attribute.String("path", path),
-			attribute.Int("files", len(infos)),
+			attribute.String("achgateway.path", path),
+			attribute.Int("achgateway.files", len(infos)),
 		))
 		defer span.End()
 

diff --git a/internal/incoming/odfi/incoming.go b/internal/incoming/odfi/incoming.go
@@ -84,7 +84,7 @@ func (pc *incomingEmitter) Handle(ctx context.Context, logger log.Logger, file F
 	}
 
 	ctx, span := telemetry.StartSpan(ctx, "odfi-incoming-file", trace.WithAttributes(
-		attribute.String("filepath", file.Filepath),
+		attribute.String("achgateway.filepath", file.Filepath),
 	))
 	defer span.End()
 

diff --git a/internal/incoming/odfi/prenotes.go b/internal/incoming/odfi/prenotes.go
@@ -70,7 +70,7 @@ func (pc *prenoteEmitter) Handle(ctx context.Context, logger log.Logger, file Fi
 	}
 
 	ctx, span := telemetry.StartSpan(ctx, "odfi-prenotes-file", trace.WithAttributes(
-		attribute.String("filepath", file.Filepath),
+		attribute.String("achgateway.filepath", file.Filepath),
 	))
 	defer span.End()
 

diff --git a/internal/incoming/odfi/reconciliation.go b/internal/incoming/odfi/reconciliation.go
@@ -85,7 +85,7 @@ func (pc *creditReconciliation) Handle(ctx context.Context, logger log.Logger, f
 	}
 
 	ctx, span := telemetry.StartSpan(ctx, "odfi-reconciliation-file", trace.WithAttributes(
-		attribute.String("filepath", file.Filepath),
+		attribute.String("achgateway.filepath", file.Filepath),
 	))
 	defer span.End()
 

diff --git a/internal/incoming/odfi/returns.go b/internal/incoming/odfi/returns.go
@@ -87,8 +87,8 @@ func (pc *returnEmitter) Handle(ctx context.Context, logger log.Logger, file Fil
 	logger.Log("odfi: processing return file")
 
 	ctx, span := telemetry.StartSpan(ctx, "odfi-return-file", trace.WithAttributes(
-		attribute.String("filename", file.Filepath),
-		attribute.Int("return_entries", len(file.ACHFile.ReturnEntries)),
+		attribute.String("achgateway.filename", file.Filepath),
+		attribute.Int("achgateway.return_entries", len(file.ACHFile.ReturnEntries)),
 	))
 	defer span.End()
 

diff --git a/internal/incoming/odfi/scheduler.go b/internal/incoming/odfi/scheduler.go
@@ -128,7 +128,7 @@ func (s *PeriodicScheduler) tickAll() error {
 		}
 
 		ctx, span := telemetry.StartSpan(context.Background(), "odfi-scheduler", trace.WithAttributes(
-			attribute.String("shard", shardName),
+			attribute.String("achgateway.shard", shardName),
 		))
 		defer span.End()
 
@@ -148,7 +148,7 @@ func (s *PeriodicScheduler) tickAll() error {
 
 func (s *PeriodicScheduler) tick(ctx context.Context, logger log.Logger, shard *service.Shard) error {
 	ctx, span := telemetry.StartSpan(ctx, "odfi-scheduler-tick", trace.WithAttributes(
-		attribute.String("shard", shard.Name),
+		attribute.String("achgateway.shard", shard.Name),
 	))
 	defer span.End()
 

diff --git a/internal/incoming/web/api_files.go b/internal/incoming/web/api_files.go
@@ -79,8 +79,8 @@ func (c *FilesController) CreateFileHandler(w http.ResponseWriter, r *http.Reque
 	}
 
 	ctx, span := telemetry.StartSpan(r.Context(), "create-file-handler", trace.WithAttributes(
-		attribute.String("shardKey", shardKey),
-		attribute.String("fileID", fileID),
+		attribute.String("achgateway.shardKey", shardKey),
+		attribute.String("achgateway.fileID", fileID),
 	))
 	defer span.End()
 
@@ -161,8 +161,8 @@ func (c *FilesController) CancelFileHandler(w http.ResponseWriter, r *http.Reque
 	}
 
 	ctx, span := telemetry.StartSpan(r.Context(), "cancel-file-handler", trace.WithAttributes(
-		attribute.String("shardKey", shardKey),
-		attribute.String("fileID", fileID),
+		attribute.String("achgateway.shardKey", shardKey),
+		attribute.String("achgateway.fileID", fileID),
 	))
 	defer span.End()
 

diff --git a/internal/pipeline/aggregate.go b/internal/pipeline/aggregate.go
@@ -181,9 +181,9 @@ func (xfagg *aggregator) withEachFile(when time.Time) error {
 	}).Logf("ended %s %s cutoff window processing", window, tzname)
 
 	ctx, span := telemetry.StartSpan(context.Background(), "automated-cutoff", trace.WithAttributes(
-		attribute.String("shard", xfagg.shard.Name),
-		attribute.String("timezone", tzname),
-		attribute.String("window", window),
+		attribute.String("achgateway.shard", xfagg.shard.Name),
+		attribute.String("achgateway.timezone", tzname),
+		attribute.String("achgateway.window", window),
 	))
 	defer span.End()
 
@@ -207,7 +207,7 @@ func (xfagg *aggregator) manualCutoff(waiter manuallyTriggeredCutoff) {
 	logger.Info().Log("starting manual cutoff window processing")
 
 	ctx, span := telemetry.StartSpan(context.Background(), "manual-cutoff", trace.WithAttributes(
-		attribute.String("shard", xfagg.shard.Name),
+		attribute.String("achgateway.shard", xfagg.shard.Name),
 	))
 	defer span.End()
 
@@ -273,8 +273,8 @@ func (xfagg *aggregator) uploadFile(ctx context.Context, index int, agent upload
 	}
 
 	ctx, span := telemetry.StartSpan(ctx, "upload-file", trace.WithAttributes(
-		attribute.String("filename", filename),
-		attribute.String("shard", xfagg.shard.Name),
+		attribute.String("achgateway.filename", filename),
+		attribute.String("achgateway.shard", xfagg.shard.Name),
 	))
 	defer span.End()
 

diff --git a/internal/pipeline/events_api.go b/internal/pipeline/events_api.go
@@ -61,7 +61,7 @@ func (fr *FileReceiver) manuallyProduceFileUploaded() http.HandlerFunc {
 		}
 
 		ctx, span := telemetry.StartSpan(r.Context(), "pipeline-manual-file-uploaded", trace.WithAttributes(
-			attribute.String("dir", dir),
+			attribute.String("achgateway.dir", dir),
 		))
 		defer span.End()
 

diff --git a/internal/pipeline/merging.go b/internal/pipeline/merging.go
@@ -141,8 +141,8 @@ func (m *filesystemMerging) isolateMergableDir(ctx context.Context) (string, err
 	newdir := filepath.Join(fmt.Sprintf("%s-%v", m.shard.Name, time.Now().Format("20060102-150405")))
 
 	_, span := telemetry.StartSpan(ctx, "isolate-mergable-dir", trace.WithAttributes(
-		attribute.String("shard", m.shard.Name),
-		attribute.String("dir", newdir),
+		attribute.String("achgateway.shard", m.shard.Name),
+		attribute.String("achgateway.dir", newdir),
 	))
 	defer span.End()
 
@@ -152,8 +152,8 @@ func (m *filesystemMerging) isolateMergableDir(ctx context.Context) (string, err
 
 func (m *filesystemMerging) getNonCanceledMatches(ctx context.Context, dir string) ([]string, error) {
 	_, span := telemetry.StartSpan(ctx, "get-non-canceled-matches", trace.WithAttributes(
-		attribute.String("shard", m.shard.Name),
-		attribute.String("dir", dir),
+		attribute.String("achgateway.shard", m.shard.Name),
+		attribute.String("achgateway.dir", dir),
 	))
 	defer span.End()
 
@@ -167,8 +167,8 @@ func (m *filesystemMerging) getNonCanceledMatches(ctx context.Context, dir strin
 	}
 
 	span.SetAttributes(
-		attribute.Int("positive_matches", len(positiveMatches)),
-		attribute.Int("negative_matches", len(negativeMatches)),
+		attribute.Int("achgateway.positive_matches", len(positiveMatches)),
+		attribute.Int("achgateway.negative_matches", len(negativeMatches)),
 	)
 
 	var out []string
@@ -259,8 +259,8 @@ func (m *filesystemMerging) WithEachMerged(ctx context.Context, f func(context.C
 	}
 
 	_, span := telemetry.StartSpan(ctx, "with-each-merged", trace.WithAttributes(
-		attribute.String("shard", m.shard.Name),
-		attribute.String("dir", dir),
+		attribute.String("achgateway.shard", m.shard.Name),
+		attribute.String("achgateway.dir", dir),
 	))
 	defer span.End()
 
@@ -350,7 +350,7 @@ func (m *filesystemMerging) WithEachMerged(ctx context.Context, f func(context.C
 	logger.Logf("wrote %d of %d files to remote agent", successfulRemoteWrites, len(files))
 
 	span.SetAttributes(
-		attribute.Int("successful_remote_writes", successfulRemoteWrites),
+		attribute.Int("achgateway.successful_remote_writes", successfulRemoteWrites),
 	)
 
 	if !el.Empty() {
@@ -379,10 +379,10 @@ func makeIndices(total, groups int) []int {
 }
 
 func (m *filesystemMerging) chunkFilesTogether(ctx context.Context, indices []int, matches []string, conditions ach.Conditions) ([]*ach.File, error) {
-	_, span := telemetry.StartSpan(context.Background(), "chunk-files-together", trace.WithAttributes(
-		attribute.String("shard", m.shard.Name),
-		attribute.Int("indices_num", len(indices)),
-		attribute.Int("matches", len(matches)),
+	_, span := telemetry.StartSpan(ctx, "chunk-files-together", trace.WithAttributes(
+		attribute.String("achgateway.shard", m.shard.Name),
+		attribute.Int("achgateway.indices_num", len(indices)),
+		attribute.Int("achgateway.matches", len(matches)),
 	))
 	defer span.End()
 

diff --git a/internal/upload/ftp.go b/internal/upload/ftp.go
@@ -117,8 +117,8 @@ func (agent *FTPTransferAgent) Hostname() string {
 
 func (agent *FTPTransferAgent) Delete(ctx context.Context, path string) error {
 	_, span := telemetry.StartSpan(ctx, "agent-ftp-delete", trace.WithAttributes(
-		attribute.String("hostname", agent.Hostname()),
-		attribute.String("path", path),
+		attribute.String("achgateway.hostname", agent.Hostname()),
+		attribute.String("achgateway.path", path),
 	))
 	defer span.End()
 
@@ -136,8 +136,8 @@ func (agent *FTPTransferAgent) UploadFile(ctx context.Context, f File) error {
 	pathToWrite := filepath.Join(agent.OutboundPath(), f.Filepath)
 
 	_, span := telemetry.StartSpan(ctx, "agent-ftp-upload", trace.WithAttributes(
-		attribute.String("hostname", agent.Hostname()),
-		attribute.String("path", pathToWrite),
+		attribute.String("achgateway.hostname", agent.Hostname()),
+		attribute.String("achgateway.path", pathToWrite),
 	))
 	defer span.End()
 
@@ -146,8 +146,8 @@ func (agent *FTPTransferAgent) UploadFile(ctx context.Context, f File) error {
 
 func (agent *FTPTransferAgent) ReadFile(ctx context.Context, path string) (*File, error) {
 	_, span := telemetry.StartSpan(ctx, "agent-ftp-read", trace.WithAttributes(
-		attribute.String("hostname", agent.Hostname()),
-		attribute.String("path", path),
+		attribute.String("achgateway.hostname", agent.Hostname()),
+		attribute.String("achgateway.path", path),
 	))
 	defer span.End()
 
@@ -175,8 +175,8 @@ func (agent *FTPTransferAgent) GetReturnFiles(ctx context.Context) ([]string, er
 
 func (agent *FTPTransferAgent) readFilepaths(ctx context.Context, dir string) ([]string, error) {
 	_, span := telemetry.StartSpan(ctx, "agent-ftp-list", trace.WithAttributes(
-		attribute.String("hostname", agent.Hostname()),
-		attribute.String("path", dir),
+		attribute.String("achgateway.hostname", agent.Hostname()),
+		attribute.String("achgateway.path", dir),
 	))
 	defer span.End()
 

diff --git a/internal/upload/sftp.go b/internal/upload/sftp.go
@@ -101,8 +101,8 @@ func (agent *SFTPTransferAgent) Hostname() string {
 
 func (agent *SFTPTransferAgent) Delete(ctx context.Context, path string) error {
 	_, span := telemetry.StartSpan(ctx, "agent-sftp-delete", trace.WithAttributes(
-		attribute.String("hostname", agent.Hostname()),
-		attribute.String("path", path),
+		attribute.String("achgateway.hostname", agent.Hostname()),
+		attribute.String("achgateway.path", path),
 	))
 	defer span.End()
 
@@ -117,8 +117,8 @@ func (agent *SFTPTransferAgent) UploadFile(ctx context.Context, f File) error {
 	pathToWrite := filepath.Join(agent.OutboundPath(), filepath.Base(f.Filepath))
 
 	_, span := telemetry.StartSpan(ctx, "agent-sftp-upload", trace.WithAttributes(
-		attribute.String("hostname", agent.Hostname()),
-		attribute.String("path", pathToWrite),
+		attribute.String("achgateway.hostname", agent.Hostname()),
+		attribute.String("achgateway.path", pathToWrite),
 	))
 	defer span.End()
 
@@ -127,8 +127,8 @@ func (agent *SFTPTransferAgent) UploadFile(ctx context.Context, f File) error {
 
 func (agent *SFTPTransferAgent) ReadFile(ctx context.Context, path string) (*File, error) {
 	_, span := telemetry.StartSpan(ctx, "agent-sftp-read", trace.WithAttributes(
-		attribute.String("hostname", agent.Hostname()),
-		attribute.String("path", path),
+		attribute.String("achgateway.hostname", agent.Hostname()),
+		attribute.String("achgateway.path", path),
 	))
 	defer span.End()
 
@@ -156,8 +156,8 @@ func (agent *SFTPTransferAgent) GetReturnFiles(ctx context.Context) ([]string, e
 
 func (agent *SFTPTransferAgent) readFilepaths(ctx context.Context, dir string) ([]string, error) {
 	_, span := telemetry.StartSpan(ctx, "agent-sftp-list", trace.WithAttributes(
-		attribute.String("hostname", agent.Hostname()),
-		attribute.String("path", dir),
+		attribute.String("achgateway.hostname", agent.Hostname()),
+		attribute.String("achgateway.path", dir),
 	))
 	defer span.End()