fix(logging): Use instance/attributes/cluster-location for location o…

…n GKE (#9094) * fix(logging): Use instance/attributes/cluster-location for location on GKE. * Fixed `go vet` errors --------- Co-authored-by: Cindy Peng <148148319+cindy-peng@users.noreply.github.com>
googleapis · Dec 11, 2023 · c85b9d4 · c85b9d4
1 parent 0538be4
commit c85b9d4
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 30 deletions.
diff --git a/logging/logging_test.go b/logging/logging_test.go
@@ -282,25 +282,25 @@ func TestToLogEntry(t *testing.T) {
 	tests := []struct {
 		name      string
 		in        logging.Entry
-		want      logpb.LogEntry
+		want      *logpb.LogEntry
 		wantError error
 	}{
 		{
 			name: "BlankLogEntry",
 			in:   logging.Entry{},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		}, {
 			name: "Already set Trace",
 			in:   logging.Entry{Trace: "t1"},
-			want: logpb.LogEntry{Trace: "t1"},
+			want: &logpb.LogEntry{Trace: "t1"},
 		}, {
 			name: "No X-Trace-Context header",
 			in: logging.Entry{
 				HTTPRequest: &logging.HTTPRequest{
 					Request: &http.Request{URL: u, Header: http.Header{"foo": {"bar"}}},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		}, {
 			name: "X-Trace-Context header with all fields",
 			in: logging.Entry{
@@ -312,7 +312,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace:        "projects/P/traces/105445aa7843bc8bf206b120001000",
 				SpanId:       "000000000000004a",
 				TraceSampled: true,
@@ -328,7 +328,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace:        "projects/P/traces/105445aa7843bc8bf206b120001000",
 				SpanId:       "000000000000004a",
 				TraceSampled: true,
@@ -343,7 +343,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace:        "projects/P/traces/105445aa7843bc8bf206b120001000",
 				SpanId:       "000000000000004a",
 				TraceSampled: true,
@@ -358,7 +358,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		}, {
 			name: "X-Trace-Context header with blank span",
 			in: logging.Entry{
@@ -369,7 +369,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace: "projects/P/traces/105445aa7843bc8bf206b120001000",
 			},
 		}, {
@@ -382,7 +382,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace: "projects/P/traces/105445aa7843bc8bf206b120001000",
 			},
 		}, {
@@ -395,7 +395,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		}, {
 			name: "Invalid X-Trace-Context header but already set TraceID",
 			in: logging.Entry{
@@ -407,13 +407,13 @@ func TestToLogEntry(t *testing.T) {
 				},
 				Trace: "t4",
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace: "t4",
 			},
 		}, {
 			name: "Already set TraceID and SpanID",
 			in:   logging.Entry{Trace: "t1", SpanID: "007"},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace:  "t1",
 				SpanId: "007",
 			},
@@ -436,7 +436,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace:  "projects/P/traces/105445aa7843bc8bf206b12000100012",
 				SpanId: "000000000000004a",
 			},
@@ -452,7 +452,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace:        "projects/P/traces/105445aa7843bc8bf206b12000100012",
 				SpanId:       "000000000000004a",
 				TraceSampled: true,
@@ -470,7 +470,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{
+			want: &logpb.LogEntry{
 				Trace:  "projects/P/traces/105445aa7843bc8bf206b1200010aaaa",
 				SpanId: "0000000000000aaa",
 			},
@@ -485,7 +485,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 		{
 			name: "Traceparent header short trace field",
@@ -497,7 +497,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 		{
 			name: "Traceparent header long trace field",
@@ -509,7 +509,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 		{
 			name: "Traceparent header invalid trace field",
@@ -521,7 +521,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 		{
 			name: "Traceparent header trace field all 0s",
@@ -533,7 +533,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 		{
 			name: "Traceparent header short span field",
@@ -545,7 +545,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 		{
 			name: "Traceparent header long span field",
@@ -557,7 +557,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 		{
 			name: "Traceparent header invalid span field",
@@ -569,7 +569,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 		{
 			name: "Traceparent header span field all 0s",
@@ -581,7 +581,7 @@ func TestToLogEntry(t *testing.T) {
 					},
 				},
 			},
-			want: logpb.LogEntry{},
+			want: &logpb.LogEntry{},
 		},
 	}
 	for _, test := range tests {

diff --git a/logging/resource.go b/logging/resource.go
@@ -201,8 +201,8 @@ func detectKubernetesResource() *mrpb.MonitoredResource {
 	if projectID == "" {
 		return nil
 	}
-	zone := detectedResource.metadataZone()
 	clusterName := detectedResource.attrs.Metadata("instance/attributes/cluster-name")
+	clusterLocation := detectedResource.attrs.Metadata("instance/attributes/cluster-location")
 	namespaceName := detectedResource.attrs.ReadAll("/var/run/secrets/kubernetes.io/serviceaccount/namespace")
 	if namespaceName == "" {
 		// if automountServiceAccountToken is disabled allow to customize
@@ -217,7 +217,7 @@ func detectKubernetesResource() *mrpb.MonitoredResource {
 		Type: "k8s_container",
 		Labels: map[string]string{
 			"cluster_name":   clusterName,
-			"location":       zone,
+			"location":       clusterLocation,
 			"project_id":     projectID,
 			"pod_name":       podName,
 			"namespace_name": namespaceName,

diff --git a/logging/resource_test.go b/logging/resource_test.go
@@ -152,9 +152,9 @@ func TestResourceDetection(t *testing.T) {
 			},
 		},
 		{
-			name:     "detect GKE resource",
+			name:     "detect GKE resource for a zonal cluster",
 			envVars:  map[string]string{"HOSTNAME": podName},
-			metaVars: map[string]string{"": there, "project/project-id": projectID, "instance/zone": qualifiedZoneName, "instance/attributes/cluster-name": clusterName},
+			metaVars: map[string]string{"": there, "project/project-id": projectID, "instance/attributes/cluster-location": zoneID, "instance/attributes/cluster-name": clusterName},
 			fsPaths:  map[string]string{"/var/run/secrets/kubernetes.io/serviceaccount/namespace": namespaceName},
 			want: &mrpb.MonitoredResource{
 				Type: "k8s_container",
@@ -168,10 +168,27 @@ func TestResourceDetection(t *testing.T) {
 				},
 			},
 		},
+		{
+			name:     "detect GKE resource for a regional cluster",
+			envVars:  map[string]string{"HOSTNAME": podName},
+			metaVars: map[string]string{"": there, "project/project-id": projectID, "instance/attributes/cluster-location": regionID, "instance/attributes/cluster-name": clusterName},
+			fsPaths:  map[string]string{"/var/run/secrets/kubernetes.io/serviceaccount/namespace": namespaceName},
+			want: &mrpb.MonitoredResource{
+				Type: "k8s_container",
+				Labels: map[string]string{
+					"cluster_name":   clusterName,
+					"location":       regionID,
+					"project_id":     projectID,
+					"pod_name":       podName,
+					"namespace_name": namespaceName,
+					"container_name": "",
+				},
+			},
+		},
 		{
 			name:     "detect GKE resource with custom container and namespace config",
 			envVars:  map[string]string{"HOSTNAME": podName, "CONTAINER_NAME": containerName, "NAMESPACE_NAME": namespaceName},
-			metaVars: map[string]string{"": there, "project/project-id": projectID, "instance/zone": qualifiedZoneName, "instance/attributes/cluster-name": clusterName},
+			metaVars: map[string]string{"": there, "project/project-id": projectID, "instance/attributes/cluster-location": zoneID, "instance/attributes/cluster-name": clusterName},
 			want: &mrpb.MonitoredResource{
 				Type: "k8s_container",
 				Labels: map[string]string{