feat: trace

go.mod

@@ -4,6 +4,7 @@ go 1.17
 
 require (
 	github.com/briandowns/spinner v1.23.0
+	github.com/google/uuid v1.3.0
 	github.com/olekukonko/tablewriter v0.0.5
 	gopkg.in/yaml.v3 v3.0.1
 )

go.sum

@@ -955,6 +955,7 @@ github.com/google/s2a-go v0.1.0/go.mod h1:OJpEgntRZo8ugHpF9hkoLJbS5dSI20XZeXJ9JV
 github.com/google/s2a-go v0.1.3/go.mod h1:Ej+mSEMGRnqRzjc7VtF+jdBwYG5fuJfiZ8ELkjEwM0A=
 github.com/google/s2a-go v0.1.4/go.mod h1:Ej+mSEMGRnqRzjc7VtF+jdBwYG5fuJfiZ8ELkjEwM0A=
 github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/googleapis/enterprise-certificate-proxy v0.0.0-20220520183353-fd19c99a87aa/go.mod h1:17drOmN3MwGY7t0e+Ei9b45FFGA3fBs3x36SsCg1hq8=
 github.com/googleapis/enterprise-certificate-proxy v0.1.0/go.mod h1:17drOmN3MwGY7t0e+Ei9b45FFGA3fBs3x36SsCg1hq8=

internal/service/client.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"crypto/tls"
 	"fmt"
+	"github.com/dream11/odin/pkg/constant"
 	"strings"
 
 	"github.com/dream11/odin/pkg/config"
@@ -17,6 +18,9 @@ import (
 
 func grpcClient(ctx *context.Context) (*grpc.ClientConn, *context.Context, error) {
 	appConfig := config.GetConfig()
+	traceID := util.GenerateTraceID()
+	log.Debugf("Generated trace ID: %s", traceID)
+
 	if appConfig.BackendAddress == "" {
 		log.Fatal("Cannot create grpc client: Backend address is empty in config! Run `odin configure` to set backend address")
 	}
@@ -37,12 +41,13 @@ func grpcClient(ctx *context.Context) (*grpc.ClientConn, *context.Context, error
 		opts = append(opts, grpc.WithTransportCredentials(cred))
 	}
 
+	contextWithTrace := context.WithValue(*ctx, constant.TraceIDKey, traceID)
 	conn, err := grpc.Dial(appConfig.BackendAddress, opts...)
 
 	if err != nil {
 		return nil, nil, err
 	}
 	// Enrich context with authorisation metadata
-	requestCtx := metadata.AppendToOutgoingContext(*ctx, "Authorization", fmt.Sprintf("Bearer %s", appConfig.AccessToken))
+	requestCtx := metadata.AppendToOutgoingContext(contextWithTrace, "Authorization", fmt.Sprintf("Bearer %s", appConfig.AccessToken), string(constant.TraceIDKey), traceID)
 	return conn, &requestCtx, nil
 }

internal/service/component.go

@@ -43,6 +43,7 @@ func (e *Component) OperateComponent(ctx *context.Context, request *serviceProto
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 		if response != nil {
@@ -64,6 +65,7 @@ func (e *Component) ListComponentType(ctx *context.Context, request *component.L
 	client := component.NewComponentServiceClient(conn)
 	response, err := client.ListComponentType(*requestCtx, request)
 	if err != nil {
+		log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 		return nil, err
 	}
 
@@ -79,6 +81,7 @@ func (e *Component) DescribeComponentType(ctx *context.Context, request *compone
 	client := component.NewComponentServiceClient(conn)
 	response, err := client.DescribeComponentType(*requestCtx, request)
 	if err != nil {
+		log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 		return nil, err
 	}
 

internal/service/configure.go

@@ -2,6 +2,8 @@ package service
 
 import (
 	"context"
+	"github.com/dream11/odin/pkg/constant"
+	log "github.com/sirupsen/logrus"
 
 	auth "github.com/dream11/odin/proto/gen/go/dream11/od/auth/v1"
 )
@@ -18,6 +20,7 @@ func (c *Configure) GetUserToken(ctx *context.Context, request *auth.GetUserToke
 	client := auth.NewAuthServiceClient(conn)
 	response, err := client.GetUserToken(*requestCtx, request)
 	if err != nil {
+		log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 		return nil, err
 	}
 

internal/service/environment.go

@@ -24,6 +24,7 @@ func (e *Environment) ListEnvironments(ctx *context.Context, request *environmen
 	client := environment.NewEnvironmentServiceClient(conn)
 	response, err := client.ListEnvironment(*requestCtx, request)
 	if err != nil {
+		log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 		return nil, err
 	}
 
@@ -56,6 +57,7 @@ func (e *Environment) CreateEnvironment(ctx *context.Context, request *environme
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 		if response != nil {
@@ -96,6 +98,7 @@ func (e *Environment) DeleteEnvironment(ctx *context.Context, request *environme
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 		if response != nil {
@@ -119,6 +122,7 @@ func (e *Environment) UpdateEnvironment(ctx *context.Context, request *environme
 	response, err := client.UpdateEnvironment(*requestCtx, request)
 
 	if err != nil {
+		log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 		return nil, err
 	}
 
@@ -136,6 +140,7 @@ func (e *Environment) DescribeEnvironment(ctx *context.Context, request *environ
 	response, err := client.DescribeEnvironment(*requestCtx, request)
 
 	if err != nil {
+		log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 		return nil, err
 	}
 

internal/service/service.go

@@ -44,6 +44,7 @@ func (e *Service) DeployService(ctx *context.Context, request *serviceProto.Depl
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 
@@ -85,6 +86,7 @@ func (e *Service) DeployServiceSet(ctx *context.Context, request *serviceProto.D
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 
@@ -129,6 +131,7 @@ func (e *Service) DeployReleasedService(ctx *context.Context, request *servicePr
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 
@@ -175,6 +178,7 @@ func (e *Service) UndeployService(ctx *context.Context, request *serviceProto.Un
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 		if response != nil {
@@ -217,6 +221,7 @@ func (e *Service) OperateService(ctx *context.Context, request *serviceProto.Ope
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 		if response != nil {
@@ -270,6 +275,7 @@ func (e *Service) ReleaseService(ctx *context.Context, request *serviceProto.Rel
 			if errors.Is(err, context.Canceled) || err == io.EOF {
 				break
 			}
+			log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 			return err
 		}
 		if response != nil {
@@ -316,6 +322,7 @@ func (e *Service) DescribeService(ctx *context.Context, request *serviceProto.De
 	client := serviceProto.NewServiceServiceClient(conn)
 	response, err := client.DescribeService(*requestCtx, request)
 	if err != nil {
+		log.Errorf("TraceID: %s", (*requestCtx).Value(constant.TraceIDKey))
 		return nil, err
 	}
 

main.go

@@ -17,8 +17,14 @@ import (
 	_ "github.com/dream11/odin/cmd/undeploy"
 	_ "github.com/dream11/odin/cmd/update"
 	_ "github.com/dream11/odin/internal/ui"
+	"github.com/sirupsen/logrus"
 )
 
 func main() {
+	// Configure Logger to fix timestamp format
+	logrus.SetFormatter(&logrus.TextFormatter{
+		TimestampFormat: "2006-01-02 15:04:05", // Custom format
+		FullTimestamp:   true,
+	})
 	cmd.Execute()
 }

pkg/constant/constant.go

@@ -2,6 +2,9 @@ package constant
 
 import "time"
 
+// TraceID is the type for trace ID
+type TraceID string
+
 const (
 	// TEXT type output format
 	TEXT = "text"
@@ -18,4 +21,7 @@ const (
 
 	// SpinnerDelay Defines spinner delay
 	SpinnerDelay = 100 * time.Millisecond
+
+	// TraceIDKey is the key used to store traceID in context
+	TraceIDKey TraceID = "trace-id"
 )

pkg/util/util.go

@@ -2,6 +2,7 @@ package util
 
 import (
 	"fmt"
+	"github.com/google/uuid"
 	"net"
 	"strings"
 
@@ -51,3 +52,8 @@ func GenerateResponseMessageComponentSpecific(response *v1.ServiceResponse, comp
 	}
 	return message
 }
+
+// GenerateTraceID generates a trace id
+func GenerateTraceID() string {
+	return uuid.New().String()
+}