Deprecate SPLUNK_TRACE_URL env var and don't use it in default configs (#5672)

Deprecate `SPLUNK_TRACE_URL` environment variable and replace with `${SPLUNK_INGEST_URL}/v2/trace`in the default configs. `SPLUNK_TRACE_URL` is still automatically set in the binary computed from on `SPLUNK_REALM` or `SPLUNK_INGEST_URL` environment variables to not break existing configurations. However, it is recommended to
  update the configurations to use `${SPLUNK_INGEST_URL}/v2/trace` instead.

Also, packaging and mass deployment solutions were update to not provide the option to set the Trace URL since it's not being used anymore in the default configs.

Author: dmitryax

.github/workflows/scripts/win-test-services.ps1

@@ -44,7 +44,6 @@ $expected_svc_env_vars = @{
   "SPLUNK_REALM"            = "$realm";
   "SPLUNK_API_URL"          = "$api_url";
   "SPLUNK_INGEST_URL"       = "$ingest_url";
-  "SPLUNK_TRACE_URL"        = "${ingest_url}/v2/trace";
   "SPLUNK_HEC_URL"          = "${ingest_url}/v1/log";
   "SPLUNK_HEC_TOKEN"        = "$access_token";
   "SPLUNK_BUNDLE_DIR"       = "${env:PROGRAMFILES}\Splunk\OpenTelemetry Collector\agent-bundle";

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+### 🚩Deprecations 🚩
+
+- (Splunk) `SPLUNK_TRACE_URL` environment variable is deprecated. It's replaced with `${SPLUNK_INGEST_URL}/v2/trace`
+  in the default configs. Default value for `SPLUNK_TRACE_URL` is still set in the binary from `SPLUNK_REALM` or
+  `SPLUNK_INGEST_URL` environment variables to not break existing configurations. However, it is recommended to
+  update the configurations to use `${SPLUNK_INGEST_URL}/v2/trace` instead. ([#5672](https://github.com/signalfx/splunk-otel-collector/pull/5672)).
+
+### 🛑 Breaking changes 🛑
+
+- (Splunk) Given that `SPLUNK_TRACE_URL` environment variable is deprecated and replaced with
+  `${SPLUNK_INGEST_URL}/v2/trace` in the default configurations, the option to set the Trace URL has been removed from 
+  all packaging and mass deployment solutions to an avoid confusion. ([#5672](https://github.com/signalfx/splunk-otel-collector/pull/5672)).
+
 ### 🧰 Bug fixes 🧰
 
 - (Splunk) `receiver/journald`: Upgrade journald client libraries in the Collector docker image by taking them from latest Debian image. 

cmd/otelcol/config/collector/agent_config.yaml

@@ -10,7 +10,6 @@
 # - SPLUNK_HEC_URL: The Splunk HEC endpoint URL, e.g. https://ingest.us0.signalfx.com/v1/log
 # - SPLUNK_INGEST_URL: The Splunk ingest URL, e.g. https://ingest.us0.signalfx.com
 # - SPLUNK_LISTEN_INTERFACE: The network interface the agent receivers listen on.
-# - SPLUNK_TRACE_URL: The Splunk trace endpoint URL, e.g. https://ingest.us0.signalfx.com/v2/trace
 
 extensions:
   health_check:
@@ -129,7 +128,7 @@ exporters:
   # Traces
   sapm:
     access_token: "${SPLUNK_ACCESS_TOKEN}"
-    endpoint: "${SPLUNK_TRACE_URL}"
+    endpoint: "${SPLUNK_INGEST_URL}/v2/trace"
   # Metrics + Events
   signalfx:
     access_token: "${SPLUNK_ACCESS_TOKEN}"

cmd/otelcol/config/collector/upstream_agent_config.yaml

@@ -12,7 +12,6 @@
 # - SPLUNK_HEC_TOKEN: The Splunk HEC authentication token
 # - SPLUNK_HEC_URL: The Splunk HEC endpoint URL, e.g. https://ingest.us0.signalfx.com/v1/log
 # - SPLUNK_INGEST_URL: The Splunk ingest URL, e.g. https://ingest.us0.signalfx.com
-# - SPLUNK_TRACE_URL: The Splunk trace endpoint URL, e.g. https://ingest.us0.signalfx.com/v2/trace
 
 extensions:
   health_check:
@@ -123,7 +122,7 @@ exporters:
   # Traces
   sapm:
     access_token: "${SPLUNK_ACCESS_TOKEN}"
-    endpoint: "${SPLUNK_TRACE_URL}"
+    endpoint: "${SPLUNK_INGEST_URL}/v2/trace"
   # Metrics + Events
   signalfx:
     access_token: "${SPLUNK_ACCESS_TOKEN}"

cmd/otelcol/fips/config/agent_config.yaml

@@ -8,7 +8,6 @@
 # - SPLUNK_HEC_URL: The Splunk HEC endpoint URL, e.g. https://ingest.us0.signalfx.com/v1/log
 # - SPLUNK_INGEST_URL: The Splunk ingest URL, e.g. https://ingest.us0.signalfx.com
 # - SPLUNK_LISTEN_INTERFACE: The network interface the agent receivers listen on.
-# - SPLUNK_TRACE_URL: The Splunk trace endpoint URL, e.g. https://ingest.us0.signalfx.com/v2/trace
 
 extensions:
   health_check:
@@ -119,7 +118,7 @@ exporters:
   # Traces
   sapm:
     access_token: "${SPLUNK_ACCESS_TOKEN}"
-    endpoint: "${SPLUNK_TRACE_URL}"
+    endpoint: "${SPLUNK_INGEST_URL}/v2/trace"
   # Metrics + Events
   signalfx:
     access_token: "${SPLUNK_ACCESS_TOKEN}"

deployments/ansible/molecule/custom_vars/verify.yml

@@ -37,13 +37,6 @@
         state: present
       check_mode: yes
 
-    - name: Assert SPLUNK_TRACE_URL env var is set
-      ansible.builtin.lineinfile:
-        line: SPLUNK_TRACE_URL=https://fake-splunk-ingest.com/v2/trace
-        dest: /etc/otel/collector/splunk-otel-collector.conf
-        state: present
-      check_mode: yes
-
     - name: Assert SPLUNK_HEC_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_HEC_URL=https://fake-splunk-ingest.com/v1/log

deployments/ansible/molecule/custom_vars/windows-verify.yml

@@ -8,7 +8,6 @@
       SPLUNK_CONFIG: '{{ ansible_env.ProgramData }}\Splunk\OpenTelemetry Collector\custom_config.yml'
       SPLUNK_INGEST_URL: https://fake-splunk-ingest.com
       SPLUNK_API_URL: https://fake-splunk-api.com
-      SPLUNK_TRACE_URL: https://fake-splunk-ingest.com/v2/trace
       SPLUNK_HEC_URL: https://fake-splunk-hec.com
       SPLUNK_HEC_TOKEN: fake-hec-token
       SPLUNK_MEMORY_TOTAL_MIB: "256"

deployments/ansible/molecule/default/verify.yml

@@ -43,13 +43,6 @@
         state: present
       check_mode: yes
 
-    - name: Assert SPLUNK_TRACE_URL env var is set
-      ansible.builtin.lineinfile:
-        line: SPLUNK_TRACE_URL=https://ingest.fake-realm.signalfx.com/v2/trace
-        dest: /etc/otel/collector/splunk-otel-collector.conf
-        state: present
-      check_mode: yes
-
     - name: Assert SPLUNK_HEC_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_HEC_URL=https://ingest.fake-realm.signalfx.com/v1/log

deployments/ansible/molecule/default/windows-verify.yml

@@ -12,7 +12,6 @@
       SPLUNK_HEC_TOKEN: fake-token
       SPLUNK_HEC_URL: https://ingest.fake-realm.signalfx.com/v1/log
       SPLUNK_INGEST_URL: https://ingest.fake-realm.signalfx.com
-      SPLUNK_TRACE_URL: https://ingest.fake-realm.signalfx.com/v2/trace
   tasks:
     - name: Check splunk-otel-collector service
       ansible.windows.win_service:

deployments/ansible/molecule/with_instrumentation/windows-verify.yml

@@ -12,7 +12,6 @@
       SPLUNK_HEC_TOKEN: fake-token
       SPLUNK_HEC_URL: https://ingest.fake-realm.signalfx.com/v1/log
       SPLUNK_INGEST_URL: https://ingest.fake-realm.signalfx.com
-      SPLUNK_TRACE_URL: https://ingest.fake-realm.signalfx.com/v2/trace
     iis_reg_values:
       COR_ENABLE_PROFILING: "1"
       COR_PROFILER: "{B4C89B0F-9908-4F73-9F59-0D77C5A06874}"