Merge branch 'main' into upgrade_otelcol_chef

Author: crobert-1

CHANGELOG.md

@@ -9,6 +9,11 @@
   - A common replacement for Fluentd's functionality is the [filelog receiver](https://help.splunk.com/en/splunk-observability-cloud/manage-data/available-data-sources/supported-integrations-in-splunk-observability-cloud/opentelemetry-receivers/filelog-receiver).
     Many common configuration examples of the `filelog` receiver can be found in the [logs_config_linux.yaml](https://github.com/signalfx/splunk-otel-collector/blob/87bee7ae45b08be8d143a758d0f7004fd92d8f60/cmd/otelcol/config/collector/logs_config_linux.yaml) file.
 
+### 💡 Enhancements 💡
+
+- (Splunk) Add an install property, `COLLECTOR_SVC_ARGS`, to the Windows MSI to
+  configure the command-line arguments used to launch the collector service on Windows.
+
 ## v0.126.0
 
 This Splunk OpenTelemetry Collector release includes changes from the [opentelemetry-collector v0.126.0](https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.126.0)

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/alecthomas/participle/v2 v2.1.4
 	github.com/antonmedv/expr v1.15.5
 	github.com/cenkalti/backoff/v4 v4.3.0
-	github.com/expr-lang/expr v1.17.3
+	github.com/expr-lang/expr v1.17.4
 	github.com/fsnotify/fsnotify v1.9.0
 	github.com/go-zookeeper/zk v1.0.4
 	github.com/gogo/protobuf v1.3.2
@@ -128,7 +128,7 @@ require (
 	github.com/signalfx/splunk-otel-collector/pkg/processor/timestampprocessor v0.83.0
 	github.com/signalfx/splunk-otel-collector/pkg/receiver/smartagentreceiver v0.0.0-00010101000000-000000000000
 	github.com/signalfx/splunk-otel-collector/tests v0.83.0
-	github.com/spf13/cast v1.8.0
+	github.com/spf13/cast v1.9.1
 	github.com/spf13/pflag v1.0.6
 	github.com/stretchr/testify v1.10.0
 	go.etcd.io/bbolt v1.4.0

go.sum

@@ -502,8 +502,8 @@ github.com/euank/go-kmsg-parser v2.0.0+incompatible h1:cHD53+PLQuuQyLZeriD1V/esu
 github.com/euank/go-kmsg-parser v2.0.0+incompatible/go.mod h1:MhmAMZ8V4CYH4ybgdRwPr2TU5ThnS43puaKEMpja1uw=
 github.com/evanphx/json-patch/v5 v5.9.11 h1:/8HVnzMq13/3x9TPvjG08wUGqBTmZBsCWzjTM0wiaDU=
 github.com/evanphx/json-patch/v5 v5.9.11/go.mod h1:3j+LviiESTElxA4p3EMKAB9HXj3/XEtnUf6OZxqIQTM=
-github.com/expr-lang/expr v1.17.3 h1:myeTTuDFz7k6eFe/JPlep/UsiIjVhG61FMHFu63U7j0=
-github.com/expr-lang/expr v1.17.3/go.mod h1:8/vRC7+7HBzESEqt5kKpYXxrxkr31SaO8r40VO/1IT4=
+github.com/expr-lang/expr v1.17.4 h1:qhTVftZ2Z3WpOEXRHWErEl2xf1Kq011MnQmWgLq06CY=
+github.com/expr-lang/expr v1.17.4/go.mod h1:8/vRC7+7HBzESEqt5kKpYXxrxkr31SaO8r40VO/1IT4=
 github.com/facebook/time v0.0.0-20240510113249-fa89cc575891 h1:x6T9k2Jw0IPzSdM2i4tVWmnJ3KJ1fEKwWJ++IzDvPDU=
 github.com/facebook/time v0.0.0-20240510113249-fa89cc575891/go.mod h1:2UFAomOuD2vAK1x68czUtCVjAqmyWCEnAXOlmGqf+G0=
 github.com/facebookgo/stack v0.0.0-20160209184415-751773369052 h1:JWuenKqqX8nojtoVVWjGfOF9635RETekkoH6Cc9SX0A=
@@ -1852,8 +1852,8 @@ github.com/spaolacci/murmur3 v1.1.0/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2
 github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
 github.com/spf13/afero v1.2.1/go.mod h1:9ZxEEn6pIJ8Rxe320qSDBk6AsU0r9pR7Q4OcevTdifk=
 github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
-github.com/spf13/cast v1.8.0 h1:gEN9K4b8Xws4EX0+a0reLmhq8moKn7ntRlQYgjPeCDk=
-github.com/spf13/cast v1.8.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo=
+github.com/spf13/cast v1.9.1 h1:LxnjuHJpEjFUlBvGDef9duW2jIfjfm9a2f4tCgyvsEw=
+github.com/spf13/cast v1.9.1/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo=
 github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU=
 github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
 github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=

packaging/bundle/java/jmx/pom.xml

@@ -51,12 +51,12 @@
         <dependency>
             <groupId>org.codehaus.groovy</groupId>
             <artifactId>groovy</artifactId>
-            <version>3.0.24</version>
+            <version>3.0.25</version>
         </dependency>
         <dependency>
             <groupId>org.codehaus.groovy</groupId>
             <artifactId>groovy-jmx</artifactId>
-            <version>3.0.24</version>
+            <version>3.0.25</version>
         </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>

packaging/msi/splunk-otel-collector.wxs

@@ -23,6 +23,10 @@
          Execute="deferred"
          Impersonate="no" /> 
 
+      <!-- Following name convention for this property to match upstream -->
+      <!-- On upstream it is required and has a default value, here it is optional -->
+      <Property Id="COLLECTOR_SVC_ARGS" Secure="yes" />
+
       <!-- SPLUNK setup control properties -->
       <Property Id="SPLUNK_SETUP_COLLECTOR_MODE" Value="agent" Secure="yes" />
 
@@ -79,6 +83,7 @@
                         Start="auto"
                         Account="LocalSystem"
                         ErrorControl="normal"
+                        Arguments="[COLLECTOR_SVC_ARGS]"
                         Interactive="no" />
                      <ServiceControl
                         Id="StartStopRemoveService"

packaging/release/requirements.txt

@@ -1,4 +1,4 @@
 PyGithub==2.6.1
-boto3==1.38.23
+boto3==1.38.27
 docker==7.1.0
 requests==2.32.3

packaging/tests/requirements.txt

@@ -3,7 +3,7 @@ iterators==0.2.0
 psutil==7.0.0
 pytest==8.3.5
 pytest-html==4.1.1
-pytest-xdist==3.6.1
+pytest-xdist==3.7.0
 py>=1.8.2
 requests<2.33.0
 six==1.17.0

tests/msi/msi_test.go

@@ -52,6 +52,13 @@ func TestMSI(t *testing.T) {
 				"SPLUNK_ACCESS_TOKEN": "fakeToken",
 			},
 		},
+		{
+			name: "default-plus-cli-args",
+			collectorMSIProperties: map[string]string{
+				"SPLUNK_ACCESS_TOKEN": "fakeToken",
+				"COLLECTOR_SVC_ARGS":  "--discovery --set=processors.batch.timeout=10s",
+			},
+		},
 		{
 			name: "gateway",
 			collectorMSIProperties: map[string]string{
@@ -205,10 +212,13 @@ func runMsiTest(t *testing.T, test msiTest, msiInstallerPath string) {
 		return status.State == svc.Running
 	}, 10*time.Second, 500*time.Millisecond, "Failed to start the service")
 
-	assertServiceConfiguration(t, test.collectorMSIProperties)
+	svcConfig, err := service.Config()
+	require.NoError(t, err, "Failed to get service configuration")
+
+	assertServiceConfiguration(t, test.collectorMSIProperties, svcConfig)
 }
 
-func assertServiceConfiguration(t *testing.T, msiProperties map[string]string) {
+func assertServiceConfiguration(t *testing.T, msiProperties map[string]string, svcConfig mgr.Config) {
 	programDataDir := os.Getenv("PROGRAMDATA")
 	require.NotEmpty(t, programDataDir, "PROGRAMDATA environment variable is not set")
 	programFilesDir := os.Getenv("PROGRAMFILES")
@@ -241,8 +251,12 @@ func assertServiceConfiguration(t *testing.T, msiProperties map[string]string) {
 	}
 
 	// Verify the environment variables set for the service
-	svcConfig := getServiceEnvVars(t, "splunk-otel-collector")
-	assert.Equal(t, expectedEnvVars, svcConfig)
+	svcEnvVars := getServiceEnvVars(t, "splunk-otel-collector")
+	assert.Equal(t, expectedEnvVars, svcEnvVars)
+
+	if svcArgs, ok := msiProperties["COLLECTOR_SVC_ARGS"]; ok {
+		assert.Equal(t, expectedServiceCommand(t, svcArgs), svcConfig.BinaryPathName)
+	}
 }
 
 func optionalInstallPropertyOrDefault(msiProperties map[string]string, key, defaultValue string) string {
@@ -282,3 +296,29 @@ func getInstallerPath(t *testing.T) string {
 	}
 	return msiInstallerPath
 }
+
+func expectedServiceCommand(t *testing.T, collectorServiceArgs string) string {
+	programFilesDir := os.Getenv("PROGRAMFILES")
+	require.NotEmpty(t, programFilesDir, "PROGRAMFILES environment variable is not set")
+
+	collectorDir := filepath.Join(programFilesDir, "Splunk", "OpenTelemetry Collector")
+	collectorExe := filepath.Join(collectorDir, "otelcol") + ".exe"
+
+	if collectorServiceArgs == "" {
+		return quotedIfRequired(collectorExe)
+	}
+
+	// Remove any quotation added for the msiexec command line
+	collectorServiceArgs = strings.Trim(collectorServiceArgs, "\"")
+	collectorServiceArgs = strings.ReplaceAll(collectorServiceArgs, "\"\"", "\"")
+
+	return quotedIfRequired(collectorExe) + " " + collectorServiceArgs
+}
+
+func quotedIfRequired(s string) string {
+	if strings.Contains(s, "\"") || strings.Contains(s, " ") {
+		s = strings.ReplaceAll(s, "\"", "\"\"")
+		return "\"" + s + "\""
+	}
+	return s
+}