[confignet] Change Transport from string to TransportType

.chloggen/confignet-transport-type.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# 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. otlpreceiver)
+component: confignet
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Change `Transport` field from `string` to `TransportType`
+
+# One or more tracking issues or pull requests related to the change
+issues: [9385]
+
+# (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:
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

config/configgrpc/configgrpc.go

@@ -289,8 +289,8 @@ func (gss *GRPCServerSettings) ToServer(host component.Host, settings component.
 }
 
 func (gss *GRPCServerSettings) toServerOption(host component.Host, settings component.TelemetrySettings) ([]grpc.ServerOption, error) {
-	switch gss.NetAddr.Transport {
-	case "tcp", "tcp4", "tcp6", "udp", "udp4", "udp6":
+	switch gss.NetAddr.TransportType {
+	case confignet.TransportTypeTCP, confignet.TransportTypeTCP4, confignet.TransportTypeTCP6, confignet.TransportTypeUDP, confignet.TransportTypeUDP4, confignet.TransportTypeUDP6:
 		internal.WarnOnUnspecifiedHost(settings.Logger, gss.NetAddr.Endpoint)
 	}
 

config/configgrpc/configgrpc_test.go

@@ -384,8 +384,8 @@ func TestGRPCServerWarning(t *testing.T) {
 		{
 			settings: GRPCServerSettings{
 				NetAddr: confignet.NetAddr{
-					Endpoint:  "0.0.0.0:1234",
-					Transport: "tcp",
+					Endpoint:      "0.0.0.0:1234",
+					TransportType: confignet.TransportTypeTCP,
 				},
 			},
 			len: 1,
@@ -701,7 +701,7 @@ func TestContextWithClient(t *testing.T) {
 			expected: client.Info{},
 		},
 		{
-			desc: "existing client with IP, no peer information",
+			desc: "existing client with TransportTypeIP, no peer information",
 			input: client.NewContext(context.Background(), client.Info{
 				Addr: &net.IPAddr{
 					IP: net.IPv4(1, 2, 3, 4),
@@ -727,7 +727,7 @@ func TestContextWithClient(t *testing.T) {
 			},
 		},
 		{
-			desc: "existing client, existing IP gets overridden with peer information",
+			desc: "existing client, existing TransportTypeIP gets overridden with peer information",
 			input: peer.NewContext(client.NewContext(context.Background(), client.Info{
 				Addr: &net.IPAddr{
 					IP: net.IPv4(1, 2, 3, 4),
@@ -1074,7 +1074,7 @@ func (gts *grpcTraceServer) Export(ctx context.Context, _ ptraceotlp.ExportReque
 	return ptraceotlp.NewExportResponse(), nil
 }
 
-// tempSocketName provides a temporary Unix socket name for testing.
+// tempSocketName provides a temporary TransportTypeUnix socket name for testing.
 func tempSocketName(t *testing.T) string {
 	tmpfile, err := os.CreateTemp("", "sock")
 	require.NoError(t, err)

config/confignet/confignet.go

@@ -5,10 +5,53 @@
 
 import (
 	"context"
+	"fmt"
 	"net"
 	"time"
 )
 
+// TransportType represents a type of network transport protocol
+type TransportType string
+
+const (
+	TransportTypeTCP        TransportType = "tcp"
+	TransportTypeTCP4       TransportType = "tcp4"
+	TransportTypeTCP6       TransportType = "tcp6"
+	TransportTypeUDP        TransportType = "udp"
+	TransportTypeUDP4       TransportType = "udp4"
+	TransportTypeUDP6       TransportType = "udp6"
+	TransportTypeIP         TransportType = "ip"
+	TransportTypeIP4        TransportType = "ip4"
+	TransportTypeIP6        TransportType = "ip6"
+	TransportTypeUnix       TransportType = "unix"
+	TransportTypeUnixgram   TransportType = "unixgram"
+	TransportTypeUnixPacket TransportType = "unixpacket"
+)
+
+// UnmarshalText unmarshalls text to a TransportType.
+// Valid values are "tcp", "tcp4", "tcp6", "udp", "udp4",
+// "udp6", "ip", "ip4", "ip6", "unix", "unixgram" and "unixpacket"
+func (tt *TransportType) UnmarshalText(in []byte) error {
+	switch typ := TransportType(in); typ {
+	case TransportTypeTCP,
+		TransportTypeTCP4,
+		TransportTypeTCP6,
+		TransportTypeUDP,
+		TransportTypeUDP4,
+		TransportTypeUDP6,
+		TransportTypeIP,
+		TransportTypeIP4,
+		TransportTypeIP6,
+		TransportTypeUnix,
+		TransportTypeUnixgram,
+		TransportTypeUnixPacket:
+		*tt = typ
+		return nil
+	default:
+		return fmt.Errorf("unsupported transport type %q", typ)
+	}
+}
+
 // DialerConfig contains options for connecting to an address.
 type DialerConfig struct {
 	// Timeout is the maximum amount of time a dial will wait for
@@ -19,37 +62,54 @@
 // NetAddr represents a network endpoint address.
 type NetAddr struct {
 	// Endpoint configures the address for this network connection.
-	// For TCP and UDP networks, the address has the form "host:port". The host must be a literal IP address,
-	// or a host name that can be resolved to IP addresses. The port must be a literal port number or a service name.
+	// For TransportTypeTCP and TransportTypeUDP networks, the address has the form "host:port". The host must be a literal TransportTypeIP address,
+	// or a host name that can be resolved to TransportTypeIP addresses. The port must be a literal port number or a service name.
 	// If the host is a literal IPv6 address it must be enclosed in square brackets, as in "[2001:db8::1]:80" or
 	// "[fe80::1%zone]:80". The zone specifies the scope of the literal IPv6 address as defined in RFC 4007.
 	Endpoint string `mapstructure:"endpoint"`
 
 	// Transport to use. Known protocols are "tcp", "tcp4" (IPv4-only), "tcp6" (IPv6-only), "udp", "udp4" (IPv4-only),
 	// "udp6" (IPv6-only), "ip", "ip4" (IPv4-only), "ip6" (IPv6-only), "unix", "unixgram" and "unixpacket".
+	// Deprecated: [0.94.0] Use TransportType instead
 	Transport string `mapstructure:"transport"`
 
+	// TransportType to use. Allowed protocols are "tcp", "tcp4" (IPv4-only), "tcp6" (IPv6-only), "udp", "udp4" (IPv4-only),
+	// "udp6" (IPv6-only), "ip", "ip4" (IPv4-only), "ip6" (IPv6-only), "unix", "unixgram" and "unixpacket".
+	TransportType TransportType `mapstructure:"transport_type"`
+
 	// DialerConfig contains options for connecting to an address.
 	DialerConfig DialerConfig `mapstructure:"dialer"`
 }
 
 // Dial equivalent with net.Dialer's DialContext for this address.
 func (na *NetAddr) Dial(ctx context.Context) (net.Conn, error) {
 	d := net.Dialer{Timeout: na.DialerConfig.Timeout}
-	return d.DialContext(ctx, na.Transport, na.Endpoint)
+
+	tt := string(na.TransportType)
+	if na.Transport != "" {
+		tt = na.Transport
+	}
+
+	return d.DialContext(ctx, tt, na.Endpoint)
 }
 
 // Listen equivalent with net.ListenConfig's Listen for this address.
 func (na *NetAddr) Listen(ctx context.Context) (net.Listener, error) {
 	lc := net.ListenConfig{}
-	return lc.Listen(ctx, na.Transport, na.Endpoint)
+
+	tt := string(na.TransportType)
+	if na.Transport != "" {
+		tt = na.Transport
+	}
+
+	return lc.Listen(ctx, tt, na.Endpoint)
 }
 
 // TCPAddr represents a TCP endpoint address.
 type TCPAddr struct {
 	// Endpoint configures the address for this network connection.
-	// The address has the form "host:port". The host must be a literal IP address, or a host name that can be
-	// resolved to IP addresses. The port must be a literal port number or a service name.
+	// The address has the form "host:port". The host must be a literal TransportTypeIP address, or a host name that can be
+	// resolved to TransportTypeIP addresses. The port must be a literal port number or a service name.
 	// If the host is a literal IPv6 address it must be enclosed in square brackets, as in "[2001:db8::1]:80" or
 	// "[fe80::1%zone]:80". The zone specifies the scope of the literal IPv6 address as defined in RFC 4007.
 	Endpoint string `mapstructure:"endpoint"`
@@ -61,11 +121,11 @@
 // Dial equivalent with net.Dialer's DialContext for this address.
 func (na *TCPAddr) Dial(ctx context.Context) (net.Conn, error) {
 	d := net.Dialer{Timeout: na.DialerConfig.Timeout}
-	return d.DialContext(ctx, "tcp", na.Endpoint)
+	return d.DialContext(ctx, string(TransportTypeTCP), na.Endpoint)
 }
 
 // Listen equivalent with net.ListenConfig's Listen for this address.
 func (na *TCPAddr) Listen(ctx context.Context) (net.Listener, error) {
 	lc := net.ListenConfig{}
-	return lc.Listen(ctx, "tcp", na.Endpoint)
+	return lc.Listen(ctx, string(TransportTypeTCP), na.Endpoint)
 }

config/confignet/confignet_test.go

@@ -15,8 +15,8 @@ import (
 
 func TestNetAddrTimeout(t *testing.T) {
 	nac := &NetAddr{
-		Endpoint:  "localhost:0",
-		Transport: "tcp",
+		Endpoint:      "localhost:0",
+		TransportType: "tcp",
 		DialerConfig: DialerConfig{
 			Timeout: -1 * time.Second,
 		},
@@ -50,8 +50,8 @@ func TestTCPAddrTimeout(t *testing.T) {
 
 func TestNetAddr(t *testing.T) {
 	nas := &NetAddr{
-		Endpoint:  "localhost:0",
-		Transport: "tcp",
+		Endpoint:      "localhost:0",
+		TransportType: "tcp",
 	}
 	ln, err := nas.Listen(context.Background())
 	assert.NoError(t, err)

receiver/otlpreceiver/config_test.go

@@ -88,8 +88,8 @@ func TestUnmarshalConfig(t *testing.T) {
 			Protocols: Protocols{
 				GRPC: &configgrpc.GRPCServerSettings{
 					NetAddr: confignet.NetAddr{
-						Endpoint:  "0.0.0.0:4317",
-						Transport: "tcp",
+						Endpoint:      "0.0.0.0:4317",
+						TransportType: confignet.TransportTypeTCP,
 					},
 					TLSSetting: &configtls.TLSServerSetting{
 						TLSSetting: configtls.TLSSetting{
@@ -149,8 +149,8 @@ func TestUnmarshalConfigUnix(t *testing.T) {
 			Protocols: Protocols{
 				GRPC: &configgrpc.GRPCServerSettings{
 					NetAddr: confignet.NetAddr{
-						Endpoint:  "/tmp/grpc_otlp.sock",
-						Transport: "unix",
+						Endpoint:      "/tmp/grpc_otlp.sock",
+						TransportType: confignet.TransportTypeUnix,
 					},
 					ReadBufferSize: 512 * 1024,
 				},

receiver/otlpreceiver/factory.go

@@ -45,8 +45,8 @@ func createDefaultConfig() component.Config {
 		Protocols: Protocols{
 			GRPC: &configgrpc.GRPCServerSettings{
 				NetAddr: confignet.NetAddr{
-					Endpoint:  localhostgate.EndpointForPort(grpcPort),
-					Transport: "tcp",
+					Endpoint:      localhostgate.EndpointForPort(grpcPort),
+					TransportType: confignet.TransportTypeTCP,
 				},
 				// We almost write 0 bytes, so no need to tune WriteBufferSize.
 				ReadBufferSize: 512 * 1024,

receiver/otlpreceiver/testdata/uds.yaml

@@ -1,7 +1,7 @@
 # The following entry demonstrates how to specify a Unix Domain Socket for the server.
 protocols:
   grpc:
-    transport: unix
+    transport_type: unix
     endpoint: /tmp/grpc_otlp.sock
   http:
     # transport: unix