Add support for metrics in containers and jobs (#830) (#1758)

Signed-off-by: Grant Linville <[email protected]>

Author: g-linville

go.mod

@@ -12,7 +12,7 @@ replace (
 require (
 	cuelang.org/go v0.5.0
 	github.com/AlecAivazis/survey/v2 v2.3.6
-	github.com/acorn-io/aml v0.0.0-20230612000521-a812941e7fab
+	github.com/acorn-io/aml v0.0.0-20230619192500-1f56a8955db2
 	github.com/acorn-io/baaah v0.0.0-20230617011755-3291c17915f5
 	github.com/acorn-io/mink v0.0.0-20230523184405-ceaaa366d500
 	github.com/acorn-io/namegenerator v0.0.0-20220915160418-9e3d5a0ffe78

go.sum

@@ -93,8 +93,8 @@ github.com/ThalesIgnite/crypto11 v1.2.5 h1:1IiIIEqYmBvUYFeMnHqRft4bwf/O36jryEUpY
 github.com/ThalesIgnite/crypto11 v1.2.5/go.mod h1:ILDKtnCKiQ7zRoNxcp36Y1ZR8LBPmR2E23+wTQe/MlE=
 github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d h1:licZJFw2RwpHMqeKTCYkitsPqHNxTmd4SNR5r94FGM8=
 github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d/go.mod h1:asat636LX7Bqt5lYEZ27JNDcqxfjdBQuJ/MM4CN/Lzo=
-github.com/acorn-io/aml v0.0.0-20230612000521-a812941e7fab h1:ZJQSAT306ILs8ZDGBMuPJeQN8OCP4bPLhTBw/vHLY+s=
-github.com/acorn-io/aml v0.0.0-20230612000521-a812941e7fab/go.mod h1:UEx5RRLFjryCEHN2pM59+d8A0mPJ3VAxggJOTzPymwg=
+github.com/acorn-io/aml v0.0.0-20230619192500-1f56a8955db2 h1:tWz51cHGC6GURkKqA4PdG3ObHz2YBrVzCfxXacNUqVY=
+github.com/acorn-io/aml v0.0.0-20230619192500-1f56a8955db2/go.mod h1:UEx5RRLFjryCEHN2pM59+d8A0mPJ3VAxggJOTzPymwg=
 github.com/acorn-io/baaah v0.0.0-20230617011755-3291c17915f5 h1:NdDW2tFRDHElXpcFeqTDKg6wB0uRLzJ5Kq0YDgYl/Dg=
 github.com/acorn-io/baaah v0.0.0-20230617011755-3291c17915f5/go.mod h1:LtwaWrYK/VuGptWxeD5Sgl0sgJV1ksicpTzyLilow1U=
 github.com/acorn-io/mink v0.0.0-20230523184405-ceaaa366d500 h1:tiM36bM+iMWuW9HM+YlM1GfNDXC7f565z8Be5epO0qM=

pkg/apis/api.acorn.io/v1/zz_generated.deepcopy.go

@@ -365,6 +365,9 @@ type Container struct {
 	ComputeClass *string                `json:"class,omitempty"`
 	Memory       *int64                 `json:"memory,omitempty"`
 
+	// Metrics is available on containers and jobs, but not sidecars
+	Metrics MetricsDef `json:"metrics,omitempty"`
+
 	// Scale is only available on containers, not sidecars or jobs
 	Scale *int32 `json:"scale,omitempty"`
 
@@ -461,6 +464,11 @@ type MemoryMap map[string]*int64
 // Workload to its class
 type ComputeClassMap map[string]string
 
+type MetricsDef struct {
+	Port int32  `json:"port,omitempty"`
+	Path string `json:"path,omitempty"`
+}
+
 type GeneratedService struct {
 	Job string `json:"job,omitempty"`
 }

pkg/apis/internal.acorn.io/v1/appspec.go

@@ -40,6 +40,7 @@ CONTAINERS:
             },
             "spec": {
                 "probes": null,
+                "metrics": {},
                 "appName": "found"
             },
             "status": {

pkg/apis/internal.acorn.io/v1/zz_generated.deepcopy.go

@@ -27,6 +27,7 @@ items:
     name: found.container
   spec:
     appName: found
+    metrics: {}
     probes: null
   status:
     columns: {}

pkg/cli/testdata/all/all_test_json.txt

@@ -10,5 +10,6 @@
 		]
 		probes: null
 		permissions: {}
+		metrics: {}
 	}
 }

pkg/cli/testdata/all/all_test_yaml.txt

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"net/url"
 	"path"
+	"strconv"
 	"strings"
 
 	v1 "github.com/acorn-io/acorn/pkg/apis/internal.acorn.io/v1"
@@ -476,6 +477,8 @@ func podAnnotations(appInstance *v1.AppInstance, container v1.Container) map[str
 	annotations := map[string]string{
 		labels.AcornContainerSpec: containerAnnotation(container),
 	}
+	addPrometheusAnnotations(annotations, container)
+
 	images := map[string]string{}
 	addImageAnnotations(images, appInstance, container)
 
@@ -503,6 +506,14 @@ func addImageAnnotations(annotations map[string]string, appInstance *v1.AppInsta
 	}
 }
 
+func addPrometheusAnnotations(annotations map[string]string, container v1.Container) {
+	if container.Metrics.Path != "" && container.Metrics.Port != 0 {
+		annotations[labels.PrometheusScrape] = "true"
+		annotations[labels.PrometheusPath] = container.Metrics.Path
+		annotations[labels.PrometheusPort] = strconv.Itoa(int(container.Metrics.Port))
+	}
+}
+
 func isStateful(appInstance *v1.AppInstance, container v1.Container) bool {
 	for _, dir := range container.Dirs {
 		if dir.Secret.Name != "" {

pkg/cli/testdata/render/render_test.txt

@@ -68,6 +68,10 @@ func TestDeploySpecStop(t *testing.T) {
 	tester.DefaultTest(t, scheme.Scheme, "testdata/deployspec/stop", DeploySpec)
 }
 
+func TestDeploySpecMetrics(t *testing.T) {
+	tester.DefaultTest(t, scheme.Scheme, "testdata/deployspec/metrics", DeploySpec)
+}
+
 func TestProbe(t *testing.T) {
 	tester.DefaultTest(t, scheme.Scheme, "testdata/probes", DeploySpec)
 }