Polish

Polish metrics export feature added in 6f4d3f4

Closes gh-96

CHANGELOG.adoc

@@ -7,6 +7,7 @@ order.
 
 === Release 1.0.0 (In progress)
 
+* https://github.com/spring-io/initializr/issues/96[#96]: export service metrics to redis
 * https://github.com/spring-io/initializr/issues/115[#115]: rename /metadata/service to /metadata/config
 * https://github.com/spring-io/initializr/issues/89[#89]: better describe service capability
 * https://github.com/spring-io/initializr/issues/105[#105]: support for dependencies group defaults

initializr-service/application-cloud.yml

@@ -0,0 +1,3 @@
+spring:
+  metrics:
+    export: enabled

initializr-service/manifest.yml

@@ -6,3 +6,5 @@ applications:
   host: start-development
   domain: cfapps.io
   path: .
+  services:
+    start-redis

initializr/pom.xml

@@ -25,12 +25,12 @@
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-redis</artifactId>
+			<artifactId>spring-boot-starter-groovy-templates</artifactId>
-			<optional>true</optional>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-groovy-templates</artifactId>
+			<artifactId>spring-boot-starter-redis</artifactId>
+			<optional>true</optional>
 		</dependency>
 		<dependency>
 			<groupId>com.fasterxml.jackson.core</groupId>

initializr/src/main/groovy/io/spring/initializr/config/InitializrMetricsExporterAutoConfiguration.groovy

@@ -39,15 +39,19 @@ import org.springframework.scheduling.annotation.Scheduled
 import org.springframework.util.ObjectUtils
 
 /**
- * @author Dave Syer
+ * {@link org.springframework.boot.autoconfigure.EnableAutoConfiguration
+ * Auto-configuration} to export the metrics of an initializr instnace.
  *
+ * @author Dave Syer
+ * @since 1.0
  */
 @Configuration
 @ConditionalOnBean(RedisConnectionFactory)
-@ConditionalOnProperty(value='spring.metrics.export.enabled', matchIfMissing=true)
+@ConditionalOnProperty(value = 'spring.metrics.export.enabled')
 @EnableScheduling
 @EnableConfigurationProperties(MetricsProperties)
-@AutoConfigureAfter(value=RedisAutoConfiguration, name="org.springframework.boot.actuate.autoconfigure.MetricExportAutoConfiguration")
+@AutoConfigureAfter(value = RedisAutoConfiguration,
+		name = "org.springframework.boot.actuate.autoconfigure.MetricExportAutoConfiguration")
 class InitializrMetricsExporterAutoConfiguration {
 
 	@Autowired

initializr/src/main/groovy/io/spring/initializr/config/MetricsProperties.groovy

@@ -16,12 +16,14 @@
 
 package io.spring.initializr.config
 
-import org.springframework.beans.factory.annotation.Value;
+import org.springframework.beans.factory.annotation.Value
-import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.ConfigurationProperties
 
 /**
- * @author Dave Syer
+ * Metrics-related configuration.
  *
+ * @author Dave Syer
+ * @since 1.0
  */
 @ConfigurationProperties('initializr.metrics')
 class MetricsProperties {
@@ -51,10 +53,6 @@ class MetricsProperties {
 	@Value('${spring.metrics.export.default.delayMillis:5000}')
 	long rateMillis = 5000L
 
-	boolean isEnabled() {
-		rateMillis > 0
-	}
-
 	String getPrefix() {
 		if (prefix.endsWith('.')) {
 			return prefix

initializr/src/main/groovy/io/spring/initializr/metadata/InitializrProperties.groovy

@@ -20,15 +20,13 @@ import com.fasterxml.jackson.annotation.JsonIgnore
 
 import org.springframework.boot.context.properties.ConfigurationProperties
 
-import com.fasterxml.jackson.annotation.JsonIgnoreProperties
-
 /**
  * Configuration of the initializr service.
  *
  * @author Stephane Nicoll
  * @since 1.0
  */
-@ConfigurationProperties(prefix = 'initializr', ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = 'initializr')
 class InitializrProperties extends InitializrConfiguration {
 
 	@JsonIgnore

initializr/src/test/groovy/io/spring/initializr/metrics/MetricsExportTests.groovy

@@ -14,21 +14,19 @@
  * limitations under the License.
  */
 
-package io.spring.initializr.metrics;
+package io.spring.initializr.metrics
 
-import static org.junit.Assert.*
 import io.spring.initializr.generator.ProjectGenerationMetricsListener
 import io.spring.initializr.generator.ProjectRequest
-import io.spring.initializr.metadata.DefaultMetadataElement
 import io.spring.initializr.metadata.InitializrMetadata
 import io.spring.initializr.metadata.InitializrMetadataProvider
-import io.spring.initializr.support.DefaultInitializrMetadataProvider
+import io.spring.initializr.test.OfflineInitializrMetadataProvider
 import io.spring.initializr.test.RedisRunning
-
+import org.junit.Before
-import org.junit.Before;
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
+
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Qualifier
 import org.springframework.boot.actuate.metrics.repository.redis.RedisMetricRepository
@@ -39,13 +37,16 @@ import org.springframework.boot.test.SpringApplicationConfiguration
 import org.springframework.context.annotation.Bean
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner
 
+import static org.junit.Assert.assertTrue
+
 /**
  * @author Dave Syer
- *
  */
 @RunWith(SpringJUnit4ClassRunner)
 @SpringApplicationConfiguration(classes = Config)
-@IntegrationTest(['spring.metrics.export.default.delayMillis:500','initializr.metrics.prefix:test.prefix','initializr.metrics.key:key.test'])
+@IntegrationTest(['spring.metrics.export.default.delayMillis:500',
+		'spring.metrics.export.enabled:true',
+		'initializr.metrics.prefix:test.prefix', 'initializr.metrics.key:key.test'])
 public class MetricsExportTests {
 
 	@Rule
@@ -81,12 +82,7 @@ public class MetricsExportTests {
 
 		@Bean
 		InitializrMetadataProvider initializrMetadataProvider(InitializrMetadata metadata) {
-			new DefaultInitializrMetadataProvider(metadata) {
+			new OfflineInitializrMetadataProvider(metadata)
-						@Override
-						protected List<DefaultMetadataElement> fetchBootVersions() {
-							null // Disable metadata fetching from spring.io
-						}
-					}
 		}
 	}
 }

initializr/src/test/groovy/io/spring/initializr/test/OfflineInitializrMetadataProvider.groovy

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-2015 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.
+ */
+
+package io.spring.initializr.test
+
+import io.spring.initializr.metadata.DefaultMetadataElement
+import io.spring.initializr.metadata.InitializrMetadata
+import io.spring.initializr.support.DefaultInitializrMetadataProvider
+
+/**
+ * A {@link DefaultInitializrMetadataProvider} that does not attempt to
+ * use the network to refresh its configuration.
+ *
+ * @author Stephane Nicoll
+ * @since 1.0
+ */
+class OfflineInitializrMetadataProvider extends DefaultInitializrMetadataProvider {
+
+	OfflineInitializrMetadataProvider(InitializrMetadata metadata) {
+		super(metadata)
+	}
+
+	@Override
+	protected List<DefaultMetadataElement> fetchBootVersions() {
+		null // Disable metadata fetching from spring.io
+	}
+}

initializr/src/test/groovy/io/spring/initializr/test/RedisRunning.groovy

@@ -20,11 +20,14 @@ import org.junit.Assume
 import org.junit.rules.TestWatcher
 import org.junit.runner.Description
 import org.junit.runners.model.Statement
+
 import org.springframework.data.redis.connection.jedis.JedisConnectionFactory
 
 /**
- * @author Dave Syer
+ * A {@link org.junit.rules.TestRule} that validates Redis is available.
  *
+ * @author Dave Syer
+ * @since 1.0
  */
 class RedisRunning extends TestWatcher {
 

initializr/src/test/groovy/io/spring/initializr/web/AbstractInitializrControllerIntegrationTests.groovy

@@ -19,10 +19,9 @@ package io.spring.initializr.web
 import java.nio.charset.Charset
 
 import io.spring.initializr.mapper.InitializrMetadataVersion
-import io.spring.initializr.metadata.DefaultMetadataElement
 import io.spring.initializr.metadata.InitializrMetadata
-import io.spring.initializr.support.DefaultInitializrMetadataProvider
 import io.spring.initializr.metadata.InitializrMetadataProvider
+import io.spring.initializr.test.OfflineInitializrMetadataProvider
 import io.spring.initializr.test.ProjectAssert
 import org.json.JSONObject
 import org.junit.Rule
@@ -217,12 +216,7 @@ abstract class AbstractInitializrControllerIntegrationTests {
 
 		@Bean
 		InitializrMetadataProvider initializrMetadataProvider(InitializrMetadata metadata) {
-			new DefaultInitializrMetadataProvider(metadata) {
+			new OfflineInitializrMetadataProvider(metadata)
-				@Override
-				protected List<DefaultMetadataElement> fetchBootVersions() {
-					null // Disable metadata fetching from spring.io
-				}
-			}
 		}
 
 	}