Polish "Add startup time metrics"

See gh-27878

Author: philwebb

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/startup/StartupTimeMetricsAutoConfiguration.java renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/startup/StartupTimeMetricsListenerAutoConfiguration.java

@@ -20,7 +20,7 @@
 
 import org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
-import org.springframework.boot.actuate.metrics.startup.StartupTimeMetrics;
+import org.springframework.boot.actuate.metrics.startup.StartupTimeMetricsListener;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -39,12 +39,12 @@
 @AutoConfigureAfter({ MetricsAutoConfiguration.class, CompositeMeterRegistryAutoConfiguration.class })
 @ConditionalOnClass(MeterRegistry.class)
 @ConditionalOnBean(MeterRegistry.class)
-public class StartupTimeMetricsAutoConfiguration {
+public class StartupTimeMetricsListenerAutoConfiguration {
 
 	@Bean
 	@ConditionalOnMissingBean
-	public StartupTimeMetrics startupTimeMetrics(MeterRegistry meterRegistry) {
-		return new StartupTimeMetrics(meterRegistry);
+	public StartupTimeMetricsListener startupTimeMetrics(MeterRegistry meterRegistry) {
+		return new StartupTimeMetricsListener(meterRegistry);
 	}
 
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -75,7 +75,7 @@ org.springframework.boot.actuate.autoconfigure.metrics.mongo.MongoMetricsAutoCon
 org.springframework.boot.actuate.autoconfigure.metrics.orm.jpa.HibernateMetricsAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.metrics.r2dbc.ConnectionPoolMetricsAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.metrics.redis.LettuceMetricsAutoConfiguration,\
-org.springframework.boot.actuate.autoconfigure.metrics.startup.StartupTimeMetricsAutoConfiguration,\
+org.springframework.boot.actuate.autoconfigure.metrics.startup.StartupTimeMetricsListenerAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.metrics.task.TaskExecutorMetricsAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.metrics.web.client.HttpClientMetricsAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.metrics.web.jetty.JettyMetricsAutoConfiguration,\

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/startup/StartupTimeMetricsAutoConfigurationTests.java renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/startup/StartupTimeMetricsListenerAutoConfigurationTests.java

@@ -25,7 +25,7 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.actuate.autoconfigure.metrics.test.MetricsRun;
-import org.springframework.boot.actuate.metrics.startup.StartupTimeMetrics;
+import org.springframework.boot.actuate.metrics.startup.StartupTimeMetricsListener;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.context.event.ApplicationReadyEvent;
 import org.springframework.boot.context.event.ApplicationStartedEvent;
@@ -35,20 +35,20 @@
 import static org.mockito.Mockito.mock;
 
 /**
- * Tests for {@link StartupTimeMetricsAutoConfiguration}.
+ * Tests for {@link StartupTimeMetricsListenerAutoConfiguration}.
  *
  * @author Chris Bono
  * @author Stephane Nicoll
  */
-class StartupTimeMetricsAutoConfigurationTests {
+class StartupTimeMetricsListenerAutoConfigurationTests {
 
 	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner().with(MetricsRun.simple())
-			.withConfiguration(AutoConfigurations.of(StartupTimeMetricsAutoConfiguration.class));
+			.withConfiguration(AutoConfigurations.of(StartupTimeMetricsListenerAutoConfiguration.class));
 
 	@Test
 	void startupTimeMetricsAreRecorded() {
 		this.contextRunner.run((context) -> {
-			assertThat(context).hasSingleBean(StartupTimeMetrics.class);
+			assertThat(context).hasSingleBean(StartupTimeMetricsListener.class);
 			SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 			context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
 					context.getSourceApplicationContext(), Duration.ofMillis(1500)));
@@ -80,8 +80,9 @@ void startupTimeMetricsCanBeDisabled() {
 	@Test
 	void customStartupTimeMetricsAreRespected() {
 		this.contextRunner
-				.withBean("customStartupTimeMetrics", StartupTimeMetrics.class, () -> mock(StartupTimeMetrics.class))
-				.run((context) -> assertThat(context).hasSingleBean(StartupTimeMetrics.class)
+				.withBean("customStartupTimeMetrics", StartupTimeMetricsListener.class,
+						() -> mock(StartupTimeMetricsListener.class))
+				.run((context) -> assertThat(context).hasSingleBean(StartupTimeMetricsListener.class)
 						.hasBean("customStartupTimeMetrics"));
 	}
 

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetrics.java renamed to spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetricsListener.java

@@ -36,9 +36,10 @@
  * {@link ApplicationReadyEvent}.
  *
  * @author Chris Bono
+ * @author Phillip Webb
  * @since 2.6.0
  */
-public class StartupTimeMetrics implements SmartApplicationListener {
+public class StartupTimeMetricsListener implements SmartApplicationListener {
 
 	/**
 	 * The default name to use for the application started time metric.
@@ -52,38 +53,37 @@ public class StartupTimeMetrics implements SmartApplicationListener {
 
 	private final MeterRegistry meterRegistry;
 
-	private final String applicationStartedTimeMetricName;
+	private final String startedTimeMetricName;
 
-	private final String applicationReadyTimeMetricName;
+	private final String readyTimeMetricName;
 
-	private final Iterable<Tag> tags;
+	private final Tags tags;
 
 	/**
 	 * Create a new instance using default metric names.
 	 * @param meterRegistry the registry to use
 	 * @see #APPLICATION_STARTED_TIME_METRIC_NAME
 	 * @see #APPLICATION_READY_TIME_METRIC_NAME
 	 */
-	public StartupTimeMetrics(MeterRegistry meterRegistry) {
-		this(meterRegistry, Collections.emptyList(), APPLICATION_STARTED_TIME_METRIC_NAME,
-				APPLICATION_READY_TIME_METRIC_NAME);
+	public StartupTimeMetricsListener(MeterRegistry meterRegistry) {
+		this(meterRegistry, APPLICATION_STARTED_TIME_METRIC_NAME, APPLICATION_READY_TIME_METRIC_NAME,
+				Collections.emptyList());
 	}
 
 	/**
 	 * Create a new instance using the specified options.
 	 * @param meterRegistry the registry to use
+	 * @param startedTimeMetricName the name to use for the application started time
+	 * metric
+	 * @param readyTimeMetricName the name to use for the application ready time metric
 	 * @param tags the tags to associate to application startup metrics
-	 * @param applicationStartedTimeMetricName the name to use for the application started
-	 * time metric
-	 * @param applicationReadyTimeMetricName the name to use for the application ready
-	 * time metric
 	 */
-	public StartupTimeMetrics(MeterRegistry meterRegistry, Iterable<Tag> tags, String applicationStartedTimeMetricName,
-			String applicationReadyTimeMetricName) {
+	public StartupTimeMetricsListener(MeterRegistry meterRegistry, String startedTimeMetricName,
+			String readyTimeMetricName, Iterable<Tag> tags) {
 		this.meterRegistry = meterRegistry;
-		this.tags = (tags != null) ? tags : Collections.emptyList();
-		this.applicationStartedTimeMetricName = applicationStartedTimeMetricName;
-		this.applicationReadyTimeMetricName = applicationReadyTimeMetricName;
+		this.startedTimeMetricName = startedTimeMetricName;
+		this.readyTimeMetricName = readyTimeMetricName;
+		this.tags = Tags.of(tags);
 	}
 
 	@Override
@@ -103,33 +103,27 @@ public void onApplicationEvent(ApplicationEvent event) {
 	}
 
 	private void onApplicationStarted(ApplicationStartedEvent event) {
-		if (event.getStartedTime() == null) {
-			return;
-		}
-		registerGauge(this.applicationStartedTimeMetricName, "Time taken (ms) to start the application",
-				event.getStartedTime(), createTagsFrom(event.getSpringApplication()));
+		registerGauge(this.startedTimeMetricName, "Time taken (ms) to start the application", event.getTimeTaken(),
+				event.getSpringApplication());
 	}
 
 	private void onApplicationReady(ApplicationReadyEvent event) {
-		if (event.getReadyTime() == null) {
-			return;
-		}
-		registerGauge(this.applicationReadyTimeMetricName,
-				"Time taken (ms) for the application to be ready to service requests", event.getReadyTime(),
-				createTagsFrom(event.getSpringApplication()));
+		registerGauge(this.readyTimeMetricName, "Time taken (ms) for the application to be ready to service requests",
+				event.getTimeTaken(), event.getSpringApplication());
 	}
 
-	private void registerGauge(String metricName, String description, Duration time, Iterable<Tag> tags) {
-		TimeGauge.builder(metricName, time::toMillis, TimeUnit.MILLISECONDS).tags(tags).description(description)
-				.register(this.meterRegistry);
+	private void registerGauge(String name, String description, Duration timeTaken,
+			SpringApplication springApplication) {
+		if (timeTaken != null) {
+			Iterable<Tag> tags = createTagsFrom(springApplication);
+			TimeGauge.builder(name, timeTaken::toMillis, TimeUnit.MILLISECONDS).tags(tags).description(description)
+					.register(this.meterRegistry);
+		}
 	}
 
 	private Iterable<Tag> createTagsFrom(SpringApplication springApplication) {
 		Class<?> mainClass = springApplication.getMainApplicationClass();
-		if (mainClass == null) {
-			return this.tags;
-		}
-		return Tags.concat(this.tags, "main-application-class", mainClass.getName());
+		return (mainClass != null) ? this.tags.and("main-application-class", mainClass.getName()) : this.tags;
 	}
 
 }

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetricsTests.java renamed to spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetricsListenerTests.java

@@ -35,44 +35,44 @@
 import static org.mockito.Mockito.mock;
 
 /**
- * Tests for {@link StartupTimeMetrics}.
+ * Tests for {@link StartupTimeMetricsListener}.
  *
  * @author Chris Bono
  */
-class StartupTimeMetricsTests {
+class StartupTimeMetricsListenerTests {
 
 	private MeterRegistry registry;
 
-	private StartupTimeMetrics metrics;
+	private StartupTimeMetricsListener listener;
 
 	@BeforeEach
 	void setup() {
 		this.registry = new SimpleMeterRegistry();
-		this.metrics = new StartupTimeMetrics(this.registry);
+		this.listener = new StartupTimeMetricsListener(this.registry);
 	}
 
 	@Test
 	void metricsRecordedWithoutCustomTags() {
-		this.metrics.onApplicationEvent(applicationStartedEvent(2000L));
-		this.metrics.onApplicationEvent(applicationReadyEvent(2200L));
+		this.listener.onApplicationEvent(applicationStartedEvent(2000L));
+		this.listener.onApplicationEvent(applicationReadyEvent(2200L));
 		assertMetricExistsWithValue("application.started.time", 2000L);
 		assertMetricExistsWithValue("application.ready.time", 2200L);
 	}
 
 	@Test
 	void metricsRecordedWithCustomTagsAndMetricNames() {
 		Tags tags = Tags.of("foo", "bar");
-		this.metrics = new StartupTimeMetrics(this.registry, tags, "m1", "m2");
-		this.metrics.onApplicationEvent(applicationStartedEvent(1000L));
-		this.metrics.onApplicationEvent(applicationReadyEvent(1050L));
+		this.listener = new StartupTimeMetricsListener(this.registry, "m1", "m2", tags);
+		this.listener.onApplicationEvent(applicationStartedEvent(1000L));
+		this.listener.onApplicationEvent(applicationReadyEvent(1050L));
 		assertMetricExistsWithCustomTagsAndValue("m1", tags, 1000L);
 		assertMetricExistsWithCustomTagsAndValue("m2", tags, 1050L);
 	}
 
 	@Test
 	void metricRecordedWithoutMainAppClassTag() {
 		SpringApplication application = mock(SpringApplication.class);
-		this.metrics.onApplicationEvent(new ApplicationStartedEvent(application, null, null, Duration.ofSeconds(2)));
+		this.listener.onApplicationEvent(new ApplicationStartedEvent(application, null, null, Duration.ofSeconds(2)));
 		TimeGauge applicationStartedGague = this.registry.find("application.started.time").timeGauge();
 		assertThat(applicationStartedGague).isNotNull();
 		assertThat(applicationStartedGague.getId().getTags()).isEmpty();
@@ -82,17 +82,17 @@ void metricRecordedWithoutMainAppClassTag() {
 	void metricRecordedWithoutMainAppClassTagAndAdditionalTags() {
 		SpringApplication application = mock(SpringApplication.class);
 		Tags tags = Tags.of("foo", "bar");
-		this.metrics = new StartupTimeMetrics(this.registry, tags, "started", "ready");
-		this.metrics.onApplicationEvent(new ApplicationReadyEvent(application, null, null, Duration.ofSeconds(2)));
+		this.listener = new StartupTimeMetricsListener(this.registry, "started", "ready", tags);
+		this.listener.onApplicationEvent(new ApplicationReadyEvent(application, null, null, Duration.ofSeconds(2)));
 		TimeGauge applicationReadyGague = this.registry.find("ready").timeGauge();
 		assertThat(applicationReadyGague).isNotNull();
 		assertThat(applicationReadyGague.getId().getTags()).containsExactlyElementsOf(tags);
 	}
 
 	@Test
 	void metricsNotRecordedWhenStartupTimeNotAvailable() {
-		this.metrics.onApplicationEvent(applicationStartedEvent(null));
-		this.metrics.onApplicationEvent(applicationReadyEvent(null));
+		this.listener.onApplicationEvent(applicationStartedEvent(null));
+		this.listener.onApplicationEvent(applicationReadyEvent(null));
 		assertThat(this.registry.find("application.started.time").timeGauge()).isNull();
 		assertThat(this.registry.find("application.ready.time").timeGauge()).isNull();
 	}

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/SpringApplication.java

@@ -78,7 +78,6 @@
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.ReflectionUtils;
-import org.springframework.util.StopWatch;
 import org.springframework.util.StringUtils;
 
 /**
@@ -286,8 +285,7 @@ private Class<?> deduceMainApplicationClass() {
 	 * @return a running {@link ApplicationContext}
 	 */
 	public ConfigurableApplicationContext run(String... args) {
-		StopWatch stopWatch = new StopWatch();
-		stopWatch.start();
+		long startTime = System.nanoTime();
 		DefaultBootstrapContext bootstrapContext = createBootstrapContext();
 		ConfigurableApplicationContext context = null;
 		configureHeadlessProperty();
@@ -303,23 +301,20 @@ public ConfigurableApplicationContext run(String... args) {
 			prepareContext(bootstrapContext, context, environment, listeners, applicationArguments, printedBanner);
 			refreshContext(context);
 			afterRefresh(context, applicationArguments);
-			stopWatch.stop();
-			Duration startedTime = Duration.ofMillis(stopWatch.getTotalTimeMillis());
-			stopWatch.start();
+			Duration timeTakeToStartup = Duration.ofNanos(System.nanoTime() - startTime);
 			if (this.logStartupInfo) {
-				new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), startedTime);
+				new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), timeTakeToStartup);
 			}
-			listeners.started(context, startedTime);
+			listeners.started(context, timeTakeToStartup);
 			callRunners(context, applicationArguments);
 		}
 		catch (Throwable ex) {
 			handleRunFailure(context, ex, listeners);
 			throw new IllegalStateException(ex);
 		}
-
 		try {
-			stopWatch.stop();
-			listeners.running(context, Duration.ofMillis(stopWatch.getTotalTimeMillis()));
+			Duration timeTakenToReady = Duration.ofNanos(System.nanoTime() - startTime);
+			listeners.ready(context, timeTakenToReady);
 		}
 		catch (Throwable ex) {
 			handleRunFailure(context, ex, null);

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/SpringApplicationRunListener.java

@@ -77,53 +77,50 @@ default void contextLoaded(ConfigurableApplicationContext context) {
 	 * {@link CommandLineRunner CommandLineRunners} and {@link ApplicationRunner
 	 * ApplicationRunners} have not been called.
 	 * @param context the application context.
-	 * @since 2.0.0
-	 * @deprecated since 2.6.0 for removal in 2.8.0 in favour of
-	 * {@link #started(ConfigurableApplicationContext, Duration)}
+	 * @param timeTaken the time taken to start the application or {@code null} if unknown
+	 * @since 2.6.0
 	 */
-	@Deprecated
-	default void started(ConfigurableApplicationContext context) {
-		started(context, null);
+	default void started(ConfigurableApplicationContext context, Duration timeTaken) {
+		started(context);
 	}
 
 	/**
 	 * The context has been refreshed and the application has started but
 	 * {@link CommandLineRunner CommandLineRunners} and {@link ApplicationRunner
 	 * ApplicationRunners} have not been called.
 	 * @param context the application context.
-	 * @param startedTime the time taken to start the application or {@code null} if
-	 * unknown
-	 * @since 2.6.0
+	 * @since 2.0.0
+	 * @deprecated since 2.6.0 for removal in 2.8.0 in favor of
+	 * {@link #started(ConfigurableApplicationContext, Duration)}
 	 */
-	default void started(ConfigurableApplicationContext context, Duration startedTime) {
-		started(context);
+	@Deprecated
+	default void started(ConfigurableApplicationContext context) {
 	}
 
 	/**
 	 * Called immediately before the run method finishes, when the application context has
 	 * been refreshed and all {@link CommandLineRunner CommandLineRunners} and
 	 * {@link ApplicationRunner ApplicationRunners} have been called.
 	 * @param context the application context.
-	 * @deprecated since 2.6.0 for removal in 2.8.0 in favour of
-	 * {@link #running(ConfigurableApplicationContext, Duration)}
-	 * @since 2.0.0
+	 * @param timeTaken the time taken for the application to be ready or {@code null} if
+	 * unknown
+	 * @since 2.6.0
 	 */
-	@Deprecated
-	default void running(ConfigurableApplicationContext context) {
-		running(context, null);
+	default void ready(ConfigurableApplicationContext context, Duration timeTaken) {
+		running(context);
 	}
 
 	/**
 	 * Called immediately before the run method finishes, when the application context has
 	 * been refreshed and all {@link CommandLineRunner CommandLineRunners} and
 	 * {@link ApplicationRunner ApplicationRunners} have been called.
 	 * @param context the application context.
-	 * @param readyTime the time taken for the application to be ready to service requests
-	 * or {@code null} if unknown
-	 * @since 2.6.0
+	 * @deprecated since 2.6.0 for removal in 2.8.0 in favor of
+	 * {@link #ready(ConfigurableApplicationContext, Duration)}
+	 * @since 2.0.0
 	 */
-	default void running(ConfigurableApplicationContext context, Duration readyTime) {
-		running(context);
+	@Deprecated
+	default void running(ConfigurableApplicationContext context) {
 	}
 
 	/**