jvmkill_agent.rb

# frozen_string_literal: true

# Cloud Foundry Java Buildpack
# Copyright 2013-2020 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require 'fileutils'
require 'java_buildpack/component/versioned_dependency_component'
require 'java_buildpack/jre'

module JavaBuildpack
  module Jre

    # Encapsulates the detect, compile, and release functionality for the jvmkill agent
    class JvmkillAgent < JavaBuildpack::Component::VersionedDependencyComponent
      include JavaBuildpack::Util

      # (see JavaBuildpack::Component::BaseComponent#compile)
      def compile
        download(@version, @uri) do |file|
          FileUtils.mkdir_p jvmkill_agent.parent
          FileUtils.cp(file.path, jvmkill_agent)
          jvmkill_agent.chmod 0o755
        end

        puts "       Write terminal heap dumps to #{heap_dump_path}" if @application.services.one_volume_service? FILTER
      end

      # (see JavaBuildpack::Component::BaseComponent#release)
      def release
        properties                 = { 'printHeapHistogram' => '1' }
        properties['heapDumpPath'] = heap_dump_path if @application.services.one_volume_service? FILTER

        @droplet.java_opts.add_agentpath_with_props(jvmkill_agent, properties)
      end

      protected

      # (see JavaBuildpack::Component::VersionedDependencyComponent#supports?)
      def supports?
        true
      end

      private

      FILTER = /heap-dump/.freeze

      private_constant :FILTER

      def application_identifier
        "#{@application.details['application_name']}-#{@application.details['application_id'][0...8]}"
      end

      def container_dir
        @application.services.find_volume_service(FILTER)['volume_mounts'].first['container_dir']
      end

      def heap_dump_path
        "#{container_dir}/#{space_identifier}/#{application_identifier}/#{instance_identifier}.hprof"
      end

      def instance_identifier
        '$CF_INSTANCE_INDEX-%FT%T%z-${CF_INSTANCE_GUID:0:8}'
      end

      def jvmkill_agent
        @droplet.sandbox + "bin/jvmkill-#{@version}"
      end

      def space_identifier
        "#{@application.details['space_name']}-#{@application.details['space_id'][0...8]}"
      end

    end

  end
end