Otel Operator release 0.43.0

CHANGELOG.md

@@ -1,6 +1,14 @@
 Changes by Version
 ==================
 
+0.43.0
+-------------------
+* Bumped OpenTelemetry Collector to v0.43.0
+* Fix collector config update ([#670] (https://github.com/open-telemetry/opentelemetry-operator/pull/670), [@mcariapas](https://github.com/mcariapas))
+* Remove deprecate flags --metrics-level and --metrics-addr (#4695)
+  - Usages of `--metrics-level={VALUE}` can be replaced by `--set=service.telemetry.metrics.level={VALUE}`;
+  - Usages of `--metrics-addr={VALUE}` can be replaced by `--set=service.telemetry.metrics.address={VALUE}`;
+
 0.42.0
 -------------------
 * Bumped OpenTelemetry Collector to v0.42.0

README.md

@@ -240,6 +240,7 @@ The OpenTelemetry Operator *might* work on versions outside of the given range,
 
 | OpenTelemetry Operator | Kubernetes           | Cert-Manager         |
 |------------------------|----------------------|----------------------|
+| v0.43.0                | v1.21 to v1.23       | 1.6.1                |
 | v0.42.0                | v1.21 to v1.23       | 1.6.1                |
 | v0.41.1                | v1.21 to v1.23       | 1.6.1                |
 | v0.41.0                | v1.20 to v1.22       | 1.6.1                |

bundle/manifests/opentelemetry-operator.clusterserviceversion.yaml

@@ -37,7 +37,7 @@ metadata:
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
     repository: github.com/open-telemetry/opentelemetry-operator
     support: OpenTelemetry Community
-  name: opentelemetry-operator.v0.42.0
+  name: opentelemetry-operator.v0.43.0
   namespace: placeholder
 spec:
   apiservicedefinitions: {}
@@ -265,7 +265,7 @@ spec:
               - args:
                 - --metrics-addr=127.0.0.1:8080
                 - --enable-leader-election
-                image: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator:v0.42.0
+                image: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator:v0.43.0
                 livenessProbe:
                   httpGet:
                     path: /healthz
@@ -369,7 +369,7 @@ spec:
   maturity: alpha
   provider:
     name: OpenTelemetry Community
-  version: 0.42.0
+  version: 0.43.0
   webhookdefinitions:
   - admissionReviewVersions:
     - v1

pkg/collector/upgrade/v0_43_0.go

@@ -0,0 +1,96 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package upgrade
+
+import (
+    "fmt"
+    "reflect"
+    "sort"
+    "strings"
+
+    "gopkg.in/yaml.v2"
+    "sigs.k8s.io/controller-runtime/pkg/client"
+
+    "github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
+    "github.com/open-telemetry/opentelemetry-operator/pkg/collector/adapters"
+)
+
+func upgrade0_43_0(cl client.Client, otelcol *v1alpha1.OpenTelemetryCollector) (*v1alpha1.OpenTelemetryCollector, error) {
+    // return if args exist
+    if len(otelcol.Spec.Args) == 0 {
+            return otelcol, nil
+    }
+
+    foundMetricsArgs := make(map[string]string)
+    for argKey, argValue := range otelcol.Spec.Args {
+            if argKey == "--metrics-addr" || argKey == "--metrics-level" {
+                    foundMetricsArgs[argKey] = argValue
+                    delete(otelcol.Spec.Args, argKey)
+            }
+    }
+
+    if len(foundMetricsArgs) > 0 {
+        cfg, err := adapters.ConfigFromString(otelcol.Spec.Config)
+        if err != nil {
+            return otelcol, fmt.Errorf("couldn't upgrade to v0.43.0, failed to parse configuration: %w", err)
+        }
+
+        serviceConfig, ok := cfg["service"].(map[interface{}]interface{})
+        if !ok {
+
+            cfg["service"] = make(map[interface{}]interface{})
+            serviceConfig, _ = cfg["service"].(map[interface{}]interface{})
+        }
+
+        telemetryConfig, ok := serviceConfig["telemetry"].(map[interface{}]interface{})
+        if !ok {
+            serviceConfig["telemetry"] = make(map[interface{}]interface{})
+            telemetryConfig, _ = serviceConfig["telemetry"].(map[interface{}]interface{})
+        }
+
+        metricsConfig, ok := telemetryConfig["metrics"].(map[interface{}]interface{})
+        if !ok {
+            telemetryConfig["metrics"] = make(map[interface{}]interface{})
+            metricsConfig, _ = telemetryConfig["metrics"].(map[interface{}]interface{})
+        }
+
+        if len(metricsConfig) == 0 {
+            if val, ok := foundMetricsArgs["--metrics-addr"]; ok {
+                metricsConfig["address"] = val
+            }
+        	if val, ok := foundMetricsArgs["--metrics-level"]; ok {
+                metricsConfig["level"] = val
+            }
+        }
+        cfg["service"] = serviceConfig
+        res, err := yaml.Marshal(cfg)
+
+        if err != nil {
+            return otelcol, fmt.Errorf("couldn't upgrade to v0.43.0, failed to marshall back configuration: %w", err)
+        }
+
+        otelcol.Spec.Config = string(res)
+
+        keys := reflect.ValueOf(foundMetricsArgs).MapKeys()
+
+        sort.Slice(keys, func(i, j int) bool {
+            return strings.Compare(keys[i].String(), keys[j].String()) <= 0
+        })
+
+        otelcol.Status.Messages = append(otelcol.Status.Messages, fmt.Sprintf("upgrade to v0.43.0 dropped the deprecated metrics arguments " + "i.e. %v from otelcol custom resource otelcol.spec.args and adding them to otelcol.spec.config.service.telemetry.metrics., if no metrics settings are configured already.", keys))
+    }
+
+    return otelcol, nil
+}

pkg/collector/upgrade/v0_43_0_test.go

@@ -0,0 +1,48 @@
+package upgrade_test
+
+import (
+    "context"
+    "testing"
+
+	"github.com/stretchr/testify/assert"
+    "github.com/stretchr/testify/require"
+     metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+    "k8s.io/apimachinery/pkg/types"
+
+    "github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
+    "github.com/open-telemetry/opentelemetry-operator/internal/version"
+    "github.com/open-telemetry/opentelemetry-operator/pkg/collector/upgrade"
+)
+
+func TestRemoveMetricsArgs(t *testing.T) {
+    // prepare
+    nsn := types.NamespacedName{Name: "my-instance", Namespace: "default"}
+    existing := v1alpha1.OpenTelemetryCollector{
+        ObjectMeta: metav1.ObjectMeta{
+            Name:      nsn.Name,
+            Namespace: nsn.Namespace,
+            Labels: map[string]string{
+                "app.kubernetes.io/managed-by": "opentelemetry-operator",
+            },
+        },
+        Spec: v1alpha1.OpenTelemetryCollectorSpec{
+            Args: map[string]string{
+                // this would not happen in the real world, as it's either one or another, but we aren't going that far
+                "--metrics-addr":  ":8988",
+                "--metrics-level": "detailed",
+            },
+        },
+    }
+    existing.Status.Version = "0.42.0"
+
+    require.Contains(t, existing.Spec.Args, "--metrics-addr")
+    require.Contains(t, existing.Spec.Args, "--metrics-level")
+
+    // test
+    res, err := upgrade.ManagedInstance(context.Background(), logger, version.Get(), nil, existing)
+    assert.NoError(t, err)
+
+    // verify
+    assert.NotContains(t, res.Spec.Args, "--metrics-addr")
+    assert.NotContains(t, res.Spec.Args, "--metrics-level")
+}

pkg/collector/upgrade/versions.go

@@ -70,6 +70,10 @@ var (
 			Version: *semver.MustParse("0.41.0"),
 			upgrade: upgrade0_41_0,
 		},
+		{
+			Version: *semver.MustParse("0.43.0"),
+			upgrade: upgrade0_43_0,
+		},
 	}
 
 	// Latest represents the latest version that we need to upgrade. This is not necessarily the latest known version.

tests/e2e/instrumentation-java/00-install-collector.yaml

@@ -4,8 +4,6 @@ metadata:
   name: sidecar
 spec:
   mode: sidecar
-  args:
-    metrics-level: detailed
   config: |
     receivers:
       otlp:

tests/e2e/instrumentation-nodejs/00-install-collector.yaml

@@ -4,8 +4,6 @@ metadata:
   name: sidecar
 spec:
   mode: sidecar
-  args:
-    metrics-level: detailed
   config: |
     receivers:
       otlp:

tests/e2e/instrumentation-python/00-install-collector.yaml

@@ -4,8 +4,6 @@ metadata:
   name: sidecar
 spec:
   mode: sidecar
-  args:
-    metrics-level: detailed
   config: |
     receivers:
       otlp:

tests/e2e/smoke-pod-annotations/00-install.yaml

@@ -24,5 +24,3 @@ spec:
           receivers: [jaeger]
           processors: []
           exporters: [logging]
-  args:
-    metrics-level: detailed

tests/e2e/smoke-restarting-deployment/00-install.yaml

@@ -17,5 +17,3 @@ spec:
           receivers: [jaeger]
           processors: []
           exporters: [logging]
-  args:
-    metrics-level: detailed

tests/e2e/smoke-restarting-deployment/01-install-second-config.yaml

@@ -20,5 +20,4 @@ spec:
           receivers: [jaeger, otlp]
           processors: []
           exporters: [logging]
-  args:
-    metrics-level: detailed
+

tests/e2e/smoke-sidecar/00-install.yaml

@@ -4,8 +4,6 @@ metadata:
   name: sidecar-for-my-app
 spec:
   mode: sidecar
-  args:
-    metrics-level: detailed
   config: |
     receivers:
       jaeger:

tests/e2e/smoke-simplest/00-install.yaml

@@ -18,6 +18,4 @@ spec:
         traces:
           receivers: [jaeger]
           processors: []
-          exporters: [logging]
-  args:
-    metrics-level: detailed
+          exporters: [logging]

versions.txt

@@ -2,10 +2,10 @@
 # by default with the OpenTelemetry Operator. This would usually be the latest
 # stable OpenTelemetry version. When you update this file, make sure to update the
 # the docs as well.
-opentelemetry-collector=0.42.0
+opentelemetry-collector=0.43.0
 
 # Represents the current release of the OpenTelemetry Operator.
-operator=0.42.0
+operator=0.43.0
 
 # Represents the current release of the Target Allocator.
 targetallocator=0.1.0