feat: provide cluster_name on GKE resources

ofrobots · ofrobots · commit 71bd4580ac50 · 2017-07-28T08:39:57.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/package.json b/packages/logging/package.json
@@ -57,6 +57,7 @@
     "arrify": "^1.0.0",
     "eventid": "^0.1.0",
     "extend": "^3.0.0",
+    "gcp-metadata": "^0.2.0",
     "google-auto-auth": "^0.7.1",
     "google-gax": "^0.13.0",
     "google-proto-files": "^0.12.0",
diff --git a/packages/logging/src/metadata.js b/packages/logging/src/metadata.js
@@ -20,6 +20,8 @@
 
 'use strict';
 
+var gcpMetadata = require('gcp-metadata');
+
 /**
  * The Metadata class attempts to contact the metadata service and determine,
  * based on request success and environment variables, what type of resource
@@ -95,13 +97,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
     }
   };
 };
@@ -138,21 +143,29 @@ Metadata.prototype.getDefaultResource = function(callback) {
     }
 
     self.logging.auth.getEnvironment(function(err, env) {
-      var defaultResource;
-
-      if (env.IS_APP_ENGINE) {
-        defaultResource = Metadata.getGAEDescriptor(projectId);
-      } else if (env.IS_CLOUD_FUNCTION) {
-        defaultResource = Metadata.getCloudFunctionDescriptor(projectId);
-      } else if (env.IS_CONTAINER_ENGINE) {
-        defaultResource = Metadata.getGKEDescriptor(projectId);
-      } else if (env.IS_COMPUTE_ENGINE) {
-        defaultResource = Metadata.getGCEDescriptor(projectId);
+      if (env.IS_CONTAINER_ENGINE) {
+        gcpMetadata.instance('attributes/clusterName',
+          function (err, _, clusterName) {
+            if (err) {
+              return callback(err);
+            }
+            callback(null, Metadata.getGKEDescriptor(projectId, clusterName));
+          });
       } else {
-        defaultResource = Metadata.getGlobalDescriptor(projectId);
-      }
+        var defaultResource;
+
+        if (env.IS_APP_ENGINE) {
+          defaultResource = Metadata.getGAEDescriptor(projectId);
+        } else if (env.IS_CLOUD_FUNCTION) {
+          defaultResource = Metadata.getCloudFunctionDescriptor(projectId);
+        } else if (env.IS_COMPUTE_ENGINE) {
+          defaultResource = Metadata.getGCEDescriptor(projectId);
+        } else {
+          defaultResource = Metadata.getGlobalDescriptor(projectId);
+        }
 
-      callback(null, defaultResource);
+        callback(null, defaultResource);
+      }
     });
   });
 };
diff --git a/packages/logging/test/metadata.js b/packages/logging/test/metadata.js
@@ -18,8 +18,20 @@
 
 var assert = require('assert');
 var extend = require('extend');
+var proxyquire = require('proxyquire');
 
-var Metadata = require('../src/metadata.js');
+var instanceValueOverride;
+var fakeGcpMetadata = {
+  instance: function(path, cb) {
+    setImmediate(function () {
+      cb(null, null, instanceValueOverride || 'fake-instance-value');
+    });
+  }
+};
+
+var Metadata = proxyquire('../src/metadata.js', {
+  'gcp-metadata': fakeGcpMetadata
+});
 
 describe('metadata', function() {
   var MetadataCached;
@@ -40,6 +52,7 @@ describe('metadata', function() {
     };
     extend(Metadata, MetadataCached);
     metadata = new Metadata(LOGGING);
+    instanceValueOverride = null;
   });
 
   afterEach(function() {
@@ -104,10 +117,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,10 +262,14 @@ describe('metadata', function() {
 
       describe('container engine', function() {
         it('should return correct descriptor', function(done) {
+          var RETURNED_CLUSTER_NAME = 'fake-cluster-name';
           var DESCRIPTOR = {};
 
-          Metadata.getGKEDescriptor = function(projectId) {
+          instanceValueOverride = RETURNED_CLUSTER_NAME;
+
+          Metadata.getGKEDescriptor = function(projectId, clusterName) {
             assert.strictEqual(projectId, RETURNED_PROJECT_ID);
+            assert.strictEqual(clusterName, RETURNED_CLUSTER_NAME);
             return DESCRIPTOR;
           };
 
