Mark the instrumentation labels as deprecated (#2358)

Co-authored-by: Amir Blum <[email protected]>
odigos-io · Feb 2, 2025 · 1707716 · 1707716
1 parent 9098447
commit 1707716
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/common/consts/consts.go b/common/consts/consts.go
@@ -15,9 +15,15 @@ const (
 	OTLPPort                    = 4317
 	OTLPHttpPort                = 4318
 	PprofOdigosPort             = 6060
-	OdigosInstrumentationLabel  = "odigos-instrumentation"
-	InstrumentationEnabled      = "enabled"
-	InstrumentationDisabled     = "disabled"
+
+	// Deprecated: Sources are used to mark workloads for instrumentation.
+	OdigosInstrumentationLabel = "odigos-instrumentation"
+
+	// Deprecated: Sources are used to mark workloads for instrumentation.
+	InstrumentationEnabled = "enabled"
+
+	// Deprecated: Sources are used to mark workloads for instrumentation.
+	InstrumentationDisabled = "disabled"
 
 	// Deprecated: reported name is set via the Source CR.
 	OdigosReportedNameAnnotation = "odigos.io/reported-name"

diff --git a/k8sutils/pkg/describe/source/analyze.go b/k8sutils/pkg/describe/source/analyze.go
@@ -87,6 +87,7 @@ type SourceAnalyze struct {
 	Pods            []PodAnalyze `json:"pods"`
 }
 
+// Deprecated: Sources are used to mark workloads for instrumentation.
 func analyzeInstrumentationLabels(resource *OdigosSourceResources, workloadObj *K8sSourceObject) (InstrumentationLabelsAnalyze, bool) {
 	workloadLabel, workloadFound := workloadObj.GetLabels()[consts.OdigosInstrumentationLabel]
 	nsLabel, nsFound := resource.Namespace.GetLabels()[consts.OdigosInstrumentationLabel]

diff --git a/k8sutils/pkg/workload/workload.go b/k8sutils/pkg/workload/workload.go
@@ -60,6 +60,7 @@ func ObjectToWorkload(obj client.Object) (Workload, error) {
 	}
 }
 
+// Deprecated: this should only be used for backward compatibility migration.
 func IsObjectLabeledForInstrumentation(obj client.Object) bool {
 	labels := obj.GetLabels()
 	if labels == nil {
@@ -74,6 +75,7 @@ func IsObjectLabeledForInstrumentation(obj client.Object) bool {
 	return val == consts.InstrumentationEnabled
 }
 
+// Deprecated: this should only be used for backward compatibility migration.
 func IsWorkloadInstrumentationEffectiveEnabled(ctx context.Context, kubeClient client.Client, obj client.Object) (bool, error) {
 	// if the object itself is labeled, we will use that value
 	workloadLabels := obj.GetLabels()
@@ -98,6 +100,7 @@ func IsWorkloadInstrumentationEffectiveEnabled(ctx context.Context, kubeClient c
 	return IsObjectLabeledForInstrumentation(&ns), nil
 }
 
+// Deprecated: this should only be used for backward compatibility migration.
 func IsInstrumentationDisabledExplicitly(obj client.Object) bool {
 	labels := obj.GetLabels()
 	if labels != nil {