Add APM support with SGM appender and enhance deployment label handling

Author: chenzhiguo

main.go

@@ -15,6 +15,7 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/jd-opensource/joylive-injector/pkg/admission"
+	_ "github.com/jd-opensource/joylive-injector/pkg/apm"
 	_ "github.com/jd-opensource/joylive-injector/pkg/mutation"
 	_ "github.com/jd-opensource/joylive-injector/pkg/watcher"
 

pkg/apm/sgm.go

@@ -0,0 +1,44 @@
+package apm
+
+import (
+	"context"
+	"github.com/jd-opensource/joylive-injector/pkg/config"
+	"k8s.io/api/apps/v1"
+)
+
+type SgmAppender struct {
+}
+
+// SgmAppender implements the Appender interface
+var _ Appender = &SgmAppender{}
+
+// init registers the SgmAppender with the Appender factory
+func init() {
+	RegisterAppenderType("sgm", &SgmAppender{})
+}
+
+// Modify modifies the Deployment object by adding specific labels to its template
+func (s *SgmAppender) Modify(ctx context.Context, target *v1.Deployment) (bool, error) {
+	added := false
+	if _, ok := target.Spec.Template.Labels["sgm.jd.com/app"]; !ok {
+		target.Spec.Template.Labels["sgm.jd.com/app"] = target.Labels[config.ApplicationLabel]
+		added = true
+	}
+	if _, ok := target.Spec.Template.Labels["sgm.jd.com/group"]; !ok {
+		target.Spec.Template.Labels["sgm.jd.com/group"] = target.Labels[config.ServiceGroupLabel]
+		added = true
+	}
+	if _, ok := target.Spec.Template.Labels["sgm.jd.com/probe-inject"]; !ok {
+		target.Spec.Template.Labels["sgm.jd.com/probe-inject"] = "true"
+		added = true
+	}
+	if _, ok := target.Spec.Template.Labels["sgm.jd.com/sink"]; !ok {
+		target.Spec.Template.Labels["sgm.jd.com/sink"] = "Http"
+		added = true
+	}
+	if _, ok := target.Spec.Template.Labels["sgm.jd.com/tenant"]; !ok {
+		target.Spec.Template.Labels["sgm.jd.com/tenant"] = target.Labels["sgm.jd.com/tenant"]
+		added = true
+	}
+	return added, nil
+}

pkg/apm/types.go

@@ -0,0 +1,25 @@
+package apm
+
+import (
+	"context"
+	v1 "k8s.io/api/apps/v1"
+	"sync"
+)
+
+type Appender interface {
+	Modify(ctx context.Context, target *v1.Deployment) (bool, error)
+}
+
+// AppenderTypes is a factory holder for any AppenderType
+var AppenderTypes = make(map[string]Appender)
+
+var mux sync.Mutex
+
+// RegisterAppenderType Inject the Appender factory to automatically generate Appender objects.
+func RegisterAppenderType(key string, appender Appender) {
+	mux.Lock()
+	defer mux.Unlock()
+	if _, ok := AppenderTypes[key]; !ok {
+		AppenderTypes[key] = appender
+	}
+}

pkg/config/config.go

@@ -29,6 +29,11 @@ const (
 	ServiceSpaceLabel      = "jmsf.jd.com/space"
 	JdapServiceSpaceLabel  = "jmsf.jd.com/service-space"
 	ApplicationLabel       = "jmsf.jd.com/app"
+	EnhanceTypeLabel       = "jmsf.jd.com/enhance"
+	EnhanceTypeAgent       = "agent"
+	EnhanceTypeSidecar     = "sidecar"
+	SidecarEnhanceLabel    = "sidecar.istio.io/inject"
+	ApmTypeLabel           = "jmsf.jd.com/apm"
 	JdapApplicationLabel   = "app.jdap.io/name"
 	WebHookMatchKeyEnv     = "JOYLIVE_MATCH_KEY"
 	WebHookMatchValueEnv   = "JOYLIVE_MATCH_VALUE"

pkg/mutation/mutation_deploy.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"github.com/jd-opensource/joylive-injector/pkg/admission"
+	"github.com/jd-opensource/joylive-injector/pkg/apm"
 	"github.com/jd-opensource/joylive-injector/pkg/config"
 	"github.com/jd-opensource/joylive-injector/pkg/log"
 	"github.com/jd-opensource/joylive-injector/pkg/resource"
@@ -85,11 +86,38 @@ func injectionDeploy(request *admissionv1.AdmissionRequest) (*admissionv1.Admiss
 
 		target := deploy.DeepCopy()
 		added := false
-		// Check if the x-live-enabled label exists in deploy's spec.template.metadata.labels; if not, add it.
-		if _, ok := deploy.Spec.Template.Labels[config.WebHookMatchKey]; !ok {
-			log.Infof("[mutation] /injection-deploy: add label %s to deployment %s/%s", config.WebHookMatchKey, deploy.Name, deploy.Namespace)
-			target.Spec.Template.Labels[config.WebHookMatchKey] = config.WebHookMatchValue
+
+		if enhanceType, ok := deploy.Labels[config.EnhanceTypeLabel]; ok && enhanceType == config.EnhanceTypeSidecar {
+			log.Infof("[mutation] /injection-deploy: add label %s to deployment %s/%s", config.SidecarEnhanceLabel, deploy.Name, deploy.Namespace)
+			target.Spec.Template.Labels[config.SidecarEnhanceLabel] = "true"
 			added = true
+		} else {
+			// Check if the x-live-enabled label exists in deploy's spec.template.metadata.labels; if not, add it.
+			if _, ok := deploy.Spec.Template.Labels[config.WebHookMatchKey]; !ok {
+				log.Infof("[mutation] /injection-deploy: add label %s to deployment %s/%s", config.WebHookMatchKey, deploy.Name, deploy.Namespace)
+				target.Spec.Template.Labels[config.WebHookMatchKey] = config.WebHookMatchValue
+				added = true
+			}
+		}
+
+		// Apm labels append
+		if apmType, ok := deploy.Labels[config.ApmTypeLabel]; ok {
+			if appender, ok := apm.AppenderTypes[apmType]; ok {
+				added, err = appender.Modify(context.Background(), target)
+				if err != nil {
+					errMsg := fmt.Sprintf("[mutation] /injection-deploy: failed to modify deployment: %v", err)
+					log.Error(errMsg)
+					return &admissionv1.AdmissionResponse{
+						Allowed: false,
+						Result: &metav1.Status{
+							Code:    http.StatusInternalServerError,
+							Message: errMsg,
+						},
+					}, nil
+				}
+			} else {
+				log.Warnf("[mutation] /injection-deploy: unknown apm type %s", apmType)
+			}
 		}
 
 		if len(config.ControlPlaneUrl) == 0 {