Add startup time metrics

See gh-27878

Author: onobc

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

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2012-2021 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
+ *
+ *      https://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 org.springframework.boot.actuate.autoconfigure.metrics.startup;
+
+import io.micrometer.core.instrument.MeterRegistry;
+
+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.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * {@link EnableAutoConfiguration Auto-configuration} for the {@link StartupTimeMetrics}.
+ *
+ * @author Chris Bono
+ * @since 2.6.0
+ */
+@Configuration(proxyBeanMethods = false)
+@AutoConfigureAfter({ MetricsAutoConfiguration.class, CompositeMeterRegistryAutoConfiguration.class })
+@ConditionalOnClass(MeterRegistry.class)
+@ConditionalOnBean(MeterRegistry.class)
+public class StartupTimeMetricsAutoConfiguration {
+
+	@Bean
+	@ConditionalOnMissingBean
+	StartupTimeMetrics startupTimeMetrics(MeterRegistry meterRegistry) {
+		return new StartupTimeMetrics(meterRegistry);
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/startup/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2012-2021 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
+ *
+ *      https://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.
+ */
+
+/**
+ * Auto-configuration for actuator startup time metrics.
+ */
+package org.springframework.boot.actuate.autoconfigure.metrics.startup;

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

@@ -75,6 +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.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

@@ -0,0 +1,92 @@
+/*
+ * Copyright 2012-2021 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
+ *
+ *      https://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 org.springframework.boot.actuate.autoconfigure.metrics.startup;
+
+import java.time.Duration;
+
+import io.micrometer.core.instrument.Tags;
+import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
+import org.junit.jupiter.api.Test;
+
+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.autoconfigure.AutoConfigurations;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.boot.context.event.ApplicationStartedEvent;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link StartupTimeMetricsAutoConfiguration}.
+ *
+ * @author Chris Bono
+ */
+class StartupTimeMetricsAutoConfigurationTests {
+
+	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner().with(MetricsRun.simple())
+			.withConfiguration(AutoConfigurations.of(StartupTimeMetricsAutoConfiguration.class));
+
+	@Test
+	void startupTimeMetricsAreRecorded() {
+		this.contextRunner.run((context) -> {
+			context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
+					context.getSourceApplicationContext(), Duration.ofMillis(2500)));
+			context.publishEvent(new ApplicationReadyEvent(new SpringApplication(), null,
+					context.getSourceApplicationContext(), Duration.ofMillis(3000)));
+			assertThat(context).hasSingleBean(StartupTimeMetrics.class);
+			SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
+			assertThat(registry.find("application.started.time").timeGauge()).isNotNull();
+			assertThat(registry.find("application.ready.time").timeGauge()).isNotNull();
+		});
+	}
+
+	@Test
+	void startupTimeMetricsCanBeDisabled() {
+		this.contextRunner.withPropertyValues("management.metrics.enable.application.started.time:false",
+				"management.metrics.enable.application.ready.time:false").run((context) -> {
+					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
+							context.getSourceApplicationContext(), Duration.ofMillis(2500)));
+					context.publishEvent(new ApplicationReadyEvent(new SpringApplication(), null,
+							context.getSourceApplicationContext(), Duration.ofMillis(3000)));
+					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
+					assertThat(registry.find("application.started.time").timeGauge()).isNull();
+					assertThat(registry.find("application.ready.time").timeGauge()).isNull();
+				});
+	}
+
+	@Test
+	void customStartupTimeMetricsAreRespected() {
+		this.contextRunner.withUserConfiguration(CustomStartupTimeMetricsConfiguration.class)
+				.run((context) -> assertThat(context).hasSingleBean(StartupTimeMetrics.class)
+						.hasBean("customStartTimeMetrics"));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	static class CustomStartupTimeMetricsConfiguration {
+
+		@Bean
+		StartupTimeMetrics customStartTimeMetrics() {
+			return new StartupTimeMetrics(new SimpleMeterRegistry(), Tags.empty(), "myapp.started", "myapp.ready");
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/jetty/JettyMetricsAutoConfigurationTests.java

@@ -16,6 +16,8 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics.web.jetty;
 
+import java.time.Duration;
+
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tags;
 import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
@@ -58,7 +60,7 @@ void autoConfiguresThreadPoolMetricsWithEmbeddedServletJetty() {
 				.withUserConfiguration(ServletWebServerConfiguration.class, MeterRegistryConfiguration.class)
 				.run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					assertThat(context).hasSingleBean(JettyServerThreadPoolMetricsBinder.class);
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 					assertThat(registry.find("jetty.threads.config.min").meter()).isNotNull();
@@ -73,7 +75,7 @@ void autoConfiguresThreadPoolMetricsWithEmbeddedReactiveJetty() {
 				.withUserConfiguration(ReactiveWebServerConfiguration.class, MeterRegistryConfiguration.class)
 				.run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 					assertThat(registry.find("jetty.threads.config.min").meter()).isNotNull();
 				});
@@ -95,7 +97,7 @@ void autoConfiguresConnectionMetricsWithEmbeddedServletJetty() {
 				.withUserConfiguration(ServletWebServerConfiguration.class, MeterRegistryConfiguration.class)
 				.run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					assertThat(context).hasSingleBean(JettyConnectionMetricsBinder.class);
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 					assertThat(registry.find("jetty.connections.messages.in").meter()).isNotNull();
@@ -110,7 +112,7 @@ void autoConfiguresConnectionMetricsWithEmbeddedReactiveJetty() {
 				.withUserConfiguration(ReactiveWebServerConfiguration.class, MeterRegistryConfiguration.class)
 				.run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 					assertThat(registry.find("jetty.connections.messages.in").meter()).isNotNull();
 				});
@@ -125,7 +127,7 @@ void allowsCustomJettyConnectionMetricsBinderToBeUsed() {
 						MeterRegistryConfiguration.class)
 				.run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					assertThat(context).hasSingleBean(JettyConnectionMetricsBinder.class)
 							.hasBean("customJettyConnectionMetricsBinder");
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
@@ -144,7 +146,7 @@ void autoConfiguresSslHandshakeMetricsWithEmbeddedServletJetty() {
 						"server.ssl.key-store-password: secret", "server.ssl.key-password: password")
 				.run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					assertThat(context).hasSingleBean(JettySslHandshakeMetricsBinder.class);
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 					assertThat(registry.find("jetty.ssl.handshakes").meter()).isNotNull();
@@ -161,7 +163,7 @@ void autoConfiguresSslHandshakeMetricsWithEmbeddedReactiveJetty() {
 						"server.ssl.key-store-password: secret", "server.ssl.key-password: password")
 				.run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 					assertThat(registry.find("jetty.ssl.handshakes").meter()).isNotNull();
 				});
@@ -178,7 +180,7 @@ void allowsCustomJettySslHandshakeMetricsBinderToBeUsed() {
 						"server.ssl.key-store-password: secret", "server.ssl.key-password: password")
 				.run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					assertThat(context).hasSingleBean(JettySslHandshakeMetricsBinder.class)
 							.hasBean("customJettySslHandshakeMetricsBinder");
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/tomcat/TomcatMetricsAutoConfigurationTests.java

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics.web.tomcat;
 
+import java.time.Duration;
 import java.util.Collections;
 import java.util.concurrent.atomic.AtomicInteger;
 
@@ -62,7 +63,7 @@ void autoConfiguresTomcatMetricsWithEmbeddedServletTomcat() {
 				.withUserConfiguration(ServletWebServerConfiguration.class, MeterRegistryConfiguration.class)
 				.withPropertyValues("server.tomcat.mbeanregistry.enabled=true").run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					assertThat(context).hasSingleBean(TomcatMetricsBinder.class);
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 					assertThat(registry.find("tomcat.sessions.active.max").meter()).isNotNull();
@@ -79,7 +80,7 @@ void autoConfiguresTomcatMetricsWithEmbeddedReactiveTomcat() {
 				.withUserConfiguration(ReactiveWebServerConfiguration.class, MeterRegistryConfiguration.class)
 				.withPropertyValues("server.tomcat.mbeanregistry.enabled=true").run((context) -> {
 					context.publishEvent(new ApplicationStartedEvent(new SpringApplication(), null,
-							context.getSourceApplicationContext()));
+							context.getSourceApplicationContext(), Duration.ZERO));
 					SimpleMeterRegistry registry = context.getBean(SimpleMeterRegistry.class);
 					assertThat(registry.find("tomcat.sessions.active.max").meter()).isNotNull();
 					assertThat(registry.find("tomcat.threads.current").meter()).isNotNull();

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

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2012-2021 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
+ *
+ *      https://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 org.springframework.boot.actuate.metrics.startup;
+
+import java.util.Collections;
+import java.util.concurrent.TimeUnit;
+
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Tag;
+import io.micrometer.core.instrument.Tags;
+import io.micrometer.core.instrument.TimeGauge;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.boot.context.event.ApplicationStartedEvent;
+import org.springframework.context.ApplicationEvent;
+import org.springframework.context.event.SmartApplicationListener;
+
+/**
+ * Binds application startup metrics in response to {@link ApplicationStartedEvent} and
+ * {@link ApplicationReadyEvent}.
+ *
+ * @author Chris Bono
+ * @since 2.6.0
+ */
+public class StartupTimeMetrics implements SmartApplicationListener {
+
+	private final MeterRegistry meterRegistry;
+
+	private final String applicationStartedTimeMetricName;
+
+	private final String applicationReadyTimeMetricName;
+
+	private final Iterable<Tag> tags;
+
+	public StartupTimeMetrics(MeterRegistry meterRegistry) {
+		this(meterRegistry, Collections.emptyList(), "application.started.time", "application.ready.time");
+	}
+
+	public StartupTimeMetrics(MeterRegistry meterRegistry, Iterable<Tag> tags, String applicationStartedTimeMetricName,
+			String applicationReadyTimeMetricName) {
+		this.meterRegistry = meterRegistry;
+		this.tags = (tags != null) ? tags : Collections.emptyList();
+		this.applicationStartedTimeMetricName = applicationStartedTimeMetricName;
+		this.applicationReadyTimeMetricName = applicationReadyTimeMetricName;
+	}
+
+	@Override
+	public boolean supportsEventType(Class<? extends ApplicationEvent> eventType) {
+		return ApplicationStartedEvent.class.isAssignableFrom(eventType)
+				|| ApplicationReadyEvent.class.isAssignableFrom(eventType);
+	}
+
+	@Override
+	public void onApplicationEvent(ApplicationEvent event) {
+		if (event instanceof ApplicationStartedEvent) {
+			onApplicationStarted((ApplicationStartedEvent) event);
+		}
+		if (event instanceof ApplicationReadyEvent) {
+			onApplicationReady((ApplicationReadyEvent) event);
+		}
+	}
+
+	private void onApplicationStarted(ApplicationStartedEvent event) {
+		if (event.getStartupTime() == null) {
+			return;
+		}
+		TimeGauge
+				.builder(this.applicationStartedTimeMetricName, () -> event.getStartupTime().toMillis(),
+						TimeUnit.MILLISECONDS)
+				.tags(maybeDcorateTagsWithApplicationInfo(event.getSpringApplication()))
+				.description("Time taken (ms) to start the application").register(this.meterRegistry);
+	}
+
+	private void onApplicationReady(ApplicationReadyEvent event) {
+		if (event.getStartupTime() == null) {
+			return;
+		}
+		TimeGauge
+				.builder(this.applicationReadyTimeMetricName, () -> event.getStartupTime().toMillis(),
+						TimeUnit.MILLISECONDS)
+				.tags(maybeDcorateTagsWithApplicationInfo(event.getSpringApplication()))
+				.description("Time taken (ms) for the application to be ready to serve requests")
+				.register(this.meterRegistry);
+	}
+
+	private Iterable<Tag> maybeDcorateTagsWithApplicationInfo(SpringApplication springApplication) {
+		Class<?> mainClass = springApplication.getMainApplicationClass();
+		if (mainClass == null) {
+			return this.tags;
+		}
+		return Tags.concat(this.tags, "main-application-class", mainClass.getName());
+	}
+
+}