feat(api): add /debug/ endpoints

Author: fiftin

api-docs.yml

@@ -1124,6 +1124,22 @@ parameters:
     x-example: 13
 
 paths:
+  /debug/gc:
+    post:
+      summary: Garbage collector
+      description: Run the garbage collector
+      responses:
+        204:
+          description: Successful "OK" reply
+
+  /debug/pprof/dump:
+    post:
+      summary: Dump pprof
+      description: Dump pprof
+      responses:
+        204:
+          description: Successful "OK" reply
+
   /ping:
     get:
       summary: PING test

api/debug/gc.go

@@ -0,0 +1,11 @@
+package debug
+
+import (
+	"net/http"
+	"runtime"
+)
+
+func GC(w http.ResponseWriter, r *http.Request) {
+	runtime.GC()
+	w.WriteHeader(http.StatusNoContent)
+}

api/debug/pprof.go

@@ -0,0 +1,39 @@
+package debug
+
+import (
+	"github.com/semaphoreui/semaphore/util"
+	log "github.com/sirupsen/logrus"
+	"net/http"
+	"os"
+	"path"
+	"runtime/pprof"
+	"strconv"
+	"time"
+)
+
+func Dump(w http.ResponseWriter, r *http.Request) {
+
+	f, err := os.Create(path.Join(util.Config.Profiling.DumpsDir, "mem-"+strconv.Itoa(int(time.Now().Unix()))+".prof"))
+
+	defer f.Close()
+
+	if err != nil {
+		log.WithError(err).WithFields(log.Fields{
+			"context": "pprof",
+		}).Error("error creating mem.prof")
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	err = pprof.WriteHeapProfile(f)
+
+	if err != nil {
+		log.WithError(err).WithFields(log.Fields{
+			"context": "pprof",
+		}).Error("Failed to write memory profile")
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	w.WriteHeader(http.StatusNoContent)
+}

api/router.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"embed"
 	"fmt"
+	"github.com/semaphoreui/semaphore/api/debug"
 	"github.com/semaphoreui/semaphore/pkg/tz"
 	"net/http"
 	"os"
@@ -147,6 +148,10 @@ func Route() *mux.Router {
 
 	adminAPI.Path("/cache").HandlerFunc(clearCache).Methods("DELETE", "HEAD")
 
+	debugAPI := adminAPI.PathPrefix("/debug").Subrouter()
+	debugAPI.Path("/gc").HandlerFunc(debug.GC).Methods("POST")
+	debugAPI.Path("/pprof/dump").HandlerFunc(debug.Dump).Methods("POST")
+
 	globalRunnersAPI := adminAPI.PathPrefix("/runners").Subrouter()
 	globalRunnersAPI.Use(globalRunnerMiddleware)
 	globalRunnersAPI.Path("/{runner_id}").HandlerFunc(getGlobalRunner).Methods("GET", "HEAD")

cli/cmd/root.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/semaphoreui/semaphore/services/profiling"
 	"net/http"
 	"net/url"
 	"os"
@@ -84,7 +83,6 @@ func runService() {
 	go sockets.StartWS()
 	go schedulePool.Run()
 	go taskPool.Run()
-	go profiling.StartProfiling()
 
 	route := api.Route()
 

openapi.yml

@@ -23,6 +23,22 @@ tags:
   - name: integration
     description: Integration API
 paths:
+  /debug/gc:
+    post:
+      summary: Garbage collector
+      description: Run the garbage collector
+      responses:
+        '204':
+          description: Successful "OK" reply
+
+  /debug/pprof/dump:
+    post:
+      summary: Dump pprof
+      description: Dump pprof
+      responses:
+        '204':
+          description: Successful "OK" reply
+
   "/ping":
     get:
       summary: PING test

services/profiling/pprof.go

@@ -208,8 +208,8 @@ type ScheduleConfig struct {
 }
 
 type ProfilingConfig struct {
-	Enabled bool `json:"enabled,omitempty" env:"SEMAPHORE_PROFILING_ENABLED"`
-	Port    int  `json:"port,omitempty" env:"SEMAPHORE_PROFILING_PORT" default:"6060"`
+	Enabled  bool   `json:"enabled,omitempty" env:"SEMAPHORE_PROFILING_ENABLED"`
+	DumpsDir string `json:"dumps_dir,omitempty" env:"SEMAPHORE_PROFILING_DUMPS_DIR" default:"/tmp/semaphore/profiler"`
 }
 
 // ConfigType mapping between Config and the json file that sets it