Add Micrometer support for Task applications

- New dependencies
   - micrometer-core
   - java-cfenv - required by the CF tags configuration.
 - Add TaskMetrics configuration that installs two Meters (Timer and LongTaskTimer) that produce the following time-series:
   - spring.cloud.task - shows task duration (updated only after the task has completed).
   - spring.cloud.task.active - provides run time information about the non-completed tasks.
   Both meters are started at TaskExecutionListener#onTaskStartup() and ended at onTaskEnd() or onTaskFailure().
 - Add common Task tags assigned to all time-series produced by the Task (not only the s.c.task and s.c.task.active). This allows to analyze CPU, Memory and other measurements grouped by task/execution ids.
 - Add Cloud Found tags - Activated only for CF target platform.

 Resolves #608
This commit is contained in:
Christian Tzolov
2019-06-26 10:59:35 +02:00
committed by Michael Minella
parent aa29153656
commit d4b51a074b
14 changed files with 959 additions and 2 deletions

View File

@@ -0,0 +1,79 @@
/*
* Copyright 2019-2019 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.cloud.task.configuration;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.cloud.task.metrics.fork.MeterRegistryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
/**
* Micrometer common tags for Cloud Foundry deployment properties. Based on the CF
* application environment variables:
* https://docs.cloudfoundry.org/devguide/deploy-apps/environment-variable.html
*
* Tags are set only if the "cloud" Spring profile is set. The "cloud" profile is
* activated automatically when an application is deployed in CF:
* https://docs.cloudfoundry.org/buildpacks/java/configuring-service-connections/spring-service-bindings.html#cloud-profiles
*
* Use the spring.cloud.task.metrics.cf.tags.enabled=false property to disable inserting
* those tags.
*
* @author Christian Tzolov
*/
@Configuration
@Profile("cloud")
@ConditionalOnProperty(name = "spring.cloud.task.metrics.cf.tags.enabled",
havingValue = "true", matchIfMissing = true)
public class CloudFoundryMicrometerTagsConfiguration {
@Value("${vcap.application.org_name:default}")
private String organizationName;
@Value("${vcap.application.space_id:unknown}")
private String spaceId;
@Value("${vcap.application.space_name:unknown}")
private String spaceName;
@Value("${vcap.application.application_name:unknown}")
private String applicationName;
@Value("${vcap.application.application_id:unknown}")
private String applicationId;
@Value("${vcap.application.application_version:unknown}")
private String applicationVersion;
@Value("${vcap.application.instance_index:0}")
private String instanceIndex;
@Bean
public MeterRegistryCustomizer<MeterRegistry> cloudFoundryMetricsCommonTags() {
return registry -> registry.config().commonTags("cf.org.name", organizationName)
.commonTags("cf.space.id", spaceId).commonTags("cf.space.name", spaceName)
.commonTags("cf.app.id", applicationId)
.commonTags("cf.app.name", applicationName)
.commonTags("cf.app.version", applicationVersion)
.commonTags("cf.instance.index", instanceIndex);
}
}

View File

@@ -0,0 +1,63 @@
/*
* Copyright 2019-2019 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.cloud.task.configuration;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.cloud.task.metrics.fork.MeterRegistryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* Auto configuration extends the micrometer metrics with additional tags such as: task
* name, application name, instance index and guids. Later are necessary to allow
* discrimination and aggregation of app metrics by external metrics collection and
* visualizaiton tools.
*
* Use the spring.cloud.task.metrics.common.tags.enabled=false property to disable
* inserting those tags.
*
* @author Christian Tzolov
*/
@Configuration
@ConditionalOnProperty(name = "spring.cloud.task.metrics.common.tags.enabled",
havingValue = "true", matchIfMissing = true)
public class SpringCloudTaskMicrometerCommonTagsConfiguration {
@Value("${spring.cloud.task.name:unknown}")
private String taskName;
@Value("${spring.cloud.task.executionid:unknown}")
private String taskExecutionId;
@Value("${spring.cloud.task.external-execution-id:unknown}")
private String taskExternalExecutionId;
@Value("${spring.cloud.task.parent-execution-id:unknown}")
private String taskParentExecutionId;
@Bean
public MeterRegistryCustomizer<MeterRegistry> metricsCommonTags() {
return registry -> registry.config().commonTags("task.name", taskName)
.commonTags("task.execution.id", taskExecutionId)
.commonTags("task.external.execution.id", taskExternalExecutionId)
.commonTags("task.parent.execution.id", taskParentExecutionId);
}
}

View File

@@ -88,6 +88,8 @@ public class TaskLifecycleListener implements ApplicationListener<ApplicationEve
private final TaskListenerExecutorObjectFactory taskListenerExecutorObjectFactory;
private final TaskMetrics taskMetrics;
@Autowired
private ConfigurableApplicationContext context;
@@ -144,6 +146,7 @@ public class TaskLifecycleListener implements ApplicationListener<ApplicationEve
this.taskExplorer = taskExplorer;
this.taskProperties = taskProperties;
this.taskListenerExecutorObjectFactory = taskListenerExecutorObjectFactory;
this.taskMetrics = new TaskMetrics();
}
/**
@@ -312,6 +315,7 @@ public class TaskLifecycleListener implements ApplicationListener<ApplicationEve
}
private TaskExecution invokeOnTaskStartup(TaskExecution taskExecution) {
this.taskMetrics.onTaskStartup(taskExecution);
TaskExecution listenerTaskExecution = getTaskExecutionCopy(taskExecution);
List<TaskExecutionListener> startupListenerList = new ArrayList<>(
this.taskExecutionListeners);
@@ -334,6 +338,7 @@ public class TaskLifecycleListener implements ApplicationListener<ApplicationEve
}
private TaskExecution invokeOnTaskEnd(TaskExecution taskExecution) {
this.taskMetrics.onTaskEnd(taskExecution);
TaskExecution listenerTaskExecution = getTaskExecutionCopy(taskExecution);
if (this.taskExecutionListeners != null) {
try {
@@ -357,6 +362,7 @@ public class TaskLifecycleListener implements ApplicationListener<ApplicationEve
private TaskExecution invokeOnTaskError(TaskExecution taskExecution,
Throwable throwable) {
this.taskMetrics.onTaskFailed(taskExecution, throwable);
TaskExecution listenerTaskExecution = getTaskExecutionCopy(taskExecution);
if (this.taskExecutionListeners != null) {
try {

View File

@@ -0,0 +1,136 @@
/*
* Copyright 2019-2019 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.cloud.task.listener;
import io.micrometer.core.instrument.LongTaskTimer;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.Timer;
import org.springframework.cloud.task.repository.TaskExecution;
/**
* @author Christian Tzolov
*/
public class TaskMetrics {
/**
* Task timer measurements. Records information about task duration and status.
*/
public static final String SPRING_CLOUD_TASK_METER = "spring.cloud.task";
/**
* LongTask timer measurement. Records the run-time status of long-time lasting tasks.
*/
public static final String SPRING_CLOUD_TASK_ACTIVE_METER = "spring.cloud.task.active";
/**
* Successful task execution status indicator.
*/
public static final String STATUS_SUCCESS = "success";
/**
* Failing task execution status indicator.
*/
public static final String STATUS_FAILURE = "failure";
/**
* task name measurement tag.
*/
public static final String TASK_NAME_TAG = "task.name";
/**
* task execution id tag.
*/
public static final String TASK_EXECUTION_ID_TAG = "task.execution.id";
/**
* task parent execution id tag.
*/
public static final String TASK_PARENT_EXECUTION_ID_TAG = "task.parent.execution.id";
/**
* task external execution id tag.
*/
public static final String TASK_EXTERNAL_EXECUTION_ID_TAG = "task.external.execution.id";
/**
* task exit code tag.
*/
public static final String TASK_EXIT_CODE_TAG = "task.exit.code";
/**
* task status tag. Can be either STATUS_SUCCESS or STATUS_FAILURE
*/
public static final String TASK_STATUS_TAG = "task.status";
/**
* task exception tag. Contains the name of the exception class in case of error or
* none otherwise.
*/
public static final String TASK_EXCEPTION_TAG = "task.exception";
private Timer.Sample taskSample;
private LongTaskTimer.Sample longTaskSample;
private Throwable exception;
public void onTaskStartup(TaskExecution taskExecution) {
LongTaskTimer longTaskTimer = LongTaskTimer
.builder(SPRING_CLOUD_TASK_ACTIVE_METER).description("Long task duration")
.tags(commonTags(taskExecution)).register(Metrics.globalRegistry);
this.longTaskSample = longTaskTimer.start();
this.taskSample = Timer.start(Metrics.globalRegistry);
}
public void onTaskFailed(TaskExecution taskExecution, Throwable throwable) {
this.exception = throwable;
}
public void onTaskEnd(TaskExecution taskExecution) {
if (this.taskSample != null) {
this.taskSample.stop(Timer.builder(SPRING_CLOUD_TASK_METER)
.description("Task duration").tags(commonTags(taskExecution))
.tag(TASK_EXIT_CODE_TAG, "" + taskExecution.getExitCode())
.tag(TASK_EXCEPTION_TAG,
(this.exception == null) ? "none"
: this.exception.getClass().getSimpleName())
.tag(TASK_STATUS_TAG,
(this.exception == null) ? STATUS_SUCCESS : STATUS_FAILURE)
.register(Metrics.globalRegistry));
this.taskSample = null;
}
if (this.longTaskSample != null) {
this.longTaskSample.stop();
this.longTaskSample = null;
}
}
private Tags commonTags(TaskExecution taskExecution) {
return Tags.of(TASK_NAME_TAG, taskExecution.getTaskName())
.and(TASK_EXECUTION_ID_TAG, "" + taskExecution.getExecutionId())
.and(TASK_PARENT_EXECUTION_ID_TAG,
"" + taskExecution.getParentExecutionId())
.and(TASK_EXTERNAL_EXECUTION_ID_TAG,
(taskExecution.getExternalExecutionId() == null) ? "unknown"
: "" + taskExecution.getExternalExecutionId());
}
}

View File

@@ -0,0 +1,44 @@
/*
* Copyright 2019-2019 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.cloud.task.metrics.fork;
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.MeterRegistry;
/**
* Forked from the
* org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer form
* spring-boot-actuator
*
* Callback interface that can be used to customize auto-configured {@link MeterRegistry
* MeterRegistries}.
* <p>
* Customizers are guaranteed to be applied before any {@link Meter} is registered with
* the registry.
*
* @author Michael Minella
*/
@FunctionalInterface
public interface MeterRegistryCustomizer<T extends MeterRegistry> {
/**
* Customize the given {@code registry}.
* @param registry the registry to customize
*/
void customize(T registry);
}

View File

@@ -0,0 +1,139 @@
/*
* Copyright 2019-2019 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.cloud.task.metrics.fork;
import java.util.List;
import java.util.stream.Collectors;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.util.LambdaSafe;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* Forked and stripped down version of the
* org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration form
* spring-boot-actuator
*
* {@link EnableAutoConfiguration Auto-configuration} for Micrometer-based metrics.
*
* @author Michael Minella
*/
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(Timed.class)
@AutoConfigureBefore(name = {
"org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration" })
public class MetricsAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public Clock micrometerClockFork() {
return Clock.SYSTEM;
}
@Bean
public static MeterRegistryPostProcessor meterRegistryPostProcessorFork(
ObjectProvider<MeterRegistryCustomizer<?>> meterRegistryCustomizers) {
return new MeterRegistryPostProcessor(meterRegistryCustomizers);
}
/**
* Forked and stripped down version of the
* org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryPostProcessor
* form spring-boot-actuator
*
* {@link BeanPostProcessor} that delegates to a lazily created
* {@link MeterRegistryConfigurer} to post-process {@link MeterRegistry} beans.
*
*/
static class MeterRegistryPostProcessor implements BeanPostProcessor {
private final ObjectProvider<MeterRegistryCustomizer<?>> meterRegistryCustomizers;
private volatile MeterRegistryConfigurer configurer;
MeterRegistryPostProcessor(
ObjectProvider<MeterRegistryCustomizer<?>> meterRegistryCustomizers) {
this.meterRegistryCustomizers = meterRegistryCustomizers;
}
@Override
public Object postProcessAfterInitialization(Object bean, String beanName)
throws BeansException {
if (bean instanceof MeterRegistry) {
getConfigurer().configure((MeterRegistry) bean);
}
return bean;
}
private MeterRegistryConfigurer getConfigurer() {
if (this.configurer == null) {
this.configurer = new MeterRegistryConfigurer(
this.meterRegistryCustomizers);
}
return this.configurer;
}
}
/**
* Forked and stripped down version of the
* org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryConfigurer form
* spring-boot-actuator
*
* Configurer to apply {@link MeterRegistryCustomizer customizers} to
* {@link MeterRegistry meter registries}.
*
*/
static class MeterRegistryConfigurer {
private final ObjectProvider<MeterRegistryCustomizer<?>> customizers;
MeterRegistryConfigurer(ObjectProvider<MeterRegistryCustomizer<?>> customizers) {
this.customizers = customizers;
}
void configure(MeterRegistry registry) {
customize(registry);
}
@SuppressWarnings("unchecked")
private void customize(MeterRegistry registry) {
LambdaSafe
.callbacks(MeterRegistryCustomizer.class,
asOrderedList(this.customizers), registry)
.withLogger(MeterRegistryConfigurer.class)
.invoke((customizer) -> customizer.customize(registry));
}
private <T> List<T> asOrderedList(ObjectProvider<T> provider) {
return provider.orderedStream().collect(Collectors.toList());
}
}
}

View File

@@ -1,3 +1,7 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.springframework.cloud.task.configuration.SingleTaskConfiguration,\
org.springframework.cloud.task.configuration.SimpleTaskAutoConfiguration\
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.cloud.task.configuration.SingleTaskConfiguration,\
org.springframework.cloud.task.configuration.SimpleTaskAutoConfiguration,\
org.springframework.cloud.task.configuration.CloudFoundryMicrometerTagsConfiguration,\
org.springframework.cloud.task.configuration.SpringCloudTaskMicrometerCommonTagsConfiguration,\
org.springframework.cloud.task.metrics.fork.MetricsAutoConfiguration\