observer extension: Rename protocol to transport_protocol (#473)

* observer extension: Rename protocol to transport_protocol

* Address feedback

extension/observer/endpoints.go

@@ -44,10 +44,10 @@ type Pod struct {
 
 // Port is an endpoint that has a target as well as a port.
 type Port struct {
-	Name     string
-	Pod      Pod
-	Port     uint16
-	Protocol Protocol
+	Name      string
+	Pod       Pod
+	Port      uint16
+	Transport Transport
 }
 
 type EndpointEnv map[string]interface{}
@@ -81,7 +81,7 @@ func EndpointToEnv(endpoint Endpoint) (EndpointEnv, error) {
 				"labels":      o.Pod.Labels,
 				"annotations": o.Pod.Annotations,
 			},
-			"protocol": o.Protocol,
+			"transport": o.Transport,
 		}, nil
 
 	default:

extension/observer/endpoints_test.go

@@ -73,8 +73,8 @@ func TestEndpointToEnv(t *testing.T) {
 							"annotation_1": "value_1",
 						},
 					},
-					Port:     2379,
-					Protocol: ProtocolTCP,
+					Port:      2379,
+					Transport: ProtocolTCP,
 				},
 			},
 			want: EndpointEnv{
@@ -94,7 +94,7 @@ func TestEndpointToEnv(t *testing.T) {
 						"annotation_1": "value_1",
 					},
 				},
-				"protocol": ProtocolTCP,
+				"transport": ProtocolTCP,
 			},
 			wantErr: false,
 		},

extension/observer/k8sobserver/handler.go

@@ -85,10 +85,10 @@ func (h *handler) convertPodToEndpoints(pod *v1.Pod) []observer.Endpoint {
 				ID:     endpointID,
 				Target: fmt.Sprintf("%s:%d", podIP, port.ContainerPort),
 				Details: observer.Port{
-					Pod:      podDetails,
-					Name:     port.Name,
-					Port:     uint16(port.ContainerPort),
-					Protocol: getProtocol(port.Protocol),
+					Pod:       podDetails,
+					Name:      port.Name,
+					Port:      uint16(port.ContainerPort),
+					Transport: getTransport(port.Protocol),
 				},
 			})
 		}
@@ -97,7 +97,7 @@ func (h *handler) convertPodToEndpoints(pod *v1.Pod) []observer.Endpoint {
 	return endpoints
 }
 
-func getProtocol(protocol v1.Protocol) observer.Protocol {
+func getTransport(protocol v1.Protocol) observer.Transport {
 	switch protocol {
 	case v1.ProtocolTCP:
 		return observer.ProtocolTCP

extension/observer/k8sobserver/handler_test.go

@@ -46,8 +46,8 @@ func TestEndpointsAdded(t *testing.T) {
 					Name:   "pod-2",
 					Labels: map[string]string{"env": "prod"},
 				},
-				Port:     443,
-				Protocol: observer.ProtocolTCP,
+				Port:      443,
+				Transport: observer.ProtocolTCP,
 			},
 		}}, sink.added)
 	assert.Nil(t, sink.removed)
@@ -78,8 +78,8 @@ func TestEndpointsRemoved(t *testing.T) {
 					Name:   "pod-2",
 					Labels: map[string]string{"env": "prod"},
 				},
-				Port:     443,
-				Protocol: observer.ProtocolTCP,
+				Port:      443,
+				Transport: observer.ProtocolTCP,
 			},
 		}}, sink.removed)
 	assert.Nil(t, sink.added)
@@ -130,7 +130,7 @@ func TestEndpointsChanged(t *testing.T) {
 				Name: "https", Pod: observer.Pod{
 					Name:   "pod-2",
 					Labels: map[string]string{"env": "prod", "updated-label": "true"}},
-				Port:     443,
-				Protocol: observer.ProtocolTCP}},
+				Port:      443,
+				Transport: observer.ProtocolTCP}},
 	}, sink.changed)
 }

extension/observer/observer.go

@@ -14,16 +14,24 @@
 
 package observer
 
-// Protocol defines network protocol for container ports.
-type Protocol string
+// Transport defines protocol for ports.
+type Transport string
 
 const (
 	// ProtocolTCP is the TCP protocol.
-	ProtocolTCP Protocol = "TCP"
+	ProtocolTCP Transport = "TCP"
+	// ProtocolTCP4 is the TCP4 protocol.
+	ProtocolTCP4 Transport = "TCP4"
+	// ProtocolTCP6 is the TCP6 protocol.
+	ProtocolTCP6 Transport = "TCP6"
 	// ProtocolUDP is the UDP protocol.
-	ProtocolUDP Protocol = "UDP"
+	ProtocolUDP Transport = "UDP"
+	// ProtocolUDP4 is the UDP4 protocol.
+	ProtocolUDP4 Transport = "UDP4"
+	// ProtocolUDP6 is the UDP6 protocol.
+	ProtocolUDP6 Transport = "UDP6"
 	// ProtocolUnknown is some other protocol or it is unknown.
-	ProtocolUnknown Protocol = "Unknown"
+	ProtocolUnknown Transport = "Unknown"
 )
 
 // Observable is an interface that provides notification of endpoint changes.

receiver/receivercreator/README.md

@@ -59,7 +59,9 @@ Each rule must start with `type.(pod|port) &&` such that the rule matches only o
 | pod.name        | name of the owning pod               |
 | pod.labels      | map of labels of the owning pod      |
 | pod.annotations | map of annotations of the owning pod |
-| protocol        | "TCP" or "UDP"                       |
+| protocol        | `TCP` or `UDP`                       |
+
+
 
 ## Example
 

receiver/receivercreator/fixtures_test.go

@@ -39,10 +39,10 @@ var portEndpoint = observer.Endpoint{
 	ID:     "port-1",
 	Target: "localhost:1234",
 	Details: observer.Port{
-		Name:     "http",
-		Pod:      pod,
-		Port:     1234,
-		Protocol: observer.ProtocolTCP,
+		Name:      "http",
+		Pod:       pod,
+		Port:      1234,
+		Transport: observer.ProtocolTCP,
 	},
 }