feat(metrics): add runs by day and update returned types (#584)

Signed-off-by: Miguel Martinez Trivino <[email protected]>

Author: migmartri

app/controlplane/api/controlplane/v1/org_metrics.pb.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2023 The Chainloop Authors.
+// Copyright 2024 The Chainloop Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,50 +17,87 @@ syntax = "proto3";
 
 package controlplane.v1;
 
-option go_package = "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1;v1";
-import "validate/validate.proto";
 import "controlplane/v1/response_messages.proto";
+import "validate/validate.proto";
+import "workflowcontract/v1/crafting_schema.proto";
+
+option go_package = "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1;v1";
 
 service OrgMetricsService {
-	rpc Totals (OrgMetricsServiceTotalsRequest) returns (OrgMetricsServiceTotalsResponse);
-	rpc TopWorkflowsByRunsCount (TopWorkflowsByRunsCountRequest) returns (TopWorkflowsByRunsCountResponse);
+  rpc Totals(OrgMetricsServiceTotalsRequest) returns (OrgMetricsServiceTotalsResponse);
+  rpc TopWorkflowsByRunsCount(TopWorkflowsByRunsCountRequest) returns (TopWorkflowsByRunsCountResponse);
+  rpc DailyRunsCount(DailyRunsCountRequest) returns (DailyRunsCountResponse);
+}
+
+// Get the dayly count of runs by status
+message DailyRunsCountRequest {
+  optional string workflow_id = 1 [(validate.rules).string.uuid = true];
+
+  MetricsTimeWindow time_window = 2 [(validate.rules).enum = {
+    not_in: [0]
+  }];
+}
+
+message DailyRunsCountResponse {
+  repeated TotalByDay result = 1;
+
+  message TotalByDay {
+    // string format: "YYYY-MM-DD"
+    string date = 1;
+    MetricsStatusCount metrics = 2;
+  }
 }
 
 message OrgMetricsServiceTotalsRequest {
-  MetricsTimeWindow time_window = 1 [(validate.rules).enum = {not_in: [0]}];
+  MetricsTimeWindow time_window = 1 [(validate.rules).enum = {
+    not_in: [0]
+  }];
+}
+
+message OrgMetricsServiceTotalsResponse {
+  Result result = 1;
+
+  message Result {
+    int32 runs_total = 1;
+    repeated MetricsStatusCount runs_total_by_status = 2;
+    repeated MetricsRunnerCount runs_total_by_runner_type = 3;
+  }
+}
+
+message MetricsStatusCount {
+  int32 count = 1;
+  RunStatus status = 2;
+}
+
+message MetricsRunnerCount {
+  int32 count = 1;
+  workflowcontract.v1.CraftingSchema.Runner.RunnerType runner_type = 2;
 }
 
 message TopWorkflowsByRunsCountRequest {
   // top x number of runs to return
-  int32 num_workflows = 1 [(validate.rules).int32 = {gte: 1, lte: 20}];;
-  MetricsTimeWindow time_window = 2 [(validate.rules).enum = {not_in: [0]}];
+  int32 num_workflows = 1 [(validate.rules).int32 = {
+    gte: 1,
+    lte: 20
+  }];
+  MetricsTimeWindow time_window = 2 [(validate.rules).enum = {
+    not_in: [0]
+  }];
 }
 
 message TopWorkflowsByRunsCountResponse {
   repeated TotalByStatus result = 1;
 
   message TotalByStatus {
     WorkflowItem workflow = 1;
-    // Status -> [initialized, error, success]
-    map<string,int32> runs_total_by_status = 2;
-  }
-}
-
-message OrgMetricsServiceTotalsResponse {
-  Result result = 1;
-  
-  message Result {
-    int32 runs_total = 1;
-    // Status -> [initialized, error, success]
-    map<string,int32> runs_total_by_status = 2;
-    // runner_type -> [generic, github_action, ...]
-    map<string,int32> runs_total_by_runner_type = 3;
+    repeated MetricsStatusCount runs_total_by_status = 2;
   }
 }
 
 enum MetricsTimeWindow {
-    METRICS_TIME_WINDOW_UNSPECIFIED = 0;
-    METRICS_TIME_WINDOW_LAST_30_DAYS = 1;
-    METRICS_TIME_WINDOW_LAST_7_DAYS = 2;
-    METRICS_TIME_WINDOW_LAST_DAY = 3;
-} 
+  METRICS_TIME_WINDOW_UNSPECIFIED = 0;
+  METRICS_TIME_WINDOW_LAST_DAY = 1;
+  METRICS_TIME_WINDOW_LAST_7_DAYS = 2;
+  METRICS_TIME_WINDOW_LAST_30_DAYS = 3;
+  METRICS_TIME_WINDOW_LAST_90_DAYS = 4;
+}

app/controlplane/api/controlplane/v1/org_metrics.pb.validate.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2023 The Chainloop Authors.
+// Copyright 2024 The Chainloop Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -20,13 +20,22 @@ import "time"
 func (tw MetricsTimeWindow) ToDuration() *time.Duration {
 	var d time.Duration
 
+	var (
+		day     = 24 * time.Hour
+		week    = 7 * day
+		month   = 30 * day
+		quarter = 3 * month
+	)
+
 	switch tw {
+	case MetricsTimeWindow_METRICS_TIME_WINDOW_LAST_90_DAYS:
+		d = quarter
 	case MetricsTimeWindow_METRICS_TIME_WINDOW_LAST_30_DAYS:
-		d = 30 * 24 * time.Hour
+		d = month
 	case MetricsTimeWindow_METRICS_TIME_WINDOW_LAST_7_DAYS:
-		d = 7 * 24 * time.Hour
+		d = week
 	case MetricsTimeWindow_METRICS_TIME_WINDOW_LAST_DAY:
-		d = 24 * time.Hour
+		d = day
 	}
 
 	return &d