[chore][receiver/sqlserver] Add direct connection config options (#32176

)

**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
This adds config options for direct connection to a SQL server instance.
For the sake of PR size, this adds no functionality, it's simply config
options and validation.

**Link to tracking Issue:** <Issue number if applicable>
This was originally part of
#31915,
but I'm breaking this out to make the original PR a more manageable
size.


#30297

**Testing:** <Describe what testing was performed and which tests were
added.>
Existing tests and added tests are all passing.

**Documentation:** <Describe the documentation added.>
No documentation on purpose. The added config options currently have no
impact on functionality, so users shouldn't be aware of this, and
shouldn't try to use them yet.

receiver/sqlserverreceiver/config.go

@@ -6,6 +6,7 @@ package sqlserverreceiver // import "github.com/open-telemetry/opentelemetry-col
 import (
 	"fmt"
 
+	"go.opentelemetry.io/collector/config/configopaque"
 	"go.opentelemetry.io/collector/receiver/scraperhelper"
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver/internal/metadata"
@@ -15,16 +16,28 @@ import (
 type Config struct {
 	scraperhelper.ControllerConfig `mapstructure:",squash"`
 	metadata.MetricsBuilderConfig  `mapstructure:",squash"`
-	InstanceName                   string `mapstructure:"instance_name"`
-	ComputerName                   string `mapstructure:"computer_name"`
+
+	InstanceName string `mapstructure:"instance_name"`
+	ComputerName string `mapstructure:"computer_name"`
+
+	// The following options currently do nothing. Functionality will be added in a future PR.
+	Password configopaque.String `mapstructure:"password"`
+	Port     uint                `mapstructure:"port"`
+	Server   string              `mapstructure:"server"`
+	Username string              `mapstructure:"username"`
 }
 
 func (cfg *Config) Validate() error {
-	if cfg.InstanceName != "" && cfg.ComputerName == "" {
-		return fmt.Errorf("'instance_name' may not be specified without 'computer_name'")
+	err := cfg.validateInstanceAndComputerName()
+	if err != nil {
+		return err
 	}
-	if cfg.InstanceName == "" && cfg.ComputerName != "" {
-		return fmt.Errorf("'computer_name' may not be specified without 'instance_name'")
+
+	if !directDBConnectionEnabled(cfg) {
+		if cfg.Server != "" || cfg.Username != "" || string(cfg.Password) != "" {
+			return fmt.Errorf("Found one or more of the following configuration options set: [server, port, username, password]. " +
+				"All of these options must be configured to directly connect to a SQL Server instance.")
+		}
 	}
 
 	return nil

receiver/sqlserverreceiver/config_others.go

@@ -0,0 +1,10 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build !windows
+
+package sqlserverreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver"
+
+func (cfg *Config) validateInstanceAndComputerName() error {
+	return nil
+}

receiver/sqlserverreceiver/config_others_test.go

@@ -0,0 +1,88 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build !windows
+
+package sqlserverreceiver
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/receiver/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver/internal/metadata"
+)
+
+func TestValidateOtherOS(t *testing.T) {
+	testCases := []struct {
+		desc            string
+		cfg             *Config
+		expectedSuccess bool
+	}{
+		{
+			desc: "valid config",
+			cfg: &Config{
+				MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
+				ControllerConfig:     scraperhelper.NewDefaultControllerConfig(),
+			},
+			expectedSuccess: true,
+		}, {
+			desc: "valid config with no metric settings",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+			},
+			expectedSuccess: true,
+		},
+		{
+			desc:            "default config is valid",
+			cfg:             createDefaultConfig().(*Config),
+			expectedSuccess: true,
+		},
+		{
+			desc: "valid config with both names set",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				ComputerName:     "ComputerName",
+				InstanceName:     "InstanceName",
+			},
+			expectedSuccess: true,
+		},
+		{
+			desc: "valid config with instance_name but not computer_name",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				InstanceName:     "InstanceName",
+			},
+			expectedSuccess: true,
+		},
+		{
+			desc: "valid config with computer_name but not instance_name",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				ComputerName:     "ComputerName",
+			},
+			expectedSuccess: true,
+		},
+		{
+			desc: "valid config with both instance and computer name",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				ComputerName:     "ComputerName",
+				InstanceName:     "InstanceName",
+			},
+			expectedSuccess: true,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.desc, func(t *testing.T) {
+			if tc.expectedSuccess {
+				require.NoError(t, component.ValidateConfig(tc.cfg))
+			} else {
+				require.Error(t, component.ValidateConfig(tc.cfg))
+			}
+		})
+	}
+}

receiver/sqlserverreceiver/config_test.go

@@ -20,30 +20,58 @@ import (
 
 func TestValidate(t *testing.T) {
 	testCases := []struct {
-		desc string
-		cfg  *Config
+		desc            string
+		cfg             *Config
+		expectedSuccess bool
 	}{
 		{
 			desc: "valid config",
 			cfg: &Config{
 				MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
 				ControllerConfig:     scraperhelper.NewDefaultControllerConfig(),
 			},
+			expectedSuccess: true,
 		}, {
 			desc: "valid config with no metric settings",
 			cfg: &Config{
 				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
 			},
+			expectedSuccess: true,
 		},
 		{
-			desc: "default config is valid",
-			cfg:  createDefaultConfig().(*Config),
+			desc:            "default config is valid",
+			cfg:             createDefaultConfig().(*Config),
+			expectedSuccess: true,
+		},
+		{
+			desc: "invalid config with partial direct connect settings",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				Server:           "0.0.0.0",
+				Username:         "sa",
+			},
+			expectedSuccess: false,
+		},
+		{
+			desc: "valid config with all direct connection settings",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				Server:           "0.0.0.0",
+				Username:         "sa",
+				Password:         "password",
+				Port:             1433,
+			},
+			expectedSuccess: true,
 		},
 	}
 
 	for _, tc := range testCases {
 		t.Run(tc.desc, func(t *testing.T) {
-			require.NoError(t, component.ValidateConfig(tc.cfg))
+			if tc.expectedSuccess {
+				require.NoError(t, component.ValidateConfig(tc.cfg))
+			} else {
+				require.Error(t, component.ValidateConfig(tc.cfg))
+			}
 		})
 	}
 }

receiver/sqlserverreceiver/config_windows.go

@@ -0,0 +1,19 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build windows
+
+package sqlserverreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver"
+
+import "fmt"
+
+func (cfg *Config) validateInstanceAndComputerName() error {
+	if cfg.InstanceName != "" && cfg.ComputerName == "" {
+		return fmt.Errorf("'instance_name' may not be specified without 'computer_name'")
+	}
+	if cfg.InstanceName == "" && cfg.ComputerName != "" {
+		return fmt.Errorf("'computer_name' may not be specified without 'instance_name'")
+	}
+
+	return nil
+}

receiver/sqlserverreceiver/config_windows_test.go

@@ -0,0 +1,79 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build windows
+
+package sqlserverreceiver
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/receiver/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver/internal/metadata"
+)
+
+func TestValidateWindows(t *testing.T) {
+	testCases := []struct {
+		desc            string
+		cfg             *Config
+		expectedSuccess bool
+	}{
+		{
+			desc: "valid config",
+			cfg: &Config{
+				MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
+				ControllerConfig:     scraperhelper.NewDefaultControllerConfig(),
+			},
+			expectedSuccess: true,
+		}, {
+			desc: "valid config with no metric settings",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+			},
+			expectedSuccess: true,
+		},
+		{
+			desc:            "default config is valid",
+			cfg:             createDefaultConfig().(*Config),
+			expectedSuccess: true,
+		},
+		{
+			desc: "invalid config with computer_name but not instance_name",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				ComputerName:     "ComputerName",
+			},
+			expectedSuccess: false,
+		},
+		{
+			desc: "invalid config with instance_name but not computer_name",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				InstanceName:     "InstanceName",
+			},
+			expectedSuccess: false,
+		},
+		{
+			desc: "valid config with both names set",
+			cfg: &Config{
+				ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+				ComputerName:     "ComputerName",
+				InstanceName:     "InstanceName",
+			},
+			expectedSuccess: true,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.desc, func(t *testing.T) {
+			if tc.expectedSuccess {
+				require.NoError(t, component.ValidateConfig(tc.cfg))
+			} else {
+				require.Error(t, component.ValidateConfig(tc.cfg))
+			}
+		})
+	}
+}

receiver/sqlserverreceiver/factory.go

@@ -29,3 +29,9 @@ func createDefaultConfig() component.Config {
 		MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
 	}
 }
+
+func directDBConnectionEnabled(config *Config) bool {
+	return config.Server != "" &&
+		config.Username != "" &&
+		string(config.Password) != ""
+}

receiver/sqlserverreceiver/go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/pkg/winperfcounters v0.98.0
 	github.com/stretchr/testify v1.9.0
 	go.opentelemetry.io/collector/component v0.98.1-0.20240412014414-62f589864e3d
+	go.opentelemetry.io/collector/config/configopaque v1.5.1-0.20240412014414-62f589864e3d
 	go.opentelemetry.io/collector/confmap v0.98.1-0.20240412014414-62f589864e3d
 	go.opentelemetry.io/collector/consumer v0.98.1-0.20240412014414-62f589864e3d
 	go.opentelemetry.io/collector/pdata v1.5.1-0.20240412014414-62f589864e3d