monitor: replaced basic RPC with gRPC

Author: mvisonneau

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [0ver](https://0ver.org) (more or less).
 - Upgraded most dependencies to their lastest versions
 - Fixed child pipeline jobs not found whilst looking up through bridges (#345)
 - `gitlab_ci_pipeline_job_queued_duration_seconds` & `gitlab_ci_pipeline_queued_duration_seconds` will now be leveraging the value returned through the GitLab API instead of computing it with (startedAt - createdAt)
+- Refactored the RPC layer used for CLI monitoring with gRPC
 
 ## [v0.5.3] - 2022-02-11
 

Makefile

@@ -34,6 +34,15 @@ release: ## Build & release the binaries (stable)
 	goreleaser release --rm-dist
 	find dist -type f -name "*.snap" -exec snapcraft upload --release stable,edge '{}' \;
 
+.PHONY: protoc
+protoc: setup ## Generate golang from .proto files
+	@command -v protoc 2>&1 >/dev/null        || (echo "protoc needs to be available in PATH: https://github.com/protocolbuffers/protobuf/releases"; false)
+	@command -v protoc-gen-go 2>&1 >/dev/null || go install google.golang.org/grpc/cmd/[email protected]
+	protoc \
+		--go_out=. --go_opt=paths=source_relative \
+		--go-grpc_out=. --go-grpc_opt=paths=source_relative \
+		pkg/monitor/protobuf/monitor.proto
+
 .PHONY: prerelease
 prerelease: setup ## Build & prerelease the binaries (edge)
 	@\

examples/opentelemetry/gitlab-ci-pipelines-exporter.yml

@@ -13,7 +13,6 @@ gitlab:
 redis:
   url: redis://redis:6379
 
-
 # Example public projects to monitor
 projects:
   - name: gitlab-org/gitlab-runner

internal/cmd/run.go

@@ -10,7 +10,7 @@ import (
 	"time"
 
 	"github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/controller"
-	"github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/monitor/rpc"
+	monitoringServer "github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/monitor/server"
 	log "github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"
 )
@@ -32,14 +32,13 @@ func Run(cliCtx *cli.Context) (int, error) {
 
 	// Start the monitoring RPC server
 	go func(c *controller.Controller) {
-		rpc.ServeUNIX(
-			rpc.NewServer(
-				c.Gitlab,
-				c.Config,
-				c.Store,
-				c.TaskController.TaskSchedulingMonitoring,
-			),
+		s := monitoringServer.NewServer(
+			c.Gitlab,
+			c.Config,
+			c.Store,
+			c.TaskController.TaskSchedulingMonitoring,
 		)
+		s.Serve()
 	}(&c)
 
 	// Graceful shutdowns

pkg/controller/scheduler.go

@@ -455,11 +455,8 @@ func (c *Controller) ScheduleTaskWithTicker(ctx context.Context, tt schemas.Task
 
 				return
 			case <-ticker.C:
-				switch tt {
-				default:
-					c.ScheduleTask(ctx, tt, "_")
-					c.TaskController.monitorNextTaskScheduling(tt, intervalSeconds)
-				}
+				c.ScheduleTask(ctx, tt, "_")
+				c.TaskController.monitorNextTaskScheduling(tt, intervalSeconds)
 			}
 		}
 	}(ctx)

pkg/monitor/client/client.go

@@ -0,0 +1,36 @@
+package client
+
+import (
+	"context"
+	"net/url"
+
+	pb "github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/monitor/protobuf"
+	log "github.com/sirupsen/logrus"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/credentials/insecure"
+)
+
+// Client ..
+type Client struct {
+	pb.MonitorClient
+}
+
+// NewClient ..
+func NewClient(ctx context.Context, endpoint *url.URL) *Client {
+	log.WithField("endpoint", endpoint.String()).Debug("establishing gRPC connection to the server..")
+
+	conn, err := grpc.DialContext(
+		ctx,
+		endpoint.String(),
+		grpc.WithTransportCredentials(insecure.NewCredentials()),
+	)
+	if err != nil {
+		log.WithField("endpoint", endpoint.String()).WithField("error", err).Fatal("could not connect to the server")
+	}
+
+	log.Debug("gRPC connection established")
+
+	return &Client{
+		MonitorClient: pb.NewMonitorClient(conn),
+	}
+}

pkg/monitor/monitor.go

@@ -0,0 +1,8 @@
+package monitor
+
+import "time"
+
+type TaskSchedulingStatus struct {
+	Last time.Time
+	Next time.Time
+}