feat: add observability interfaces [IDE-175] (#3)

observability/analytics.go

@@ -0,0 +1,37 @@
+package observability
+
+import "time"
+
+// Analytics exposes different metric tracking functions.
+type Analytics interface {
+	TrackScan(bool, ScanMetrics)
+}
+
+// ScanMetrics contains various metrics about the Snyk Code scan.
+type ScanMetrics struct {
+	lastScanStartTime time.Time
+	lastScanFileCount int
+}
+
+// NewScanMetrics is used to create a ScanMetrics object.
+func NewScanMetrics(lastScanStartTime time.Time, lastScanFileCount int) ScanMetrics {
+	return ScanMetrics{
+		lastScanStartTime: lastScanStartTime,
+		lastScanFileCount: lastScanFileCount,
+	}
+}
+
+// GetDuration computes the duration since the last time a scan starter.
+func (s ScanMetrics) GetDuration() time.Duration {
+	return time.Since(s.lastScanStartTime)
+}
+
+// GetLastScanFileCount returns the count of files since the last scan.
+func (s ScanMetrics) GetLastScanFileCount() int {
+	return s.lastScanFileCount
+}
+
+// SetLastScanFileCount sets the count of files since the last scan.
+func (s *ScanMetrics) SetLastScanFileCount(lastScanFileCount int) {
+	s.lastScanFileCount = lastScanFileCount
+}

observability/instrumentor.go

@@ -0,0 +1,31 @@
+package observability
+
+import (
+	"context"
+)
+
+// Instrumentor exposes functions used for adding instrumentation context to functions.
+type Instrumentor interface {
+	StartSpan(ctx context.Context, operation string) Span
+	NewTransaction(
+		ctx context.Context,
+		txName string,
+		operation string,
+	) Span
+	Finish(span Span)
+}
+
+// Span exposes functions that have context about functions.
+type Span interface {
+	SetTransactionName(name string)
+	StartSpan(ctx context.Context)
+	Finish()
+	GetOperation() string
+	GetTxName() string
+
+	// GetTraceId Returns UUID of the trace
+	GetTraceId() string
+	Context() context.Context
+
+	GetDurationMs() int64
+}