Bump .NET OTel AutoInstrumentation to 0.3.0-beta.1 (#1056)

Special support for instrumentation list is not needed.
By default all instrumentations are enabled.

Author: Kielek

README.md

@@ -226,9 +226,6 @@ The possible values for the annotation can be
 * `"my-other-namespace/my-instrumentation"` - name and namespace of `Instrumentation` CR instance in another namespace.
 * `"false"` - do not inject
 
-
->**Note:** For `DotNet` auto-instrumentation, by default, operator sets the `OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS` environment variable which specifies the list of traces source instrumentations you want to enable. The value that is set by default by the operator is all available instrumentations supported by the `openTelemery-dotnet-instrumentation` release consumed in the image, i.e. `AspNet,HttpClient,SqlClient`. This value can be overriden by configuring the environment variable explicitely.
-
 #### Multi-container pods
 
 If nothing else is specified, instrumentation is performed on the first container available in the pod spec.

apis/v1alpha1/instrumentation_webhook.go

@@ -27,14 +27,12 @@ import (
 )
 
 const (
-	AnnotationDefaultAutoInstrumentationJava       = "instrumentation.opentelemetry.io/default-auto-instrumentation-java-image"
-	AnnotationDefaultAutoInstrumentationNodeJS     = "instrumentation.opentelemetry.io/default-auto-instrumentation-nodejs-image"
-	AnnotationDefaultAutoInstrumentationPython     = "instrumentation.opentelemetry.io/default-auto-instrumentation-python-image"
-	AnnotationDefaultAutoInstrumentationDotNet     = "instrumentation.opentelemetry.io/default-auto-instrumentation-dotnet-image"
-	envPrefix                                      = "OTEL_"
-	envSplunkPrefix                                = "SPLUNK_"
-	envOtelDotnetAutoTracesEnabledInstrumentations = "OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS"
-	defaultEnabledTracesInstrumentations           = "AspNet,HttpClient,SqlClient"
+	AnnotationDefaultAutoInstrumentationJava   = "instrumentation.opentelemetry.io/default-auto-instrumentation-java-image"
+	AnnotationDefaultAutoInstrumentationNodeJS = "instrumentation.opentelemetry.io/default-auto-instrumentation-nodejs-image"
+	AnnotationDefaultAutoInstrumentationPython = "instrumentation.opentelemetry.io/default-auto-instrumentation-python-image"
+	AnnotationDefaultAutoInstrumentationDotNet = "instrumentation.opentelemetry.io/default-auto-instrumentation-dotnet-image"
+	envPrefix                                  = "OTEL_"
+	envSplunkPrefix                            = "SPLUNK_"
 )
 
 // log is for logging in this package.
@@ -80,13 +78,6 @@ func (r *Instrumentation) Default() {
 			r.Spec.DotNet.Image = val
 		}
 	}
-	// by default set all the available instrumentations for dotnet unless the env is already set
-	if !r.isEnvVarSet(envOtelDotnetAutoTracesEnabledInstrumentations) {
-		r.Spec.DotNet.Env = append(r.Spec.DotNet.Env, corev1.EnvVar{
-			Name:  envOtelDotnetAutoTracesEnabledInstrumentations,
-			Value: defaultEnabledTracesInstrumentations,
-		})
-	}
 }
 
 // +kubebuilder:webhook:verbs=create;update,path=/validate-opentelemetry-io-v1alpha1-instrumentation,mutating=false,failurePolicy=fail,groups=opentelemetry.io,resources=instrumentations,versions=v1alpha1,name=vinstrumentationcreateupdate.kb.io,sideEffects=none,admissionReviewVersions=v1
@@ -155,12 +146,3 @@ func (in *Instrumentation) validateEnv(envs []corev1.EnvVar) error {
 	}
 	return nil
 }
-
-func (in *Instrumentation) isEnvVarSet(name string) bool {
-	for _, env := range in.Spec.DotNet.Env {
-		if env.Name == name {
-			return true
-		}
-	}
-	return false
-}

apis/v1alpha1/instrumentation_webhook_test.go

@@ -18,7 +18,6 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
-	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -38,37 +37,6 @@ func TestInstrumentationDefaultingWebhook(t *testing.T) {
 	assert.Equal(t, "nodejs-img:1", inst.Spec.NodeJS.Image)
 	assert.Equal(t, "python-img:1", inst.Spec.Python.Image)
 	assert.Equal(t, "dotnet-img:1", inst.Spec.DotNet.Image)
-	assert.Equal(t, true, inst.isEnvVarSet(envOtelDotnetAutoTracesEnabledInstrumentations))
-}
-
-func TestInstrumentationDefaultingWebhookOtelDotNetTracesEnabledInstruEnvSet(t *testing.T) {
-	inst := &Instrumentation{
-		ObjectMeta: metav1.ObjectMeta{
-			Annotations: map[string]string{
-				AnnotationDefaultAutoInstrumentationJava:   "java-img:1",
-				AnnotationDefaultAutoInstrumentationNodeJS: "nodejs-img:1",
-				AnnotationDefaultAutoInstrumentationPython: "python-img:1",
-				AnnotationDefaultAutoInstrumentationDotNet: "dotnet-img:1",
-			},
-		},
-		Spec: InstrumentationSpec{
-			DotNet: DotNet{
-				Env: []v1.EnvVar{
-					{
-						Name:  envOtelDotnetAutoTracesEnabledInstrumentations,
-						Value: "AspNet,HttpClient",
-					},
-				},
-			},
-		},
-	}
-	inst.Default()
-	for _, env := range inst.Spec.DotNet.Env {
-		if env.Name == envOtelDotnetAutoTracesEnabledInstrumentations {
-			assert.Equal(t, "AspNet,HttpClient", env.Value)
-			break
-		}
-	}
 }
 
 func TestInstrumentationValidatingWebhook(t *testing.T) {

pkg/instrumentation/dotnet_test.go

@@ -34,7 +34,7 @@ func TestInjectDotNetSDK(t *testing.T) {
 	}{
 		{
 			name:   "DOTNET_STARTUP_HOOKS, DOTNET_SHARED_STORE, DOTNET_ADDITIONAL_DEPS not defined",
-			DotNet: v1alpha1.DotNet{Image: "foo/bar:1", Env: []corev1.EnvVar{{Name: "OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS", Value: "AspNet,HttpClient,SqlClient"}}},
+			DotNet: v1alpha1.DotNet{Image: "foo/bar:1", Env: []corev1.EnvVar{}},
 			pod: corev1.Pod{
 				Spec: corev1.PodSpec{
 					Containers: []corev1.Container{
@@ -72,10 +72,6 @@ func TestInjectDotNetSDK(t *testing.T) {
 								},
 							},
 							Env: []corev1.EnvVar{
-								{
-									Name:  "OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS",
-									Value: "AspNet,HttpClient,SqlClient",
-								},
 								{
 									Name:  envDotNetStartupHook,
 									Value: dotNetStartupHookPath,

tests/e2e/instrumentation-dotnet-multicontainer/01-assert.yaml

@@ -13,8 +13,6 @@ spec:
     env:
     - name: OTEL_LOG_LEVEL
       value: "debug"
-    - name: OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS
-      value: AspNet,HttpClient,SqlClient
     - name: DOTNET_STARTUP_HOOKS
       value: "/otel-auto-instrumentation/netcoreapp3.1/OpenTelemetry.AutoInstrumentation.StartupHook.dll"
     - name: DOTNET_ADDITIONAL_DEPS
@@ -48,8 +46,6 @@ spec:
     env:
     - name: OTEL_LOG_LEVEL
       value: "debug"
-    - name: OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS
-      value: AspNet,HttpClient,SqlClient
     - name: DOTNET_STARTUP_HOOKS
       value: "/otel-auto-instrumentation/netcoreapp3.1/OpenTelemetry.AutoInstrumentation.StartupHook.dll"
     - name: DOTNET_ADDITIONAL_DEPS

tests/e2e/instrumentation-dotnet-multicontainer/02-assert.yaml

@@ -16,8 +16,6 @@ spec:
     env:
     - name: OTEL_LOG_LEVEL
       value: "debug"
-    - name: OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS
-      value: AspNet,HttpClient,SqlClient
     - name: DOTNET_STARTUP_HOOKS
       value: "/otel-auto-instrumentation/netcoreapp3.1/OpenTelemetry.AutoInstrumentation.StartupHook.dll"
     - name: DOTNET_ADDITIONAL_DEPS

tests/e2e/instrumentation-dotnet/00-install-instrumentation.yaml

@@ -24,7 +24,3 @@ spec:
   sampler:
     type: parentbased_traceidratio
     argument: "0.25"
-  dotnet:
-    env:
-    - name: OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS
-      value: AspNet,HttpClient

tests/e2e/instrumentation-dotnet/01-assert.yaml

@@ -10,8 +10,6 @@ spec:
   containers:
   - name: myapp
     env:
-    - name: OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS
-      value: AspNet,HttpClient
     - name: DOTNET_STARTUP_HOOKS
       value: "/otel-auto-instrumentation/netcoreapp3.1/OpenTelemetry.AutoInstrumentation.StartupHook.dll"
     - name: DOTNET_ADDITIONAL_DEPS

versions.txt

@@ -24,4 +24,4 @@ autoinstrumentation-python=0.32b0
 
 # Represents the current release of DotNet instrumentation.
 # Should match autoinstrumentation/dotnet/version.txt
-autoinstrumentation-dotnet=0.2.0-beta.1
+autoinstrumentation-dotnet=0.3.0-beta.1