feat: add profiler to controlplane (#1546)

Signed-off-by: Miguel Martinez <miguel@chainloop.dev>

Author: migmartri

.golangci.yml

@@ -34,6 +34,8 @@ linters-settings:
     excludes:
       # https://github.com/moby/moby/issues/48358
       - G115
+      # We have the endpoint enabled on demand  
+      - G108
   gofmt:
     simplify: true
   dupl:

app/controlplane/cmd/main.go

@@ -36,11 +36,14 @@ import (
 	"github.com/chainloop-dev/chainloop/pkg/credentials/manager"
 	"github.com/chainloop-dev/chainloop/pkg/servicelogger"
 
+	_ "net/http/pprof"
+
 	"github.com/go-kratos/kratos/v2"
 	"github.com/go-kratos/kratos/v2/config"
 	"github.com/go-kratos/kratos/v2/config/env"
 	"github.com/go-kratos/kratos/v2/config/file"
 	"github.com/go-kratos/kratos/v2/log"
+	"github.com/go-kratos/kratos/v2/transport"
 	"github.com/go-kratos/kratos/v2/transport/grpc"
 	"github.com/go-kratos/kratos/v2/transport/http"
 )
@@ -61,15 +64,20 @@ func init() {
 	flag.StringVar(&flagconf, "conf", "../configs", "config path, eg: -conf config.yaml")
 }
 
-func newApp(logger log.Logger, gs *grpc.Server, hs *http.Server, ms *server.HTTPMetricsServer, expirer *biz.WorkflowRunExpirerUseCase, plugins sdk.AvailablePlugins, tokenSync *biz.APITokenSyncerUseCase) *app {
+func newApp(logger log.Logger, gs *grpc.Server, hs *http.Server, ms *server.HTTPMetricsServer, profilerSvc *server.HTTPProfilerServer, expirer *biz.WorkflowRunExpirerUseCase, plugins sdk.AvailablePlugins, tokenSync *biz.APITokenSyncerUseCase, cfg *conf.Bootstrap) *app {
+	servers := []transport.Server{gs, hs, ms}
+	if cfg.EnableProfiler {
+		servers = append(servers, profilerSvc)
+	}
+
 	return &app{
 		kratos.New(
 			kratos.ID(id),
 			kratos.Name(Name),
 			kratos.Version(Version),
 			kratos.Metadata(map[string]string{}),
 			kratos.Logger(logger),
-			kratos.Server(gs, hs, ms),
+			kratos.Server(servers...),
 		), expirer, plugins, tokenSync}
 }
 

app/controlplane/cmd/wire_gen.go

@@ -83,4 +83,6 @@ prometheus_integration:
 policy_providers:
   - name: chainloop
     default: true
-    url: http://localhost:8002/v1
+    url: http://localhost:8002/v1
+
+enable_profiler: true

app/controlplane/configs/config.devel.yaml

@@ -87,4 +87,6 @@ onboarding:
 
 # Organizations with Prometheus integration enabled
 prometheus_integration:
-  - org_name: "my-org"
+  - org_name: "my-org"
+
+enable_profiler: true

app/controlplane/configs/samples/config.yaml

@@ -68,15 +68,18 @@ message Bootstrap {
 
   // providers for external policy repositories
   repeated PolicyProvider policy_providers = 12;
+
+  // Enable :6060 pprof endpoint
+  bool enable_profiler = 13;
 }
 
 message PolicyProvider {
   string name = 1 [(buf.validate.field) = {
     cel: {
-      message: "must contain only lowercase letters, numbers, and hyphens.",
-      expression: "this.matches('^[a-z0-9]([-a-z0-9]*[a-z0-9])?$')",
-      id: "name.dns-1123",
-    },
+      message: "must contain only lowercase letters, numbers, and hyphens."
+      expression: "this.matches('^[a-z0-9]([-a-z0-9]*[a-z0-9])?$')"
+      id: "name.dns-1123"
+    }
   }];
   // default policies will be used for schema-less references eg `my-policy`. Only one provider can be the default one
   bool default = 2;

app/controlplane/internal/conf/controlplane/config/v1/conf.pb.go

@@ -0,0 +1,34 @@
+//
+// 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.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package server
+
+import (
+	"time"
+
+	"github.com/go-kratos/kratos/v2/transport/http"
+)
+
+// HTTPMetricsServer is a HTTP server that exposes the metrics endpoint
+type HTTPProfilerServer struct {
+	*http.Server
+}
+
+// NewHTTPProfilerServer exposes the metrics endpoint in another port
+func NewHTTPProfilerServer(_ *Opts) (*HTTPProfilerServer, error) {
+	httpSrv := http.NewServer(http.Address("0.0.0.0:6060"), http.Timeout(10*time.Second))
+
+	return &HTTPProfilerServer{httpSrv}, nil
+}

app/controlplane/internal/conf/controlplane/config/v1/conf.proto

@@ -24,6 +24,7 @@ var ProviderSet = wire.NewSet(
 	NewGRPCServer,
 	NewHTTPServer,
 	NewHTTPMetricsServer,
+	NewHTTPProfilerServer,
 	wire.Struct(new(Opts), "*"),
 )
 

app/controlplane/internal/server/profiler.go

@@ -7,7 +7,7 @@ description: Chainloop is an open source software supply chain control plane, a
 
 type: application
 # Bump the patch (not minor, not major) version on each change in the Chart Source code
-version: 1.131.0
+version: 1.131.1
 # Do not update appVersion, this is handled automatically by the release process
 appVersion: v0.113.0