feat: provide cluster_name on GKE resources

ofrobots · ofrobots · commit 7bb6fe83ac54 · 2017-07-21T17:17:54.000-07:00
For better log categorization in the Logging UI, we need to include
the cluster name as part of the resource descriptor.
diff --git a/packages/logging/src/metadata.js b/packages/logging/src/metadata.js
@@ -95,13 +95,16 @@ Metadata.getGCEDescriptor = function(projectId) {
  * @private
  *
  * @param {string} projectId - The project ID.
+ * @param {string} clusterName - GKE cluster name.
  * @return {object}
  */
-Metadata.getGKEDescriptor = function(projectId) {
+Metadata.getGKEDescriptor = function(projectId, clusterName) {
   return {
     type: 'container',
     labels: {
-      project_id: projectId,
+      // TODO(ofrobots): it would be good to include the namespace_id as well.
+      cluster_name: clusterName,
+      project_id: projectId
     }
   };
 };
@@ -145,7 +148,7 @@ Metadata.prototype.getDefaultResource = function(callback) {
       } else if (env.IS_CLOUD_FUNCTION) {
         defaultResource = Metadata.getCloudFunctionDescriptor(projectId);
       } else if (env.IS_CONTAINER_ENGINE) {
-        defaultResource = Metadata.getGKEDescriptor(projectId);
+        defaultResource = Metadata.getGKEDescriptor(projectId, env.clusterName);
       } else if (env.IS_COMPUTE_ENGINE) {
         defaultResource = Metadata.getGCEDescriptor(projectId);
       } else {
diff --git a/packages/logging/test/metadata.js b/packages/logging/test/metadata.js
@@ -104,10 +104,13 @@ describe('metadata', function() {
   });
 
   describe('getGKEDescriptor', function() {
+    var CLUSTER_NAME = 'gke-cluster-name';
+
     it('should return the correct descriptor', function() {
-      assert.deepEqual(Metadata.getGKEDescriptor(PROJECT_ID), {
+      assert.deepEqual(Metadata.getGKEDescriptor(PROJECT_ID, CLUSTER_NAME), {
         type: 'container',
         labels: {
+          cluster_name: CLUSTER_NAME,
           project_id: PROJECT_ID
         }
       });
@@ -246,16 +249,19 @@ describe('metadata', function() {
 
       describe('container engine', function() {
         it('should return correct descriptor', function(done) {
+          var RETURNED_CLUSTER_NAME = 'fake-cluster';
           var DESCRIPTOR = {};
 
-          Metadata.getGKEDescriptor = function(projectId) {
+          Metadata.getGKEDescriptor = function(projectId, clusterName) {
             assert.strictEqual(projectId, RETURNED_PROJECT_ID);
+            assert.strictEqual(clusterName, RETURNED_CLUSTER_NAME);
             return DESCRIPTOR;
           };
 
           metadata.logging.auth.getEnvironment = function(callback) {
             callback(null, {
-              IS_CONTAINER_ENGINE: true
+              IS_CONTAINER_ENGINE: true,
+              clusterName: RETURNED_CLUSTER_NAME
             });
           };
 
