feat(otel): integrate OTEL using gRPC interceptor (#223)

Because

- Opentelemetry stack requires the application instrumented in
observable layers and components. We desire to have Instill Core a
middleware/interceptor approach so functions in handler, service and
repository layer can be instrumented automatically.

This commit

- builds the ground of the instrument which enable handler OTEL tracing
interceptor using the latest `x/otel`, `x/errors` and `x/log` package
- makes naming consistent

Author: pinglin

.github/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 ARG GOLANG_VERSION=1.24.4
 FROM golang:${GOLANG_VERSION}-bullseye
 
-ARG SERVICE_NAME
+ARG SERVICE_NAME SERVICE_VERSION
 
 WORKDIR /${SERVICE_NAME}
 
@@ -29,6 +29,9 @@ RUN chown -R nobody:nogroup /go
 ENV GOCACHE=/go/.cache/go-build
 ENV GOENV=/go/.config/go/env
 
+ENV SERVICE_NAME=${SERVICE_NAME}
+ENV SERVICE_VERSION=${SERVICE_VERSION}
+
 USER nobody:nogroup
 
 ENTRYPOINT ["tail", "-f", "/dev/null"]

Dockerfile.dev

@@ -2,41 +2,57 @@ package main
 
 import (
 	"context"
-	"fmt"
+	"log"
 	"time"
 
 	"go.uber.org/zap"
 	"google.golang.org/grpc/metadata"
 
+	grpczap "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap"
+
 	"github.com/instill-ai/artifact-backend/config"
 	"github.com/instill-ai/artifact-backend/pkg/service"
-	"github.com/instill-ai/x/log"
 
-	grpcclient "github.com/instill-ai/artifact-backend/pkg/client/grpc"
 	pipelinepb "github.com/instill-ai/protogen-go/pipeline/pipeline/v1beta"
+	clientx "github.com/instill-ai/x/client"
+	clientgrpcx "github.com/instill-ai/x/client/grpc"
+	logx "github.com/instill-ai/x/log"
 )
 
 func main() {
 	ctx := context.Background()
 
-	log.Debug = config.Config.Server.Debug
-	logger, _ := log.GetZapLogger(ctx)
+	if err := config.Init(config.ParseConfigFlag()); err != nil {
+		log.Fatal(err.Error())
+	}
+
+	logx.Debug = config.Config.Server.Debug
+	logger, _ := logx.GetZapLogger(context.Background())
+	defer func() {
+		// can't handle the error due to https://github.com/uber-go/zap/issues/880
+		_ = logger.Sync()
+	}()
 
-	if err := config.Init(); err != nil {
-		logger.Fatal("Failed to initialize config", zap.Error(err))
+	// Set gRPC logging based on debug mode
+	if config.Config.Server.Debug {
+		grpczap.ReplaceGrpcLoggerV2WithVerbosity(logger, 0) // All logs
+	} else {
+		grpczap.ReplaceGrpcLoggerV2WithVerbosity(logger, 3) // verbosity 3 will avoid [transport] from emitting
 	}
 
-	pipelinePublicGrpcConn, err := grpcclient.NewGRPCConn(
-		fmt.Sprintf("%v:%v", config.Config.PipelineBackend.Host,
-			config.Config.PipelineBackend.PublicPort),
-		config.Config.PipelineBackend.HTTPS.Cert,
-		config.Config.PipelineBackend.HTTPS.Key)
+	pipelinePublicServiceClient, pipelinePublicClose, err := clientgrpcx.NewClient[pipelinepb.PipelinePublicServiceClient](
+		clientgrpcx.WithServiceConfig(clientx.ServiceConfig{
+			Host:       config.Config.PipelineBackend.Host,
+			PublicPort: config.Config.PipelineBackend.PublicPort,
+		}),
+		clientgrpcx.WithSetOTELClientHandler(config.Config.OTELCollector.Enable),
+	)
 	if err != nil {
-		logger.Fatal("Failed to create pipeline client", zap.Error(err))
+		logger.Fatal("failed to create pipeline public service client", zap.Error(err))
 	}
 	defer func() {
-		if err := pipelinePublicGrpcConn.Close(); err != nil {
-			logger.Error("Failed to close pipeline client", zap.Error(err))
+		if err := pipelinePublicClose(); err != nil {
+			logger.Error("failed to close pipeline public service client", zap.Error(err))
 		}
 	}()
 
@@ -46,7 +62,7 @@ func main() {
 
 	upserter := &service.PipelineReleaseUpserter{
 		FS:                          service.PresetPipelinesFS,
-		PipelinePublicServiceClient: pipelinepb.NewPipelinePublicServiceClient(pipelinePublicGrpcConn),
+		PipelinePublicServiceClient: pipelinePublicServiceClient,
 	}
 
 	for _, pr := range service.PresetPipelinesList {