Provide extra configuration to New Relic

Christopher Frost · Christopher Frost · commit ce37f5ec0fe6 · 2015-07-08T16:23:10.000+01:00
This commit allows additional configuration values to be specified on New Relic through the Credentials payload of the bound New Relic service. This also includes the ability to provide an application name in place of the default provided by Cloud Foundry. All configuration names follow those defined by New Relic. [#92119348] [resolves cloudfoundry#173]
diff --git a/docs/framework-new_relic_agent.md b/docs/framework-new_relic_agent.md
@@ -23,7 +23,9 @@ The credential payload of the service may contain the following entries:
 
 | Name | Description
 | ---- | -----------
-| `licenseKey` | The license key to use when authenticating
+| `license_key` | (Optional) Either this credential or `licenseKey` must be provided. If both are provided then the value for `license_key` will always win. The license key to use when authenticating.
+| `licenseKey` | (Optional) As above.
+| `***` | (Optional) Any additional entries will be applied as a system property appended to `-Dnewrelic.config.` to allow full configuration of the agent.
 
 ## Configuration
 For general information on configuring the buildpack, refer to [Configuration and Extension][].
diff --git a/lib/java_buildpack/framework/new_relic_agent.rb b/lib/java_buildpack/framework/new_relic_agent.rb
@@ -26,45 +26,58 @@ class NewRelicAgent < JavaBuildpack::Component::VersionedDependencyComponent
 
       # (see JavaBuildpack::Component::BaseComponent#compile)
       def compile
-        FileUtils.mkdir_p logs_dir
         download_jar
         @droplet.copy_resources
       end
 
       # (see JavaBuildpack::Component::BaseComponent#release)
       def release
-        @droplet.java_opts
-          .add_javaagent(@droplet.sandbox + jar_name)
-          .add_system_property('newrelic.home', @droplet.sandbox)
-          .add_system_property('newrelic.config.license_key', license_key)
-          .add_system_property('newrelic.config.app_name', "#{application_name}")
-          .add_system_property('newrelic.config.log_file_path', logs_dir)
-        @droplet.java_opts.add_system_property('newrelic.enable.java.8', 'true') if @droplet.java_home.java_8_or_later?
+        credentials = @application.services.find_service(FILTER)['credentials']
+        java_opts   = @droplet.java_opts
+        configuration = {}
+
+        apply_configuration(credentials, configuration)
+        apply_user_configuration(credentials, configuration)
+        write_java_opts(java_opts, configuration)
+
+        java_opts.add_javaagent(@droplet.sandbox + jar_name)
+                 .add_system_property('newrelic.home', @droplet.sandbox)
+        java_opts.add_system_property('newrelic.enable.java.8', 'true') if @droplet.java_home.java_8_or_later?
       end
 
       protected
 
       # (see JavaBuildpack::Component::VersionedDependencyComponent#supports?)
       def supports?
-        @application.services.one_service? FILTER, 'licenseKey'
+        @application.services.one_service? FILTER, [LICENSE_KEY, LICENSE_KEY_USER]
       end
 
       private
 
       FILTER = /newrelic/.freeze
 
-      private_constant :FILTER
+      LICENSE_KEY = 'licenseKey'.freeze
+
+      LICENSE_KEY_USER = 'license_key'.freeze
+
+      private_constant :FILTER, :LICENSE_KEY, :LICENSE_KEY_USER
 
-      def application_name
-        @application.details['application_name']
+      def apply_configuration(credentials, configuration)
+        configuration['log_file_name'] = 'STDOUT'
+        configuration[LICENSE_KEY_USER] = credentials[LICENSE_KEY]
+        configuration['app_name'] = @application.details['application_name']
       end
 
-      def license_key
-        @application.services.find_service(FILTER)['credentials']['licenseKey']
+      def apply_user_configuration(credentials, configuration)
+        credentials.each do |key, value|
+          configuration[key] = value
+        end
       end
 
-      def logs_dir
-        @droplet.sandbox + 'logs'
+      def write_java_opts(java_opts, configuration)
+        configuration.each do |key, value|
+          java_opts.add_system_property("newrelic.config.#{key}", value)
+        end
       end
 
     end
diff --git a/spec/java_buildpack/framework/new_relic_agent_spec.rb b/spec/java_buildpack/framework/new_relic_agent_spec.rb
@@ -29,7 +29,7 @@
   context do
 
     before do
-      allow(services).to receive(:one_service?).with(/newrelic/, 'licenseKey').and_return(true)
+      allow(services).to receive(:one_service?).with(/newrelic/, %w(licenseKey license_key)).and_return(true)
     end
 
     it 'detects with newrelic-n/a service' do
@@ -62,7 +62,21 @@
       expect(java_opts).to include('-Dnewrelic.home=$PWD/.java-buildpack/new_relic_agent')
       expect(java_opts).to include('-Dnewrelic.config.license_key=test-license-key')
       expect(java_opts).to include('-Dnewrelic.config.app_name=test-application-name')
-      expect(java_opts).to include('-Dnewrelic.config.log_file_path=$PWD/.java-buildpack/new_relic_agent/logs')
+      expect(java_opts).to include('-Dnewrelic.config.log_file_name=STDOUT')
+    end
+
+    it 'updates JAVA_OPTS with additional options' do
+      allow(services).to receive(:find_service).and_return('credentials' => { 'licenseKey' => 'test-license-key',
+                                                                              'license_key' => 'different-license-key',
+                                                                              'app_name' => 'different-name',
+                                                                              'foo' => 'bar' })
+      allow(java_home).to receive(:java_8_or_later?).and_return(JavaBuildpack::Util::TokenizedVersion.new('1.7.0_u10'))
+
+      component.release
+
+      expect(java_opts).to include('-Dnewrelic.config.license_key=different-license-key')
+      expect(java_opts).to include('-Dnewrelic.config.app_name=different-name')
+      expect(java_opts).to include('-Dnewrelic.config.foo=bar')
     end
 
     it 'updates JAVA_OPTS on Java 8' do
