Add instance_id field in Process Stats response

- Display the Diego instance identifier as part of the Process Stats
response. This id is unique for each actual LRP instance and can be used
as a substitute for the integer index id.
- Eirini does not support this in their API at this time, so the OPI
variant of the instances stats reporter returns an empty string for this
field. In the future, if Eirini is enhanced to provide this we can
update that client.
- Issue: #2819

Authored-by: Tim Downey <tdowney@vmware.com>

Author: tcdowney

app/presenters/v3/process_stats_presenter.rb

@@ -32,14 +32,15 @@ def instance_stats_hash(index, stats)
 
         def found_instance_stats_hash(index, stats)
           {
-            type:       @type,
-            index:      index,
-            state:      stats[:state],
-            host:       stats[:stats][:host],
-            uptime:     stats[:stats][:uptime],
-            mem_quota:  stats[:stats][:mem_quota],
-            disk_quota: stats[:stats][:disk_quota],
-            fds_quota:  stats[:stats][:fds_quota],
+            type:        @type,
+            index:       index,
+            instance_id: stats[:stats][:instance_id],
+            state:       stats[:state],
+            host:        stats[:stats][:host],
+            uptime:      stats[:stats][:uptime],
+            mem_quota:   stats[:stats][:mem_quota],
+            disk_quota:  stats[:stats][:disk_quota],
+            fds_quota:   stats[:stats][:fds_quota],
             isolation_segment: stats[:isolation_segment],
             details: stats[:details]
           }.tap do |presented_stats|

docs/v3/source/includes/api_resources/_processes.erb

@@ -214,6 +214,7 @@
 {
   "type": "web",
   "index": 0,
+  "instance_id": "e49f448e-54d2-4c33-61a3-5335",
   "state": "RUNNING",
   "usage": {
     "time": "2016-03-23T23:17:30.476314154Z",

docs/v3/source/includes/resources/processes/_stats_object.md.erb

@@ -8,9 +8,10 @@ Example process stats object
 ```
 
 Name | Type | Description
----- | ---- | -----------
+---- | -- | -----------
 **type** | _string_ | Process type; a unique identifier for processes belonging to an app
 **index** | _integer_ | The zero-based index of running instances
+**instance_id** | _string_ | The unique identifier of the instance
 **state** | _string_ | The state of the instance; valid values are `RUNNING`, `CRASHED`, `STARTING`, `DOWN`
 **usage** | _object_ | Object containing actual usage data for the instance; the value is `{}` when usage data is unavailable
 **usage.time** | _[timestamp](#timestamps)_ | The time when the usage was requested

lib/cloud_controller/diego/reporters/instances_stats_reporter.rb

@@ -35,6 +35,7 @@ def stats_for_app(process)
               name:       process.name,
               uris:       process.uris,
               host:       actual_lrp.actual_lrp_net_info.address,
+              instance_id: actual_lrp.actual_lrp_instance_key.instance_guid,
               port:       get_default_port(actual_lrp.actual_lrp_net_info),
               net_info:   actual_lrp.actual_lrp_net_info.to_h,
               uptime:     nanoseconds_to_seconds(current_time * 1e9 - actual_lrp.since),

lib/cloud_controller/opi/instances_client.rb

@@ -12,6 +12,7 @@ class NotRunningProcessError < StandardError; end
 
     LRP_INSTANCES_RETRIES = 5
     ActualLRPKey = Struct.new(:index, :process_guid)
+    ActualLRPInstanceKey = Struct.new(:instance_guid)
     ActualLRPNetInfo = Struct.new(:address, :ports)
     PortMapping = Struct.new(:container_port, :host_port)
     DesiredLRP = Struct.new(:PlacementTags, :metric_tags)
@@ -23,10 +24,11 @@ def to_hash
     end
 
     class ActualLRP
-      attr_reader :actual_lrp_key, :state, :since, :placement_error, :actual_lrp_net_info
+      attr_reader :actual_lrp_key, :actual_lrp_instance_key, :state, :since, :placement_error, :actual_lrp_net_info
 
       def initialize(instance, process_guid)
         @actual_lrp_key = ActualLRPKey.new(instance['index'], process_guid)
+        @actual_lrp_instance_key = ActualLRPInstanceKey.new('')
         @state = instance['state']
         @since = instance['since']
         @placement_error = instance['placement_error']

spec/request/processes_spec.rb

@@ -490,6 +490,7 @@
             name: process.name,
             uris: process.uris,
             host: 'toast',
+            instance_id: 'some-diego-instance-id',
             net_info: net_info_1,
             uptime: 12345,
             mem_quota:  process[:memory] * 1024 * 1024,
@@ -515,6 +516,7 @@
           'type'           => 'worker',
           'index'          => 0,
           'state'          => 'RUNNING',
+          'instance_id' => 'some-diego-instance-id',
           'isolation_segment' => 'very-isolated',
           'details' => 'some-details',
           'usage' => {

spec/unit/lib/cloud_controller/diego/reporters/instances_stats_reporter_spec.rb

@@ -88,6 +88,7 @@ def make_actual_lrp(instance_guid:, index:, state:, error:, since:)
                 name:       process.name,
                 uris:       process.uris,
                 host:       'lrp-host',
+                instance_id: 'instance-a',
                 port:       2222,
                 net_info:   lrp_1_net_info.to_h,
                 uptime:     two_days_in_seconds,
@@ -273,6 +274,7 @@ def make_actual_lrp(instance_guid:, index:, state:, error:, since:)
                   name:       process.name,
                   uris:       process.uris,
                   host:       'lrp-host',
+                  instance_id:       'instance-a',
                   port:       2222,
                   net_info:   lrp_1_net_info.to_h,
                   uptime:     two_days_in_seconds,
@@ -397,6 +399,7 @@ def make_actual_lrp(instance_guid:, index:, state:, error:, since:)
                   name:       process.name,
                   uris:       process.uris,
                   host:       'lrp-host',
+                  instance_id: 'instance-a',
                   port:       2222,
                   net_info:   lrp_1_net_info.to_h,
                   uptime:     two_days_in_seconds,

spec/unit/lib/cloud_controller/opi/instances_client_spec.rb

@@ -77,6 +77,13 @@
       expect(actual_lrp.placement_error).to eq('')
     end
 
+    # Eirini doesn't currently support ActualLRP instance guids
+    it 'provides an empty instance_guid value' do
+      actual_lrp = actual_lrps.first
+      expect(actual_lrp).to respond_to(:actual_lrp_instance_key)
+      expect(actual_lrp.actual_lrp_instance_key.instance_guid).to eq('')
+    end
+
     context 'when having multiple actual LRPs' do
       let(:response_body) do
         {
@@ -189,7 +196,7 @@
   end
 
   context '#desired_lrp_instance' do
-    it 'should return a DesiredLRP with a placeholder PlacmentTags' do
+    it 'should return a DesiredLRP with a placeholder PlacementTags' do
       desired_lrp = client.desired_lrp_instance(process)
       expect(desired_lrp.PlacementTags.first).to eq('placeholder')
     end

spec/unit/presenters/v3/process_stats_presenter_spec.rb

@@ -62,6 +62,7 @@ module VCAP::CloudController::Presenters::V3
               name: process.name,
               uris: process.uris,
               host: 'myhost',
+              instance_id: 'instance-a',
               net_info: net_info_1,
               uptime: 12345,
               mem_quota:  process[:memory] * 1024 * 1024,
@@ -82,6 +83,7 @@ module VCAP::CloudController::Presenters::V3
               name: process.name,
               uris: process.uris,
               host: 'toast',
+              instance_id: 'instance-b',
               net_info: net_info_2,
               uptime: 42,
               mem_quota:  process[:memory] * 1024 * 1024,
@@ -109,6 +111,7 @@ module VCAP::CloudController::Presenters::V3
         expect(result[0][:type]).to eq(process.type)
         expect(result[0][:index]).to eq(0)
         expect(result[0][:state]).to eq('RUNNING')
+        expect(result[0][:instance_id]).to eq('instance-a')
         expect(result[0][:details]).to eq(nil)
         expect(result[0][:isolation_segment]).to eq('hecka-compliant')
         expect(result[0][:host]).to eq('myhost')
@@ -125,6 +128,7 @@ module VCAP::CloudController::Presenters::V3
         expect(result[1][:type]).to eq(process.type)
         expect(result[1][:index]).to eq(1)
         expect(result[1][:state]).to eq('CRASHED')
+        expect(result[1][:instance_id]).to eq('instance-b')
         expect(result[1][:details]).to eq('some-details')
         expect(result[1][:isolation_segment]).to eq(nil)
         expect(result[1][:host]).to eq('toast')
@@ -183,6 +187,7 @@ module VCAP::CloudController::Presenters::V3
           expect(result[0][:type]).to eq(process.type)
           expect(result[0][:index]).to eq(0)
           expect(result[0][:state]).to eq('RUNNING')
+          expect(result[0][:instance_id]).to eq('instance-a')
           expect(result[0][:details]).to eq(nil)
           expect(result[0][:isolation_segment]).to eq('hecka-compliant')
           expect(result[0][:host]).to eq('myhost')
@@ -208,6 +213,7 @@ module VCAP::CloudController::Presenters::V3
                 name: process.name,
                 uris: process.uris,
                 host: 'myhost',
+                instance_id: 'instance-a',
                 net_info: net_info_1,
                 uptime: 12345,
                 fds_quota: process.file_descriptors,
@@ -223,6 +229,7 @@ module VCAP::CloudController::Presenters::V3
           expect(result[0][:type]).to eq(process.type)
           expect(result[0][:index]).to eq(0)
           expect(result[0][:state]).to eq('RUNNING')
+          expect(result[0][:instance_id]).to eq('instance-a')
           expect(result[0][:details]).to eq(nil)
           expect(result[0][:isolation_segment]).to eq('hecka-compliant')
           expect(result[0][:host]).to eq('myhost')