Preset default value for SPLUNK_TRACE_URL from SPLUNK_INGEST_URL (#5670)

If SPLUNK_INGEST_URL set by the user, use it to populate default value for SPLUNK_TRACE_URL. This is a preliminary step before we can deprecate and remove SPLUNK_TRACE_URL
signalfx · Dec 5, 2024 · 7f963ba · 7f963ba
1 parent 3f739af
commit 7f963ba
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 19 deletions.
diff --git a/internal/settings/settings.go b/internal/settings/settings.go
@@ -376,36 +376,34 @@ func checkRuntimeParams(settings *Settings) error {
 }
 
 func setDefaultEnvVars(s *Settings) error {
-	type ev struct {
-		e, v string
-		log  bool
+	defaultEnvVars := map[string]string{
+		ListenInterfaceEnvVar:     defaultListenAddr(s),
+		ConfigServerEnabledEnvVar: "true",
 	}
 
-	envVars := []ev{
-		{e: ListenInterfaceEnvVar, v: defaultListenAddr(s), log: true},
-		{e: ConfigServerEnabledEnvVar, v: "true"},
+	if realm, ok := os.LookupEnv(RealmEnvVar); ok {
+		defaultEnvVars[APIURLEnvVar] = fmt.Sprintf("https://api.%s.signalfx.com", realm)
+		defaultEnvVars[IngestURLEnvVar] = fmt.Sprintf("https://ingest.%s.signalfx.com", realm)
+		defaultEnvVars[TraceIngestURLEnvVar] = fmt.Sprintf("https://ingest.%s.signalfx.com/v2/trace", realm)
+		defaultEnvVars[HecLogIngestURLEnvVar] = fmt.Sprintf("https://ingest.%s.signalfx.com/v1/log", realm)
 	}
 
-	if realm, ok := os.LookupEnv(RealmEnvVar); ok {
-		envVars = append(envVars,
-			ev{e: APIURLEnvVar, v: fmt.Sprintf("https://api.%s.signalfx.com", realm)},
-			ev{e: IngestURLEnvVar, v: fmt.Sprintf("https://ingest.%s.signalfx.com", realm)},
-			ev{e: TraceIngestURLEnvVar, v: fmt.Sprintf("https://ingest.%s.signalfx.com/v2/trace", realm)},
-			ev{e: HecLogIngestURLEnvVar, v: fmt.Sprintf("https://ingest.%s.signalfx.com/v1/log", realm)},
-		)
+	if ingestURL, ok := os.LookupEnv(IngestURLEnvVar); ok {
+		ingestURL = strings.TrimSuffix(ingestURL, "/")
+		defaultEnvVars[TraceIngestURLEnvVar] = fmt.Sprintf("%s/v2/trace", ingestURL)
 	}
 
 	if token, ok := os.LookupEnv(TokenEnvVar); ok {
-		envVars = append(envVars, ev{e: HecTokenEnvVar, v: token})
+		defaultEnvVars[HecTokenEnvVar] = token
 	}
 
-	for _, envVar := range envVars {
-		if _, ok := os.LookupEnv(envVar.e); !ok {
-			if err := os.Setenv(envVar.e, envVar.v); err != nil {
+	for e, v := range defaultEnvVars {
+		if _, ok := os.LookupEnv(e); !ok {
+			if err := os.Setenv(e, v); err != nil {
 				return err
 			}
-			if envVar.log {
-				log.Printf("set %q to %q", envVar.e, envVar.v)
+			if e == ListenInterfaceEnvVar {
+				log.Printf("set %q to %q", e, v)
 			}
 		}
 	}

diff --git a/internal/settings/settings_test.go b/internal/settings/settings_test.go
@@ -288,6 +288,17 @@ func TestSetDefaultEnvVarsSetsHECTokenFromAccessTokenEnvVar(t *testing.T) {
 	assert.Equal(t, token, val)
 }
 
+func TestSetDefaultEnvVarsSetsTraceURLFromIngestURL(t *testing.T) {
+	t.Cleanup(clearEnv(t))
+
+	os.Setenv("SPLUNK_INGEST_URL", "https://ingest.fake-realm.signalfx.com/")
+	require.NoError(t, setDefaultEnvVars(nil))
+
+	val, ok := os.LookupEnv("SPLUNK_TRACE_URL")
+	assert.True(t, ok)
+	assert.Equal(t, "https://ingest.fake-realm.signalfx.com/v2/trace", val)
+}
+
 func TestSetDefaultEnvVarsRespectsSetEnvVars(t *testing.T) {
 	t.Cleanup(clearEnv(t))
 	envVars := []string{"SPLUNK_API_URL", "SPLUNK_INGEST_URL", "SPLUNK_TRACE_URL", "SPLUNK_HEC_URL", "SPLUNK_HEC_TOKEN", "SPLUNK_LISTEN_INTERFACE"}