Merge pull request #998 from M-Tsur/re-enable-takipi

Re-add Takipi Agent

Author: pivotal-david-osullivan

config/components.yml

@@ -75,5 +75,6 @@ frameworks:
   - "JavaBuildpack::Framework::SpringInsight"
   - "JavaBuildpack::Framework::SkyWalkingAgent"
   - "JavaBuildpack::Framework::YourKitProfiler"
+  - "JavaBuildpack::Framework::TakipiAgent"
   - "JavaBuildpack::Framework::JavaSecurity"
   - "JavaBuildpack::Framework::JavaOpts"

config/takipi_agent.yml

@@ -16,6 +16,6 @@
 # Configuration for the Takipi framework
 ---
 version: 4.+
-repository_root: ""
+repository_root: https://get.takipi.com/cloudfoundry
 node_name_prefix: node
 application_name: 

docs/framework-takipi_agent.md

@@ -36,11 +36,21 @@ The framework can be configured by modifying the [`config/takipi_agent.yml`][] f
 | `node_name_prefix` | Node name prefix, will be concatenated with `-` and instance index
 | `application_name` | Override the CloudFoundry default application name
 
+### Remarks
+In case **Java 9+** is being used, 2 JVM flags will be added to the execution:
+| Name | Description
+| ---- | -----------
+| `-XX:-UseTypeSpeculation` | Disable type speculation optimization of the JVM which might not work properly in some situations where an agent is present.
+| `-Xshare:off` | Disable class sharing as it might affect the agent's bytecode manipulation work.
+
+These two flags are needs as otherwise the agent or the JVM might not work properly together.
+
 ## Logs
 
-Currently, you can get the Takipi agent logs using `cf files` command:
+Currently, you can view the Takipi agent logs using the `cf ssh` command:
 ```
-cf files app_name app/.java-buildpack/takipi_agent/log/
+cf ssh app_name 
+cat ~/app/.java-buildpack/takipi_agent/log/agents/*.log
 ```
 
 ## Troubleshooting

lib/java_buildpack/framework/takipi_agent.rb

@@ -31,6 +31,7 @@ class TakipiAgent < JavaBuildpack::Component::VersionedDependencyComponent
       def compile
         download_tar
         @droplet.copy_resources
+        FileUtils.mkdir_p @droplet.sandbox + 'log/agents/'
       end
 
       # (see JavaBuildpack::Component::BaseComponent#release)
@@ -39,6 +40,8 @@ def release
                 .add_agentpath(agent)
                 .add_system_property('takipi.name', application_name)
 
+        update_java9
+
         @droplet.environment_variables
                 .add_environment_variable('LD_LIBRARY_PATH',
                                           "$LD_LIBRARY_PATH:#{qualify_path(lib, @droplet.root)}")
@@ -99,6 +102,14 @@ def node_name
         "#{@configuration['node_name_prefix']}-$CF_INSTANCE_INDEX"
       end
 
+      def update_java9
+        return unless @droplet.java_home.java_9_or_later?
+
+        @droplet.java_opts
+                .add_preformatted_options('-Xshare:off')
+                .add_preformatted_options('-XX:-UseTypeSpeculation')
+      end
+
     end
 
   end