[GEN-1738] Add service name to instrumentation config

api/config/crd/bases/odigos.io_instrumentationconfigs.yaml

@@ -416,6 +416,10 @@ spec:
                   - payloadCollection
                   type: object
                 type: array
+              serviceName:
+                description: the service.name attribute is used to identify the name
+                  of the service that is generating telemetry data
+                type: string
             type: object
           status:
             properties:

api/odigos/v1alpha1/instrumentationconfig_types.go

@@ -34,6 +34,9 @@ type InstrumentationConfigStatus struct {
 // Config for the OpenTelemeetry SDKs that should be applied to a workload.
 // The workload is identified by the owner reference
 type InstrumentationConfigSpec struct {
+
+	// the service.name attribute is used to identify the name of the service that is generating telemetry data
+	ServiceName string `json:"serviceName,omitempty"`
 	// true when the runtime details are invalidated and should be recalculated
 	RuntimeDetailsInvalidated bool `json:"runtimeDetailsInvalidated,omitempty"`
 

instrumentor/controllers/instrumentationconfig/common.go

@@ -1,14 +1,18 @@
 package instrumentationconfig
 
 import (
+	"context"
+	"fmt"
+
 	odigosv1alpha1 "github.com/odigos-io/odigos/api/odigos/v1alpha1"
 	"github.com/odigos-io/odigos/api/odigos/v1alpha1/instrumentationrules"
 	"github.com/odigos-io/odigos/common"
 	"github.com/odigos-io/odigos/instrumentor/controllers/utils"
 	"github.com/odigos-io/odigos/k8sutils/pkg/workload"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-func updateInstrumentationConfigForWorkload(ic *odigosv1alpha1.InstrumentationConfig, ia *odigosv1alpha1.InstrumentedApplication, rules *odigosv1alpha1.InstrumentationRuleList) error {
+func updateInstrumentationConfigForWorkload(ic *odigosv1alpha1.InstrumentationConfig, ia *odigosv1alpha1.InstrumentedApplication, rules *odigosv1alpha1.InstrumentationRuleList, serviceName string) error {
 
 	workloadName, workloadKind, err := workload.ExtractWorkloadInfoFromRuntimeObjectName(ia.Name)
 	if err != nil {
@@ -20,6 +24,8 @@ func updateInstrumentationConfigForWorkload(ic *odigosv1alpha1.InstrumentationCo
 		Kind:      workloadKind,
 	}
 
+	ic.Spec.ServiceName = serviceName
+
 	sdkConfigs := make([]odigosv1alpha1.SdkConfig, 0, len(ia.Spec.RuntimeDetails))
 
 	// create an empty sdk config for each detected programming language
@@ -239,3 +245,15 @@ func mergeMessagingPayloadCollectionRules(rule1 *instrumentationrules.MessagingP
 func boolPtr(b bool) *bool {
 	return &b
 }
+
+// ResolveServiceName determines the service name based on workload kind
+func resolveServiceName(ctx context.Context, k8sClient client.Client, workloadName string, namespace string, kind workload.WorkloadKind) (string, error) {
+
+	workloadResolver := workload.NewK8sK8sWorkloadResolver(k8sClient)
+	obj, err := workloadResolver.GetWorkloadObject(ctx, workloadName, kind, namespace)
+
+	if err != nil {
+		return "", fmt.Errorf("failed to get workload object to resolve reported service name annotation. will use fallback service name: %w", err)
+	}
+	return workload.ExtractServiceNameFromAnnotations(obj.GetAnnotations(), workloadName), nil
+}

instrumentor/controllers/instrumentationconfig/common_test.go

@@ -32,7 +32,7 @@ func TestUpdateInstrumentationConfigForWorkload_SingleLanguage(t *testing.T) {
 		},
 	}
 	rules := &odigosv1.InstrumentationRuleList{}
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -72,7 +72,7 @@ func TestUpdateInstrumentationConfigForWorkload_MultipleLanguages(t *testing.T)
 		},
 	}
 	rules := &odigosv1.InstrumentationRuleList{}
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -119,7 +119,7 @@ func TestUpdateInstrumentationConfigForWorkload_IgnoreUnknownLanguage(t *testing
 		},
 	}
 	rules := &odigosv1.InstrumentationRuleList{}
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -150,7 +150,7 @@ func TestUpdateInstrumentationConfigForWorkload_NoLanguages(t *testing.T) {
 		},
 	}
 	rules := &odigosv1.InstrumentationRuleList{}
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -187,7 +187,7 @@ func TestUpdateInstrumentationConfigForWorkload_SameLanguageMultipleContainers(t
 		},
 	}
 	rules := &odigosv1.InstrumentationRuleList{}
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -237,7 +237,7 @@ func TestUpdateInstrumentationConfigForWorkload_SingleMatchingRule(t *testing.T)
 			},
 		},
 	}
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -303,7 +303,7 @@ func TestUpdateInstrumentationConfigForWorkload_InWorkloadList(t *testing.T) {
 		},
 	}
 
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -360,7 +360,7 @@ func TestUpdateInstrumentationConfigForWorkload_NotInWorkloadList(t *testing.T)
 		},
 	}
 
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -412,7 +412,7 @@ func TestUpdateInstrumentationConfigForWorkload_DisabledRule(t *testing.T) {
 		},
 	}
 
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -476,7 +476,7 @@ func TestUpdateInstrumentationConfigForWorkload_MultipleDefaultRules(t *testing.
 		},
 	}
 
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -567,7 +567,7 @@ func TestUpdateInstrumentationConfigForWorkload_RuleForLibrary(t *testing.T) {
 		},
 	}
 
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}
@@ -630,7 +630,7 @@ func TestUpdateInstrumentationConfigForWorkload_LibraryRuleOtherLanguage(t *test
 		},
 	}
 
-	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules)
+	err := updateInstrumentationConfigForWorkload(&ic, &ia, rules, "service-name")
 	if err != nil {
 		t.Errorf("Expected nil error, got %v", err)
 	}

instrumentor/controllers/instrumentationconfig/instrumentationrule_controller.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	odigosv1alpha1 "github.com/odigos-io/odigos/api/odigos/v1alpha1"
+	"github.com/odigos-io/odigos/k8sutils/pkg/workload"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
@@ -33,6 +34,16 @@ func (r *InstrumentationRuleReconciler) Reconcile(ctx context.Context, req ctrl.
 	}
 
 	for _, ia := range instrumentedApplications.Items {
+		workloadName, workloadKind, err := workload.ExtractWorkloadInfoFromRuntimeObjectName(ia.Name)
+		if err != nil {
+			return ctrl.Result{}, err
+		}
+
+		serviceName, err := resolveServiceName(ctx, r.Client, workloadName, ia.Namespace, workloadKind)
+		if err != nil {
+			logger.Error(err, "error resolving service name", "workload", ia.Name)
+			continue
+		}
 		ic := &odigosv1alpha1.InstrumentationConfig{}
 		err = r.Client.Get(ctx, client.ObjectKey{Name: ia.Name, Namespace: ia.Namespace}, ic)
 		if err != nil {
@@ -44,7 +55,7 @@ func (r *InstrumentationRuleReconciler) Reconcile(ctx context.Context, req ctrl.
 			}
 		}
 
-		err := updateInstrumentationConfigForWorkload(ic, &ia, instrumentationRules)
+		err = updateInstrumentationConfigForWorkload(ic, &ia, instrumentationRules, serviceName)
 		if err != nil {
 			logger.Error(err, "error updating instrumentation config", "workload", ia.Name)
 			continue

instrumentor/controllers/instrumentationconfig/instrumentedapplication_controller.go

@@ -21,6 +21,7 @@ import (
 
 	odigosv1 "github.com/odigos-io/odigos/api/odigos/v1alpha1"
 	"github.com/odigos-io/odigos/k8sutils/pkg/utils"
+	"github.com/odigos-io/odigos/k8sutils/pkg/workload"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
@@ -45,22 +46,31 @@ func (r *InstrumentedApplicationReconciler) Reconcile(ctx context.Context, req c
 	var ic odigosv1.InstrumentationConfig
 	err = r.Client.Get(ctx, req.NamespacedName, &ic)
 	if err != nil {
-		// each InstrumentedApplication should have a corresponding InstrumentationConfig
-		// but it might rarely happen that the InstrumentationConfig is deleted before the InstrumentedApplication
 		if apierrors.IsNotFound(err) {
 			logger.V(0).Info("Ignoring InstrumentedApplication without InstrumentationConfig", "runtime object name", ia.Name)
 			return ctrl.Result{}, nil
 		}
 		return ctrl.Result{}, err
 	}
 
+	workloadName, workloadKind, err := workload.ExtractWorkloadInfoFromRuntimeObjectName(ia.Name)
+	if err != nil {
+		return ctrl.Result{}, err
+	}
+
+	serviceName, err := resolveServiceName(ctx, r.Client, workloadName, ia.Namespace, workloadKind)
+	if err != nil {
+		logger.Error(err, "Failed to resolve service name", "workload", workloadName, "kind", workloadKind)
+		return ctrl.Result{}, err
+	}
+
 	instrumentationRules := &odigosv1.InstrumentationRuleList{}
 	err = r.Client.List(ctx, instrumentationRules)
 	if client.IgnoreNotFound(err) != nil {
 		return ctrl.Result{}, err
 	}
 
-	err = updateInstrumentationConfigForWorkload(&ic, &ia, instrumentationRules)
+	err = updateInstrumentationConfigForWorkload(&ic, &ia, instrumentationRules, serviceName)
 	if err != nil {
 		return ctrl.Result{}, err
 	}

instrumentor/controllers/instrumentationconfig/manager.go

@@ -2,11 +2,49 @@ package instrumentationconfig
 
 import (
 	odigosv1alpha1 "github.com/odigos-io/odigos/api/odigos/v1alpha1"
+	"github.com/odigos-io/odigos/common/consts"
+	appsv1 "k8s.io/api/apps/v1"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/builder"
+	"sigs.k8s.io/controller-runtime/pkg/event"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 )
 
+// workloadPodTemplatePredicate handles changes to workloads like Deployment, StatefulSet, and DaemonSet
+type workloadPodTemplatePredicate struct {
+	predicate.Funcs
+}
+
+func (w workloadPodTemplatePredicate) Create(e event.CreateEvent) bool {
+	return true
+}
+
+func (w workloadPodTemplatePredicate) Update(e event.UpdateEvent) bool {
+	if e.ObjectOld == nil || e.ObjectNew == nil {
+		return false
+	}
+
+	// Compare annotations
+	oldAnnotations := e.ObjectOld.GetAnnotations()
+	newAnnotations := e.ObjectNew.GetAnnotations()
+
+	// Check if the `odigos.io/reported-name` annotation has changed
+	oldName := oldAnnotations[consts.OdigosReportedNameAnnotation]
+	newName := newAnnotations[consts.OdigosReportedNameAnnotation]
+
+	return oldName != newName
+}
+
+func (w workloadPodTemplatePredicate) Delete(e event.DeleteEvent) bool {
+	return false
+}
+
+func (w workloadPodTemplatePredicate) Generic(e event.GenericEvent) bool {
+	return false
+}
+
 func SetupWithManager(mgr ctrl.Manager) error {
+	// Watch InstrumentationRule
 	err := builder.
 		ControllerManagedBy(mgr).
 		Named("instrumentor-instrumentationconfig-instrumentationrule").
@@ -19,6 +57,7 @@ func SetupWithManager(mgr ctrl.Manager) error {
 		return err
 	}
 
+	// Watch InstrumentedApplication
 	err = builder.
 		ControllerManagedBy(mgr).
 		Named("instrumentor-instrumentationconfig-instrumentedapplication").
@@ -31,5 +70,47 @@ func SetupWithManager(mgr ctrl.Manager) error {
 		return err
 	}
 
+	// Watch for Deployment changes
+	err = builder.
+		ControllerManagedBy(mgr).
+		Named("instrumentor-instrumentationconfig-workloads-deployment").
+		For(&appsv1.Deployment{}).
+		WithEventFilter(workloadPodTemplatePredicate{}).
+		Complete(&WorkloadsReconciler{
+			Client: mgr.GetClient(),
+			Scheme: mgr.GetScheme(),
+		})
+	if err != nil {
+		return err
+	}
+
+	// Watch for StatefulSet changes
+	err = builder.
+		ControllerManagedBy(mgr).
+		Named("instrumentor-instrumentationconfig-workloads-statefulset").
+		For(&appsv1.StatefulSet{}).
+		WithEventFilter(workloadPodTemplatePredicate{}).
+		Complete(&WorkloadsReconciler{
+			Client: mgr.GetClient(),
+			Scheme: mgr.GetScheme(),
+		})
+	if err != nil {
+		return err
+	}
+
+	// Watch for DaemonSet changes
+	err = builder.
+		ControllerManagedBy(mgr).
+		Named("instrumentor-instrumentationconfig-workloads-daemonset").
+		For(&appsv1.DaemonSet{}).
+		WithEventFilter(workloadPodTemplatePredicate{}).
+		Complete(&WorkloadsReconciler{
+			Client: mgr.GetClient(),
+			Scheme: mgr.GetScheme(),
+		})
+	if err != nil {
+		return err
+	}
+
 	return nil
 }