Update operator integration statuses and cli arg options

.chloggen/add-operator-cli-args.yaml

@@ -0,0 +1,12 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other)
+component: operator
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Refactored operator to use cli args instead of feature gates to control instrumentation availability
+# One or more tracking issues related to the change
+issues: [1251]
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: If you're utilizing operator feature gates or auto-instrumentation for apache-httpd, go, nginx, or python, please see [upgrade guidelines](https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#01000-01001)

.chloggen/operator-update.yaml

@@ -0,0 +1,13 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other)
+component: operator
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Bump operator app to v0.99.0 while keeping operator chart at v0.49.1 due to values.schema.json validation blocker
+# One or more tracking issues related to the change
+issues: [1251]
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+  Holding off on updating the operator chart until changes are adopted for [1065](https://github.com/open-telemetry/opentelemetry-helm-charts/pull/1065)

.github/workflows/update_chart_dependencies.yaml

@@ -31,10 +31,12 @@ jobs:
             component: 'operator'
             yaml_file_path: 'helm-charts/splunk-otel-collector/Chart.yaml'
             dependency_name: 'cert-manager'
-          - name: 'operator'
-            component: 'operator'
-            yaml_file_path: 'helm-charts/splunk-otel-collector/Chart.yaml'
-            dependency_name: 'opentelemetry-operator'
+          # TODO: Add this back once this chart has been updated to adhere to
+          # the operator chart schema validation rules. See: https://github.com/open-telemetry/opentelemetry-helm-charts/pull/1065
+          # - name: 'operator'
+          #   component: 'operator'
+          #   yaml_file_path: 'helm-charts/splunk-otel-collector/Chart.yaml'
+          #   dependency_name: 'opentelemetry-operator'
     env:
       DEBUG_MODE: ${{ github.event.inputs.DEBUG_MODE }}
     steps:

UPGRADING.md

@@ -1,5 +1,35 @@
 # Upgrade guidelines
 
+# 0.100.0 to 0.100.1
+
+Feature gates for controlling instrumentation in the operator have been replaced with command-line arguments.
+This update primarily affects users of non-Splunk distributions like apache-httpd, go, nginx, and python, which are now disabled by default.
+
+If you were using `operator.manager.featureGates`, convert previous feature gates to command-line arguments in `operator.manager.extraArgs`. See below for summary of release changes:
+- `+operator.autoinstrumentation.java` becomes `--enable-java-instrumentation=true`
+- `+operator.autoinstrumentation.nodejs` becomes `--enable-nodejs-instrumentation=true`
+- `+operator.autoinstrumentation.dotnet` becomes `--enable-dotnet-instrumentation=true`
+- `+operator.autoinstrumentation.apache-httpd` becomes `--enable-apache-httpd-instrumentation=false`
+- `-operator.autoinstrumentation.go` becomes `--enable-go-instrumentation=false`
+- `-operator.autoinstrumentation.nginx` becomes `--enable-nginx-instrumentation=false`
+- `+operator.autoinstrumentation.python` becomes `--enable-python-instrumentation=false`
+
+If you want to maintain the same level of instrumentation availability as before, configure your `operator` settings as follows:
+```yaml
+operator:
+  manager:
+    extraArgs:
+      - --enable-java-instrumentation=true
+      - --enable-nodejs-instrumentation=true
+      - --enable-dotnet-instrumentation=true
+      - --enable-apache-httpd-instrumentation=true
+      - --enable-go-instrumentation=false
+      - --enable-nginx-instrumentation=false
+      - --enable-python-instrumentation=true
+```
+
+If you need to enable a specific instrumentation, such as Go, update the value of `operator.manager.extraArgs` as needed.
+
 # 0.93.0 to 0.94.0
 
 The `networkExplorer` option is removed.

ci_scripts/update-images-operator-otel.sh

@@ -57,7 +57,6 @@ awk '/# Auto-instrumentation Libraries \(Start\)/,/# Auto-instrumentation Librar
 
 # ---- Update Image Information ----
 while IFS='=' read -r IMAGE_KEY VERSION; do
-    NEED_UPDATE="${NEED_UPDATE:-0}"  # Sets NEED_UPDATE to its current value or 0 if not set
     if [[ "$IMAGE_KEY" =~ ^autoinstrumentation-.* ]]; then
         # Upstream Operator Values
         setd "INST_LIB_NAME" "${IMAGE_KEY#autoinstrumentation-}"
@@ -90,6 +89,8 @@ while IFS='=' read -r IMAGE_KEY VERSION; do
                 echo "Upserting value for ${REPOSITORY_LOCAL}:${TAG_UPSTREAM}"
                 yq eval -i ".${TAG_LOCAL_PATH} = \"${TAG_UPSTREAM}\"" "${TEMP_VALUES_FILE}"
                 setd "NEED_UPDATE" 1
+                # Emit the NEED_UPDATE variable to either GitHub output or stdout
+                emit_output "NEED_UPDATE"
             else
                 echo "Failed to find Docker image $IMAGE. Check image repository and tag."
                 exit 1
@@ -104,9 +105,6 @@ while IFS='=' read -r IMAGE_KEY VERSION; do
     fi
 done < "${TEMP_VERSIONS}"
 
-# Emit the NEED_UPDATE variable to either GitHub output or stdout
-emit_output "NEED_UPDATE"
-
 # Merge the updated subsection back into values.yaml
 # This approach specifically updates only the subsection between the start and end tokens.
 # By doing so, we avoid reformatting the entire file, thus preserving the original structure and comments.

docs/auto-instrumentation-install.md

@@ -371,22 +371,26 @@ Below is a breakdown of the main and related components involved in auto-instrum
 
 ### Instrumentation Libraries
 
-In the table below current instrumentation libraries are listed, if they are supported, and how compatible they are
-with Splunk customer content.
-_The native OpenTelemetry instrumentation libraries are owned and maintained by the OpenTelemetry Community, Splunk
-provides best effort support with issues related to native OpenTelemetry instrumentation libraries._
-
-| Instrumentation Library | Distribution  | Status      | Supported        | Splunk Content Compatability | Code Repo                                                                            | Image Repo                                                                     |
-|-------------------------|---------------|-------------|------------------|------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
-| java                    | Splunk        | Available   | Yes              | Completely                   | [Link](github.com/signalfx/splunk-otel-java)                                         | ghcr.io/signalfx/splunk-otel-java/splunk-otel-java                             |
-| dotnet                  | Splunk        | Coming Soon |                  |                              | [Link](github.com/signalfx/splunk-otel-dotnet)                                       |                                                                                |
-| nodejs                  | Splunk        | Available   | Yes              | Completely                   | [Link](github.com/signalfx/splunk-otel-nodejs)                                       | ghcr.io/signalfx/splunk-otel-java/splunk-otel-js                               |
-| python                  | Splunk        | Coming Soon |                  |                              | [Link](github.com/signalfx/splunk-otel-python)                                       |                                                                                |
-| java                    | OpenTelemetry | Available   | Yes              | Mostly                       | [Link](https://github.com/open-telemetry/opentelemetry-java-instrumentation)         | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-java         |
-| dotnet                  | OpenTelemetry | Available   | Yes              | Mostly                       | [Link](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation)       | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-dotnet       |
-| nodejs                  | OpenTelemetry | Available   | Yes              | Mostly                       | [Link](https://github.com/open-telemetry/opentelemetry-nodejs-instrumentation)       | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-nodes        |
-| python                  | OpenTelemetry | Available   | Needs Validation |                              | [Link](https://github.com/open-telemetry/opentelemetry-java-instrumentation)         | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-java         |
-| apache-httpd            | OpenTelemetry | Available   | Needs Validation |                              | [Link](https://github.com/open-telemetry/opentelemetry-apache-httpd-instrumentation) | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd |
+The table below lists the current instrumentation libraries, their availability, and their compatibility with Splunk customer content.
+_Note: Native OpenTelemetry instrumentation libraries are owned and maintained by the OpenTelemetry Community. Splunk provides best effort support for issues related to these libraries._
+
+| Instrumentation Language | Distribution   | Command Line Arg Name                       | Command Line Arg Default Value | Status         | Splunk Content Compatibility | Source URL                                                  | Image Repository                                                               |
+|--------------------------|----------------|---------------------------------------------|--------------------------------|----------------|------------------------------|-------------------------------------------------------------|--------------------------------------------------------------------------------|
+| Java                     | Splunk         | `operator.autoinstrumentation.java`         | true                           | Stable         | Fully Compatible             | https://github.com/signalfx/splunk-otel-java                | ghcr.io/signalfx/splunk-otel-java/splunk-otel-java                             |
+| NodeJS                   | Splunk         | `operator.autoinstrumentation.nodejs`       | true                           | Stable         | Fully Compatible             | https://github.com/signalfx/splunk-otel-js                  | ghcr.io/signalfx/splunk-otel-java/splunk-otel-js                               |
+| DotNet                   | Splunk         | `operator.autoinstrumentation.dotnet`       | true                           | Stable         | Fully Compatible             | https://github.com/signalfx/splunk-otel-dotnet              | ghcr.io/signalfx/splunk-otel-java/splunk-otel-dotnet                           |
+| ApacheHttpD              | OpenTelemetry  | `operator.autoinstrumentation.apache-httpd` | false                          | Experimental   | Partially Compatible         | https://github.com/open-telemetry/opentelemetry-cpp-contrib | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd |
+| Go                       | OpenTelemetry  | `operator.autoinstrumentation.go`           | false                          | Experimental   | Partially Compatible         | https://github.com/open-telemetry/opentelemetry-go          | ghcr.io/open-telemetry/opentelemetry-go-instrumentation/autoinstrumentation-go |
+| Nginx                    | OpenTelemetry  | `operator.autoinstrumentation.nginx`        | false                          | Experimental   | Partially Compatible         | https://github.com/open-telemetry/opentelemetry-cpp-contrib | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd |
+| Python                   | Splunk         | `operator.autoinstrumentation.python`       | false                          | Experimental   | Partially Compatible         | https://github.com/open-telemetry/opentelemetry-python      | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-python       |
+
+#### Steps to Enable Instrumentation with Command Line Arg
+
+1. **Identify the Argument**: Each instrumentation library has a corresponding command line arg that controls its activation, as listed in the table of instrumentation languages.
+
+2. **Modify Helm Values File**: Open your Helm values file where the OpenTelemetry Operator configuration is defined. Locate the `operator.manager.extraArgs` section.
+
+3. **Update the Argument**: To enable an experimental library, update the corresponding command line arg. It should be in the format of `operator.autoinstrumentation.{language}={true|false}`.
 
 ### Documentation Resources
 

examples/enable-operator-and-auto-instrumentation/rendered_manifests/operator/deployment.yaml

@@ -34,12 +34,19 @@ spec:
             - --health-probe-addr=:8081
             - --webhook-port=9443
             - --collector-image=otel/opentelemetry-collector-contrib:0.95.0
+            - --enable-java-instrumentation=true
+            - --enable-nodejs-instrumentation=true
+            - --enable-dotnet-instrumentation=true
+            - --enable-apache-httpd-instrumentation=false
+            - --enable-go-instrumentation=false
+            - --enable-nginx-instrumentation=false
+            - --enable-python-instrumentation=false
           command:
             - /manager
           env:
             - name: ENABLE_WEBHOOKS
               value: "true"
-          image: "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator:0.95.0"
+          image: "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator:0.99.0"
           name: manager
           ports:
             - containerPort: 8080

functional_tests/functional_test.go

@@ -435,6 +435,7 @@ func testNodeJSTraces(t *testing.T) {
 		ptracetest.IgnoreResourceAttributeValue("os.version"),
 		ptracetest.IgnoreResourceAttributeValue("host.arch"),
 		ptracetest.IgnoreResourceAttributeValue("telemetry.sdk.version"),
+		ptracetest.IgnoreResourceAttributeValue("service.instance.id"),
 		ptracetest.IgnoreResourceAttributeValue("splunk.distro.version"),
 		ptracetest.IgnoreResourceAttributeValue("splunk.zc.method"),
 		ptracetest.IgnoreSpanAttributeValue("net.peer.port"),

functional_tests/testdata/expected_eks_values/expected_nodejs_traces.yaml

@@ -4,6 +4,9 @@ resourceSpans:
         - key: service.name
           value:
             stringValue: nodejs-test
+        - key: service.instance.id
+          value:
+            stringValue: default.nodejs-test-d454cf769-f786k.nodejs-test
         - key: telemetry.sdk.language
           value:
             stringValue: nodejs

functional_tests/testdata/expected_kind_values/expected_nodejs_traces.yaml

@@ -4,6 +4,9 @@ resourceSpans:
         - key: service.name
           value:
             stringValue: nodejs-test
+        - key: service.instance.id
+          value:
+            stringValue: default.nodejs-test-d454cf769-f786k.nodejs-test
         - key: telemetry.sdk.language
           value:
             stringValue: nodejs

helm-charts/splunk-otel-collector/templates/NOTES.txt

@@ -77,8 +77,8 @@ Splunk OpenTelemetry Collector is installed and configured to send data to Splun
           Upgrade guidelines: https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#0670-to-0680
 {{ end }}
 {{- if .Values.operator.enabled }}
-[INFO] You've enabled the operator's auto-instrumentation feature (operator.enabled=true), currently considered ALPHA.
-  - Instrumentation library maturity varies (e.g., Java is more mature than Go). For library stability, visit: https://opentelemetry.io/docs/instrumentation/#status-and-releases
-  - Some libraries may be enabled by default. For current status, see: https://github.com/open-telemetry/opentelemetry-operator#controlling-instrumentation-capabilities
-  - Splunk provides best-effort support for native OpenTelemetry libraries, and full support for Splunk library distributions. For used libraries, refer to the values.yaml under "operator.instrumentation.spec".
+[INFO] You've enabled the operator's auto-instrumentation feature (operator.enabled=true)! The operator can automatically instrument Kubernetes hosted applications, the integration maturity can vary per application language.
+  - Status: Instrumentation language maturity varies. See `operator.instrumentation.spec` and documentation for utilized instrumentation details.
+  - Usage: Certain instrumentation languages are enabled by default while other must be enabled manually using `operator.manager.extraArgs`.
+  - Splunk Support: We offer full support for Splunk distributions and best-effort support for native OpenTelemetry instrumentation distributions of instrumentation language libraries.
 {{- end }}

helm-charts/splunk-otel-collector/values.yaml

@@ -1194,6 +1194,7 @@ operator:
       #   - repository: Specifies the Docker image repository.
       #   - tag: Indicates the Docker image tag.
       #   - env: (Optional) Allows you to add any additional environment variables.
+      # Auto-instrumentation for the various languages that are distributed by Splunk or OpenTelemetry.
       java:
         repository: ghcr.io/signalfx/splunk-otel-java/splunk-otel-java
         tag: v1.31.0
@@ -1206,19 +1207,38 @@ operator:
         env:
           - name: OTEL_DOTNET_AUTO_PLUGINS
             value: Splunk.OpenTelemetry.AutoInstrumentation.Plugin, Splunk.OpenTelemetry.AutoInstrumentation
+      # Disabled by default. To enable, update "operator.manager.extraArgs" to include "--enable-apache-httpd-instrumentation=true".
+      apache-httpd:
+        repository: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd
+        tag: 1.0.4
+      # Disabled by default. To enable, update "operator.manager.extraArgs" to include "--enable-go-instrumentation=true".
       go:
         repository: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-go
         tag: v0.10.1-alpha
-      apache-httpd:
+      # Disabled by default. To enable, update "operator.manager.extraArgs" to include "--enable-nginx-instrumentation=true".
+      nginx:
         repository: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd
         tag: 1.0.4
+      # Disabled by default. To enable, update "operator.manager.extraArgs" to include "--enable-python-instrumentation=true".
       python:
         repository: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-python
         tag: 0.44b0
-      nginx:
-        repository: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd
-        tag: 1.0.4
       # Auto-instrumentation Libraries (End)
+  manager:
+    # TODO: Remove overriding the operator version once this chart has been updated to adhere to
+    # the operator chart schema validation rules. See: https://github.com/open-telemetry/opentelemetry-helm-charts/pull/1065
+    image:
+      repository: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
+      tag: "0.99.0"
+    # Configure operator manager command-line args.
+    extraArgs:
+      - --enable-java-instrumentation=true
+      - --enable-nodejs-instrumentation=true
+      - --enable-dotnet-instrumentation=true
+      - --enable-apache-httpd-instrumentation=false
+      - --enable-go-instrumentation=false
+      - --enable-nginx-instrumentation=false
+      - --enable-python-instrumentation=false
   admissionWebhooks:
     certManager:
       # Annotate the certificate and issuer to ensure they are created after the cert-manager CRDs have been installed.