cleaned up

Signed-off-by: Daniel Rammer <[email protected]>
flyteorg · Mar 9, 2023 · 2568ebc · 2568ebc
1 parent 1810069
commit 2568ebc
Show file tree

Hide file tree

Showing 9 changed files with 246 additions and 44 deletions.
diff --git a/cli/pflags/api/namedtype_enumer.go b/cli/pflags/api/namedtype_enumer.go
diff --git a/storage/cached_rawstore.go b/storage/cached_rawstore.go
@@ -50,7 +50,7 @@ func (s *cachedRawStore) Head(ctx context.Context, reference DataReference) (Met
 
 // ReadRaw retrieves a byte array from the Blob store or an error
 func (s *cachedRawStore) ReadRaw(ctx context.Context, reference DataReference) (io.ReadCloser, error) {
-	ctx, span := telemetryutils.NewSpan(ctx, "blobstore-client", "flytestdlib.storage.cachedRawStore/ReadRaw")
+	ctx, span := telemetryutils.NewSpan(ctx, telemetryutils.BlobstoreClientTracer, "flytestdlib.storage.cachedRawStore/ReadRaw")
 	defer span.End()
 
 	key := []byte(reference)
@@ -88,7 +88,7 @@ func (s *cachedRawStore) ReadRaw(ctx context.Context, reference DataReference) (
 
 // WriteRaw stores a raw byte array.
 func (s *cachedRawStore) WriteRaw(ctx context.Context, reference DataReference, size int64, opts Options, raw io.Reader) error {
-	ctx, span := telemetryutils.NewSpan(ctx, "blobstore-client", "flytestdlib.storage.cachedRawStore/WriteRaw")
+	ctx, span := telemetryutils.NewSpan(ctx, telemetryutils.BlobstoreClientTracer, "flytestdlib.storage.cachedRawStore/WriteRaw")
 	defer span.End()
 
 	var buf bytes.Buffer

diff --git a/storage/protobuf_store.go b/storage/protobuf_store.go
@@ -33,7 +33,7 @@ type DefaultProtobufStore struct {
 }
 
 func (s DefaultProtobufStore) ReadProtobuf(ctx context.Context, reference DataReference, msg proto.Message) error {
-	ctx, span := telemetryutils.NewSpan(ctx, "blobstore-client", "flytestdlib.storage.DefaultProtobufStore/ReadProtobuf")
+	ctx, span := telemetryutils.NewSpan(ctx, telemetryutils.BlobstoreClientTracer, "flytestdlib.storage.DefaultProtobufStore/ReadProtobuf")
 	defer span.End()
 
 	rc, err := s.ReadRaw(ctx, reference)
@@ -67,7 +67,7 @@ func (s DefaultProtobufStore) ReadProtobuf(ctx context.Context, reference DataRe
 }
 
 func (s DefaultProtobufStore) WriteProtobuf(ctx context.Context, reference DataReference, opts Options, msg proto.Message) error {
-	ctx, span := telemetryutils.NewSpan(ctx, "blobstore-client", "flytestdlib.storage.DefaultProtobufStore/WriteProtobuf")
+	ctx, span := telemetryutils.NewSpan(ctx, telemetryutils.BlobstoreClientTracer, "flytestdlib.storage.DefaultProtobufStore/WriteProtobuf")
 	defer span.End()
 
 	t := s.metrics.MarshalTime.Start()

diff --git a/telemetryutils/config.go b/telemetryutils/config.go
@@ -28,18 +28,18 @@ var (
 )
 
 type Config struct {
-	FileConfig   FileConfig `json:"file", pflag:",TODO"`
-	JaegerConfig JaegerConfig `json:"jaeger", pflag:",TODO"`
+	FileConfig   FileConfig `json:"file" pflag:",Configuration for exporting telemetry traces to a file"`
+	JaegerConfig JaegerConfig `json:"jaeger" pflag:",Configuration for exporting telemetry traces to a jaeger"`
 }
 
 type FileConfig struct {
-	Enabled  bool   `json:"enabled" pflag:",TODO"`
-	Filename string `json:"filename" pflag:",TODO"`
+	Enabled  bool   `json:"enabled" pflag:",Set to true to enable the file exporter"`
+	Filename string `json:"filename" pflag:",Filename to store exported telemetry traces"`
 }
 
 type JaegerConfig struct {
-	Enabled  bool   `json:"enabled" pflag:",TODO"`
-	Endpoint string `json:"endpoint" pflag:",TODO"`
+	Enabled  bool   `json:"enabled" pflag:",Set to true to enable the jaeger exporter"`
+	Endpoint string `json:"endpoint" pflag:",Endpoint for the jaeger telemtry trace ingestor"`
 }
 
 func GetConfig() *Config {

diff --git a/telemetryutils/config_flags.go b/telemetryutils/config_flags.go
diff --git a/telemetryutils/config_flags_test.go b/telemetryutils/config_flags_test.go
diff --git a/telemetryutils/factory.go b/telemetryutils/factory.go
@@ -5,8 +5,6 @@ import (
 
 	"github.com/flyteorg/flytestdlib/version"
 
-	//"go.opentelemetry.io/otel"
-	//"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
 	"go.opentelemetry.io/otel/exporters/jaeger"
 	"go.opentelemetry.io/otel/sdk/resource"
@@ -15,6 +13,14 @@ import (
 	semconv "go.opentelemetry.io/otel/semconv/v1.12.0"
 )
 
+const (
+	AdminClientTracer       = "admin-client"
+	BlobstoreClientTracer   = "blobstore-client"
+	DataCatalogClientTracer = "datacatalog-client"
+	FlytePropellerTracer    = "flytepropeller"
+	K8sClientTracer         = "k8s-client"
+)
+
 var tracerProviders = make(map[string]*trace.TracerProvider)
 var noopTracerProvider = rawtrace.NewNoopTracerProvider()
 
@@ -85,6 +91,5 @@ func GetTracerProvider(serviceName string) rawtrace.TracerProvider {
 		return t
 	}
 
-	// TODO @hamersaw - add warning "tracerProvider 'foo' not registered"
 	return noopTracerProvider
 }