Add New Relic support

nebhale · nebhale · commit c10418786fbb · 2013-08-12T17:04:03.000+01:00
This change adds support for bound New Relic services.  The framework
notices a bound service in VCAP_SERVICES.  During the compile phase,
the New Relic agent JAR is download and a default New Relic
configuration file is copied into place.  During the release phase, a
number of JAVA_OPTS are configured such that the New Relic service is
used during the application's runtime.

[#53027669]
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -7,11 +7,11 @@ GEM
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
     diff-lcs (1.2.4)
-    multi_json (1.7.7)
-    parser (2.0.0.pre2)
+    multi_json (1.7.9)
+    parser (2.0.0.pre6)
       ast (~> 1.1)
       slop (~> 3.4, >= 3.4.5)
-    powerpack (0.0.1)
+    powerpack (0.0.3)
     rainbow (1.1.4)
     rake (10.1.0)
     redcarpet (3.0.0)
@@ -20,24 +20,24 @@ GEM
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
     rspec-core (2.14.4)
-    rspec-expectations (2.14.0)
+    rspec-expectations (2.14.1)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.1)
-    rubocop (0.10.0)
+    rspec-mocks (2.14.3)
+    rubocop (0.11.1)
       backports (~> 3.3.3)
-      parser (= 2.0.0.pre2)
-      powerpack (= 0.0.1)
+      parser (~> 2.0.0.pre6)
+      powerpack (~> 0.0.3)
       rainbow (>= 1.1.4)
-    safe_yaml (0.9.4)
+    safe_yaml (0.9.5)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    slop (3.4.5)
+    slop (3.4.6)
     webmock (1.13.0)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
-    yard (0.8.6.2)
+    yard (0.8.7)
 
 PLATFORMS
   ruby
diff --git a/README.md b/README.md
@@ -28,10 +28,11 @@ The buildpack supports configuration and extension through the use of Git reposi
 	* [Spring Boot CLI](docs/container-spring-boot-cli.md) ([Configuration](docs/container-spring-boot-cli.md#configuration))
 	* [Tomcat](docs/container-tomcat.md) ([Configuration](docs/container-tomcat.md#configuration))
 * Standard Frameworks
+	* [`JAVA_OPTS`](docs/framework-java_opts.md) ([Configuration](docs/framework-java_opts.md#configuration))
+	* [New Relic](docs/framework-new-relic.md) ([Configuration](docs/framework-new-relic.md#configuration))
 	* [Play Auto Reconfiguration](docs/framework-play-auto-reconfiguration.md) ([Configuration](docs/framework-play-auto-reconfiguration.md#configuration))
 	* [Play JPA Plugin](docs/framework-play-jpa-plugin.md) ([Configuration](docs/framework-play-jpa-plugin.md#configuration))
 	* [Spring Auto Reconfiguration](docs/framework-spring-auto-reconfiguration.md) ([Configuration](docs/framework-spring-auto-reconfiguration.md#configuration))
-	* [`JAVA_OPTS`](docs/framework-java_opts.md) ([Configuration](docs/framework-java_opts.md#configuration))
 * Standard JREs
 	* [OpenJDK](docs/jre-openjdk.md) ([Configuration](docs/jre-openjdk.md#configuration))
 * Extending
diff --git a/config/components.yml b/config/components.yml
@@ -25,6 +25,7 @@ jres:
   - "JavaBuildpack::Jre::OpenJdk"
 frameworks:
   - "JavaBuildpack::Framework::JavaOpts"
+  - "JavaBuildpack::Framework::NewRelic"
   - "JavaBuildpack::Framework::PlayAutoReconfiguration"
   - "JavaBuildpack::Framework::PlayJpaPlugin"
   - "JavaBuildpack::Framework::SpringAutoReconfiguration"
diff --git a/config/newrelic.yml b/config/newrelic.yml
@@ -0,0 +1,19 @@
+# Cloud Foundry Java Buildpack
+# Copyright (c) 2013 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.
+
+# Configuration for the New Relic framework
+---
+version: 2.21.+
+repository_root: "http://download.pivotal.io.s3.amazonaws.com/new-relic/lucid/x86_64"
diff --git a/docs/extending-containers.md b/docs/extending-containers.md
@@ -12,6 +12,8 @@ To add a container, the class file must be located in [`lib/java_buildpack/conta
 # @option context [String] :java_home the directory that acts as +JAVA_HOME+
 # @option context [Array<String>] :java_opts an array that Java options can be added to
 # @option context [String] :lib_directory the directory that additional libraries are placed in
+# @option context [Hash] :vcap_application The contents of the +VCAP_APPLICATION+ environment variable
+# @option context [Hash] :vcap_services The contents of the +VCAP_SERVICES+ environment variable
 # @option context [Hash] :configuration the configuration provided by the user
 def initialize(context)
 
diff --git a/docs/extending-frameworks.md b/docs/extending-frameworks.md
@@ -12,6 +12,8 @@ To add a framework, the class file must be located in [`lib/java_buildpack/frame
 # @option context [String] :java_home the directory that acts as +JAVA_HOME+
 # @option context [Array<String>] :java_opts an array that Java options can be added to
 # @option context [String] :lib_directory the directory that additional libraries are placed in
+# @option context [Hash] :vcap_application The contents of the +VCAP_APPLICATION+ environment variable
+# @option context [Hash] :vcap_services The contents of the +VCAP_SERVICES+ environment variable
 # @option context [Hash] :configuration the configuration provided by the user
 def initialize(context)
 
diff --git a/docs/extending-jres.md b/docs/extending-jres.md
@@ -12,6 +12,8 @@ To add a JRE, the class file must be located in [`lib/java_buildpack/jre`][jre_d
 # @option context [String] :java_home the directory that acts as +JAVA_HOME+
 # @option context [Array<String>] :java_opts an array that Java options can be added to
 # @option context [String] :lib_directory the directory that additional libraries are placed in
+# @option context [Hash] :vcap_application The contents of the +VCAP_APPLICATION+ environment variable
+# @option context [Hash] :vcap_services The contents of the +VCAP_SERVICES+ environment variable
 # @option context [Hash] :configuration the configuration provided by the user
 def initialize(context)
 
diff --git a/docs/framework-new-relic.md b/docs/framework-new-relic.md
@@ -0,0 +1,28 @@
+# New Relic Framework
+The New Relic Framework causes an application to be automatically configured to work with a bound [New Relic Service][new_relic].
+
+[new_relic]: https://newrelic.com
+
+<table>
+  <tr>
+    <td><strong>Detection Criterion</strong></td><td>Existence of a single bound New Relic service</td>
+  </tr>
+  <tr>
+    <td><strong>Tags</strong></td><td><tt>new-relic-&lt;version&gt;</tt></td>
+  </tr>
+</table>
+Tags are printed to standard output by the buildpack detect script
+
+## Configuration
+The container can be configured by modifying the [`config/newrelic.yml`][newrelic_yml] file.  The container uses the [`Repository` utility support][util_repositories] and so it supports the [version syntax][version_syntax] defined there.
+
+[newrelic_yml]: ../config/newrelic.yml
+[util_repositories]: util-repositories.md
+[version_syntax]: util-repositories.md#version-syntax-and-ordering
+
+| Name | Description
+| ---- | -----------
+| `repository_root` | The URL of the New Relic repository index ([details][util_repositories]).
+| `version` | The version of New Relic to use. Candidate versions can be found in [this listing][new_relic_index_yml].
+
+[new_relic_index_yml]: http://download.pivotal.io.s3.amazonaws.com/new-relic/lucid/x86_64/index.yml
diff --git a/docs/util-repository-builders.md b/docs/util-repository-builders.md
@@ -7,6 +7,7 @@ The repositories that are currently referenced by the buildpack are easily repli
 | Auto Reconfiguration | <https://github.com/cloudfoundry/builder-auto-reconfiguration>
 | Groovy | <https://github.com/cloudfoundry/builder-groovy>
 | MySQL JDBC | <https://github.com/cloudfoundry/builder-mysql-jdbc>
+| New Relic | <https://github.com/cloudfoundry/builder-new-relic>
 | OpenJDK | <https://github.com/cloudfoundry/builder-openjdk>
 | PostgreSQL JDBC | <https://github.com/cloudfoundry/builder-postgresql-jdbc>
 | Spring Boot CLI | <https://github.com/cloudfoundry/builder-spring-boot-cli>
diff --git a/lib/java_buildpack/buildpack.rb b/lib/java_buildpack/buildpack.rb
@@ -119,18 +119,20 @@ def initialize(app_dir)
       java_home = ''
       java_opts = []
       @lib_directory = Buildpack.lib_directory app_dir
+      vcap_application = ENV['VCAP_APPLICATION']
+      vcap_services = ENV['VCAP_SERVICES']
 
       basic_context = {
           app_dir: app_dir,
           java_home: java_home,
           java_opts: java_opts,
-          lib_directory: @lib_directory
+          lib_directory: @lib_directory,
+          vcap_application: vcap_application ? YAML.load(vcap_application) : {},
+          vcap_services: vcap_services ? YAML.load(vcap_services) : {}
       }
 
       @jres = Buildpack.construct_components(components, 'jres', basic_context, @logger)
-
       @frameworks = Buildpack.construct_components(components, 'frameworks', basic_context, @logger)
-
       @containers = Buildpack.construct_components(components, 'containers', basic_context, @logger)
     end
 
diff --git a/lib/java_buildpack/container/groovy.rb b/lib/java_buildpack/container/groovy.rb
@@ -115,7 +115,7 @@ def expand(file, configuration)
       def self.find_groovy(app_dir, configuration)
         if main_groovy app_dir
           version, uri = JavaBuildpack::Repository::ConfiguredItem.find_item(configuration) do |candidate_version|
-            raise "Malformed Groovy version #{candidate_version}: too many version components" if candidate_version[3]
+            fail "Malformed Groovy version #{candidate_version}: too many version components" if candidate_version[3]
           end
         else
           version = nil
diff --git a/lib/java_buildpack/container/tomcat.rb b/lib/java_buildpack/container/tomcat.rb
@@ -127,7 +127,7 @@ def expand(file, configuration)
       def self.find_tomcat(app_dir, configuration)
         if web_inf? app_dir
           version, uri = JavaBuildpack::Repository::ConfiguredItem.find_item(configuration) do |candidate_version|
-            raise "Malformed Tomcat version #{candidate_version}: too many version components" if candidate_version[3]
+            fail "Malformed Tomcat version #{candidate_version}: too many version components" if candidate_version[3]
           end
         else
           version = nil
diff --git a/lib/java_buildpack/diagnostics/logger_factory.rb b/lib/java_buildpack/diagnostics/logger_factory.rb
@@ -15,10 +15,11 @@
 # limitations under the License.
 
 require 'fileutils'
-require 'logger'
-require 'monitor'
 require 'java_buildpack/diagnostics'
 require 'java_buildpack/diagnostics/common'
+require 'logger'
+require 'monitor'
+require 'yaml'
 
 module JavaBuildpack::Diagnostics
 
diff --git a/lib/java_buildpack/framework/new_relic.rb b/lib/java_buildpack/framework/new_relic.rb
@@ -0,0 +1,126 @@
+# Encoding: utf-8
+# Cloud Foundry Java Buildpack
+# Copyright 2013 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 'java_buildpack/framework'
+require 'java_buildpack/repository/configured_item'
+require 'java_buildpack/util/download'
+
+module JavaBuildpack::Framework
+
+  # Encapsulates the detect, compile, and release functionality for enabling New Relic auto configuration.
+  class NewRelic
+
+    # Creates an instance, passing in an arbitrary collection of options.
+    #
+    # @param [Hash] context the context that is provided to the instance
+    # @option context [String] :app_dir the directory that the application exists in
+    # @option context [Array<String>] :java_opts an array that Java options can be added to
+    # @option context [Hash] :vcap_application The contents of the +VCAP_APPLICATION+ environment variable
+    # @option context [Hash] :vcap_services The contents of the +VCAP_SERVICES+ environment variable
+    # @option context [Hash] :configuration the properties provided by the user
+    def initialize(context = {})
+      @app_dir = context[:app_dir]
+      @java_opts = context[:java_opts]
+      @vcap_application = context[:vcap_application]
+      @vcap_services = context[:vcap_services]
+      @configuration = context[:configuration]
+      @version, @uri = NewRelic.find_new_relic_agent(@vcap_services, @configuration)
+    end
+
+    # Detects whether this application is suitable for New Relic
+    #
+    # @return [String] returns +new-relic-<version>+ if the application is a candidate for  New Relic otherwise returns
+    #                  +nil+
+    def detect
+      @version ? id(@version) : nil
+    end
+
+    # Downloads the Auto-reconfiguration JAR
+    #
+    # @return [void]
+    def compile
+      system "rm -rf #{new_relic_home}"
+      system "mkdir -p #{new_relic_home}"
+      system "mkdir -p #{File.join new_relic_home, 'logs'}"
+
+      JavaBuildpack::Util.download(@version, @uri, 'New Relic Agent', jar_name(@version), new_relic_home)
+      copy_resources new_relic_home
+    end
+
+    # Adds configuration information to +JAVA_OPTS+
+    #
+    # @return [void]
+    def release
+      @java_opts << "-javaagent:#{File.join NEW_RELIC_HOME, jar_name(@version)}"
+      @java_opts << "-Dnewrelic.home=#{NEW_RELIC_HOME}"
+      @java_opts << "-Dnewrelic.config.license_key=#{NewRelic.license_key @vcap_services}"
+      @java_opts << "-Dnewrelic.config.app_name='#{@vcap_application[NAME_KEY]}'"
+      @java_opts << "-Dnewrelic.config.log_file_path=#{File.join NEW_RELIC_HOME, 'logs'}"
+    end
+
+    private
+
+      NAME_KEY = 'application_name'
+
+      RESOURCES = File.join('..', '..', '..', 'resources', 'new-relic').freeze
+
+      NEW_RELIC_HOME = '.new-relic'.freeze
+
+      def copy_resources(new_relic_home)
+        resources = File.expand_path(RESOURCES, File.dirname(__FILE__))
+        system "cp -r #{File.join resources, '*'} #{new_relic_home}"
+      end
+
+      def self.find_new_relic_agent(vcap_services, configuration)
+        if license_key(vcap_services)
+          version, uri = JavaBuildpack::Repository::ConfiguredItem.find_item(configuration)
+        else
+          version = nil
+          uri = nil
+        end
+
+        return version, uri # rubocop:disable RedundantReturn
+      end
+
+      def id(version)
+        "new-relic-#{version}"
+      end
+
+      def jar_name(version)
+        "#{id version}.jar"
+      end
+
+      def self.license_key(vcap_services)
+        license_key = nil
+
+        type = vcap_services.keys.find { |key| key =~ /newrelic/ }
+        if type
+          services = vcap_services[type]
+          fail "Only one New Relic service can be bound.  Found '#{services.length}'" if services.length != 1
+
+          license_key = services[0]['credentials']['licenseKey']
+        end
+
+        return license_key
+      end
+
+      def new_relic_home
+        File.join @app_dir, NEW_RELIC_HOME
+      end
+
+  end
+
+end
diff --git a/lib/java_buildpack/framework/spring_auto_reconfiguration/web_xml_modifier.rb b/lib/java_buildpack/framework/spring_auto_reconfiguration/web_xml_modifier.rb
@@ -103,7 +103,7 @@ def augment_context_config_locations(root, param_type, default_location)
         locations = locations_string.value.strip.split(/[,;\s]+/)
         locations << additional_context_config_location(root, param_type)
 
-        locations_string.value = locations.join(' ')
+        locations_string.value = locations.join(' ') # rubocop:disable UselessAssignment
       end
 
       def augment_context_initializer_classes(root, param_type)
@@ -113,7 +113,7 @@ def augment_context_initializer_classes(root, param_type)
         classes = classes_string.value.strip.split(/[,;\s]+/)
         classes << CONTEXT_INITIALIZER_ADDITIONAL
 
-        classes_string.value = classes.join(',')
+        classes_string.value = classes.join(',') # rubocop:disable UselessAssignment
       end
 
       def create_param(root, param_type, name, value)
diff --git a/lib/java_buildpack/repository/repository_index.rb b/lib/java_buildpack/repository/repository_index.rb
@@ -17,6 +17,7 @@
 require 'java_buildpack/repository'
 require 'java_buildpack/util/download_cache'
 require 'java_buildpack/repository/version_resolver'
+require 'yaml'
 
 module JavaBuildpack::Repository
 
diff --git a/resources/new-relic/newrelic.yml b/resources/new-relic/newrelic.yml
diff --git a/spec/fixtures/stub-new-relic.jar b/spec/fixtures/stub-new-relic.jar
diff --git a/spec/java_buildpack/framework/java_opts_spec.rb b/spec/java_buildpack/framework/java_opts_spec.rb
diff --git a/spec/java_buildpack/framework/new_relic_spec.rb b/spec/java_buildpack/framework/new_relic_spec.rb
