feat: Add resource info to push metrics (#471)

screwdriver-cd · Feb 2, 2024 · f2e9ffa · f2e9ffa
1 parent 5f9a448
commit f2e9ffa
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 3 deletions.
diff --git a/launch.go b/launch.go
@@ -127,6 +127,8 @@ func pushMetrics(status string, buildID int) error {
 		jobName := os.Getenv("SD_JOB_NAME")
 		scmURL := os.Getenv("SCM_URL")
 		sdBuildPrefix := os.Getenv("SD_BUILD_PREFIX")
+		cpu := os.Getenv("CONTAINER_CPU_LIMIT")
+		ram := os.Getenv("CONTAINER_MEMORY_LIMIT")
 		launcherStartTS, _ := strconv.ParseInt(os.Getenv("SD_LAUNCHER_START_TS"), 10, 64)
 		buildStartTS, _ := strconv.ParseInt(os.Getenv("SD_BUILD_START_TS"), 10, 64)
 		// build run end timestamp
@@ -148,7 +150,7 @@ func pushMetrics(status string, buildID int) error {
 
 		// data need to be specified in this format for pushgateway
 		data := `sd_build_status{image_name="` + image + `",pipeline_id="` + pipelineId + `",node="` + node + `",job_id="` + jobId + `",job_name="` + jobName + `",scm_url="` + scmURL + `",status="` + status + `",prefix="` + sdBuildPrefix + `"} 1
-sd_build_run_time_secs{image_name="` + image + `",pipeline_id="` + pipelineId + `",node="` + node + `",job_id="` + jobId + `",job_name="` + jobName + `",scm_url="` + scmURL + `",status="` + status + `",prefix="` + sdBuildPrefix + `"} ` + strconv.FormatInt(buildRunTimeSecs, 10) + `
+sd_build_run_time_secs{image_name="` + image + `",pipeline_id="` + pipelineId + `",node="` + node + `",job_id="` + jobId + `",job_name="` + jobName + `",scm_url="` + scmURL + `",status="` + status + `",prefix="` + sdBuildPrefix + `",cpu="` + cpu + `",ram="` + ram + `"} ` + strconv.FormatInt(buildRunTimeSecs, 10) + `
 sd_build_time_secs{image_name="` + image + `",pipeline_id="` + pipelineId + `",node="` + node + `",job_id="` + jobId + `",job_name="` + jobName + `",scm_url="` + scmURL + `",status="` + status + `",prefix="` + sdBuildPrefix + `"} ` + strconv.FormatInt(buildTimeSecs, 10) + `
 sd_build_queued_time_secs{image_name="` + image + `",pipeline_id="` + pipelineId + `",node="` + node + `",job_id="` + jobId + `",job_name="` + jobName + `",scm_url="` + scmURL + `",status="` + status + `",prefix="` + sdBuildPrefix + `"} ` + strconv.FormatInt(buildQueuedTimeSecs, 10) + `
 sd_build_setup_time_secs{image_name="` + image + `",pipeline_id="` + pipelineId + `",node="` + node + `",job_id="` + jobId + `",job_name="` + jobName + `",scm_url="` + scmURL + `",status="` + status + `",prefix="` + sdBuildPrefix + `"} ` + strconv.FormatInt(buildSetupTimeSecs, 10) + `

diff --git a/launch_test.go b/launch_test.go
@@ -12,6 +12,7 @@ import (
 	"os/signal"
 	"path"
 	"reflect"
+	"regexp"
 	"strconv"
 	"strings"
 	"syscall"
@@ -2633,8 +2634,21 @@ func TestMetaWhenStartFromAnyJobWithParentEvent(t *testing.T) {
 	}
 }
 
-func fakeHttpClient() *http.Client {
+type RequestCapture struct {
+	Method string
+	URL    *url.URL
+	Header http.Header
+	Body   string
+}
+
+func fakeHttpClient(capture *RequestCapture) *http.Client {
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		capture.Method = r.Method
+		capture.URL = r.URL
+		capture.Header = r.Header
+		bodyBytes, _ := ioutil.ReadAll(r.Body)
+		capture.Body = string(bodyBytes)
+
 		data := strings.Split(r.URL.String(), "&")
 		code, _ := strconv.Atoi(data[1])
 		body := data[1]
@@ -2690,10 +2704,20 @@ func TestMakePushgatewayURL(t *testing.T) {
 }
 
 func TestPushMetrics(t *testing.T) {
-	httpTest := fakeHttpClient()
+	var capture RequestCapture
+	httpTest := fakeHttpClient(&capture)
 	client.HTTPClient = httpTest
 	ts := time.Now().Unix() - 2000
+
 	os.Setenv("CONTAINER_IMAGE", "dummy_image")
+	os.Setenv("SD_PIPELINE_ID", "1")
+	os.Setenv("NODE_ID", "node1")
+	os.Setenv("SD_JOB_ID", "123")
+	os.Setenv("SD_JOB_NAME", "dummy_job")
+	os.Setenv("SCM_URL", "http://fake.scm")
+	os.Setenv("SD_BUILD_PREFIX", "dummy_prefix")
+	os.Setenv("CONTAINER_CPU_LIMIT", "1")
+	os.Setenv("CONTAINER_MEMORY_LIMIT", "2147483648")
 
 	// SD_PUSHGATEWAY_URL null
 	os.Setenv("SD_PUSHGATEWAY_URL", "")
@@ -2724,10 +2748,18 @@ func TestPushMetrics(t *testing.T) {
 	// 200 success
 	os.Setenv("SD_PUSHGATEWAY_URL", "http://fake.pushgateway.url&200&0")
 	os.Setenv("SD_LAUNCHER_END_TS", strconv.FormatInt(ts, 10))
+	wantPattern := `sd_build_status{image_name="dummy_image",pipeline_id="1",node="node1",job_id="123",job_name="dummy_job",scm_url="http://fake.scm",status="success",prefix="dummy_prefix"} 1
+sd_build_run_time_secs{image_name="dummy_image",pipeline_id="1",node="node1",job_id="123",job_name="dummy_job",scm_url="http://fake.scm",status="success",prefix="dummy_prefix",cpu="1",ram="2147483648"} \d+
+sd_build_time_secs{image_name="dummy_image",pipeline_id="1",node="node1",job_id="123",job_name="dummy_job",scm_url="http://fake.scm",status="success",prefix="dummy_prefix"} \d+
+sd_build_queued_time_secs{image_name="dummy_image",pipeline_id="1",node="node1",job_id="123",job_name="dummy_job",scm_url="http://fake.scm",status="success",prefix="dummy_prefix"} 0
+sd_build_setup_time_secs{image_name="dummy_image",pipeline_id="1",node="node1",job_id="123",job_name="dummy_job",scm_url="http://fake.scm",status="success",prefix="dummy_prefix"} 0
+`
+	re, err := regexp.Compile(wantPattern)
 	err = pushMetrics("success", 1)
 	if err != nil {
 		t.Errorf("Push metrics expect to return [nil] but got [%v]", err)
 	}
+	assert.True(t, re.MatchString(capture.Body))
 
 	// 200 success, launcher end timestamp null / blank
 	os.Setenv("SD_PUSHGATEWAY_URL", "http://fake.pushgateway.url&200&0")