Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Replace KeyValuesProvider with ObservationConvention

Browse Source 
Related to https://github.com/micrometer-metrics/micrometer/pull/3306
This commit is contained in:
Mahmoud Ben Hassine
2022-07-26 06:53:23 +02:00
parent a2cf74adec
commit 96c6367dae
6 changed files with 22 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
spring-batch-core/src/main/java/org/springframework/batch/core/job/AbstractJob.java
View File

@@ -44,9 +44,9 @@ import org.springframework.batch.core.launch.support.ExitCodeMapper;
import org.springframework.batch.core.listener.CompositeJobExecutionListener;
import org.springframework.batch.core.observability.BatchJobContext;
import org.springframework.batch.core.observability.BatchJobObservation;
import org.springframework.batch.core.observability.BatchJobKeyValuesProvider;
import org.springframework.batch.core.observability.BatchJobObservationConvention;
import org.springframework.batch.core.observability.BatchMetrics;
import org.springframework.batch.core.observability.DefaultBatchJobKeyValuesProvider;
import org.springframework.batch.core.observability.DefaultBatchJobObservationConvention;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.repository.JobRestartException;
import org.springframework.batch.core.scope.context.JobSynchronizationManager;
@@ -86,7 +86,7 @@ public abstract class AbstractJob implements Job, StepLocator, BeanNameAware, In
private StepHandler stepHandler;
private BatchJobKeyValuesProvider keyValuesProvider = new DefaultBatchJobKeyValuesProvider();
private BatchJobObservationConvention observationConvention = new DefaultBatchJobObservationConvention();
/**
* Default constructor.
@@ -288,8 +288,8 @@ public abstract class AbstractJob implements Job, StepLocator, BeanNameAware, In
LongTaskTimer.Sample longTaskTimerSample = longTaskTimer.start();
Observation observation = BatchMetrics
.createObservation(BatchJobObservation.BATCH_JOB_OBSERVATION.getName(), new BatchJobContext(execution))
.contextualName(execution.getJobInstance().getJobName()).keyValuesProvider(this.keyValuesProvider)
.start();
.contextualName(execution.getJobInstance().getJobName())
.observationConvention(this.observationConvention).start();
try (Observation.Scope scope = observation.openScope()) {
jobParametersValidator.validate(execution.getJobParameters());
@@ -433,8 +433,8 @@ public abstract class AbstractJob implements Job, StepLocator, BeanNameAware, In
jobRepository.update(jobExecution);
}
public void setKeyValuesProvider(BatchJobKeyValuesProvider keyValuesProvider) {
this.keyValuesProvider = keyValuesProvider;
public void setObservationConvention(BatchJobObservationConvention observationConvention) {
this.observationConvention = observationConvention;
}
@Override

5
spring-batch-core/src/main/java/org/springframework/batch/core/observability/BatchJobKeyValuesProvider.java → spring-batch-core/src/main/java/org/springframework/batch/core/observability/BatchJobObservationConvention.java
View File

@@ -19,12 +19,13 @@ package org.springframework.batch.core.observability;
import io.micrometer.observation.Observation;
/**
* {@link Observation.KeyValuesProvider} for {@link BatchJobContext}.
* {@link Observation.ObservationConvention} for {@link BatchJobContext}.
*
* @author Marcin Grzejszczak
* @author Mahmoud Ben Hassine
* @since 5.0
*/
public interface BatchJobKeyValuesProvider extends Observation.KeyValuesProvider<BatchJobContext> {
public interface BatchJobObservationConvention extends Observation.ObservationConvention<BatchJobContext> {
@Override
default boolean supportsContext(Observation.Context context) {

4
spring-batch-core/src/main/java/org/springframework/batch/core/observability/BatchStepKeyValuesProvider.java → spring-batch-core/src/main/java/org/springframework/batch/core/observability/BatchStepObservationConvention.java
View File

@@ -19,13 +19,13 @@ package org.springframework.batch.core.observability;
import io.micrometer.observation.Observation;
/**
* {@link Observation.KeyValuesProvider} for {@link BatchStepContext}.
* {@link Observation.ObservationConvention} for {@link BatchStepContext}.
*
* @author Marcin Grzejszczak
* @author Mahmoud Ben Hassine
* @since 5.0
*/
public interface BatchStepKeyValuesProvider extends Observation.KeyValuesProvider<BatchStepContext> {
public interface BatchStepObservationConvention extends Observation.ObservationConvention<BatchStepContext> {
@Override
default boolean supportsContext(Observation.Context context) {

4
spring-batch-core/src/main/java/org/springframework/batch/core/observability/DefaultBatchJobKeyValuesProvider.java → spring-batch-core/src/main/java/org/springframework/batch/core/observability/DefaultBatchJobObservationConvention.java
View File

@@ -20,13 +20,13 @@ import io.micrometer.common.KeyValues;
import org.springframework.batch.core.JobExecution;
/**
* Default {@link BatchJobKeyValuesProvider} implementation.
* Default {@link BatchJobObservationConvention} implementation.
*
* @author Marcin Grzejszczak
* @author Mahmoud Ben Hassine
* @since 5.0
*/
public class DefaultBatchJobKeyValuesProvider implements BatchJobKeyValuesProvider {
public class DefaultBatchJobObservationConvention implements BatchJobObservationConvention {
@Override
public KeyValues getLowCardinalityKeyValues(BatchJobContext context) {

4
spring-batch-core/src/main/java/org/springframework/batch/core/observability/DefaultBatchStepKeyValuesProvider.java → spring-batch-core/src/main/java/org/springframework/batch/core/observability/DefaultBatchStepObservationConvention.java
View File

@@ -20,13 +20,13 @@ import io.micrometer.common.KeyValues;
import org.springframework.batch.core.StepExecution;
/**
* Default {@link BatchStepKeyValuesProvider} implementation.
* Default {@link BatchStepObservationConvention} implementation.
*
* @author Marcin Grzejszczak
* @author Mahmoud Ben Hassine
* @since 5.0
*/
public class DefaultBatchStepKeyValuesProvider implements BatchStepKeyValuesProvider {
public class DefaultBatchStepObservationConvention implements BatchStepObservationConvention {
@Override
public KeyValues getLowCardinalityKeyValues(BatchStepContext context) {

12
spring-batch-core/src/main/java/org/springframework/batch/core/step/AbstractStep.java
View File

@@ -38,8 +38,8 @@ import org.springframework.batch.core.listener.CompositeStepExecutionListener;
import org.springframework.batch.core.observability.BatchMetrics;
import org.springframework.batch.core.observability.BatchStepContext;
import org.springframework.batch.core.observability.BatchStepObservation;
import org.springframework.batch.core.observability.BatchStepKeyValuesProvider;
import org.springframework.batch.core.observability.DefaultBatchStepKeyValuesProvider;
import org.springframework.batch.core.observability.BatchStepObservationConvention;
import org.springframework.batch.core.observability.DefaultBatchStepObservationConvention;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.scope.context.StepSynchronizationManager;
import org.springframework.batch.item.ExecutionContext;
@@ -74,7 +74,7 @@ public abstract class AbstractStep implements Step, InitializingBean, BeanNameAw
private JobRepository jobRepository;
private BatchStepKeyValuesProvider keyValuesProvider = new DefaultBatchStepKeyValuesProvider();
private BatchStepObservationConvention observationConvention = new DefaultBatchStepObservationConvention();
/**
* Default constructor.
@@ -202,7 +202,7 @@ public abstract class AbstractStep implements Step, InitializingBean, BeanNameAw
Observation observation = BatchMetrics
.createObservation(BatchStepObservation.BATCH_STEP_OBSERVATION.getName(),
new BatchStepContext(stepExecution))
.contextualName(stepExecution.getStepName()).keyValuesProvider(this.keyValuesProvider).start();
.contextualName(stepExecution.getStepName()).observationConvention(this.observationConvention).start();
getJobRepository().update(stepExecution);
// Start with a default value that will be trumped by anything
@@ -418,8 +418,8 @@ public abstract class AbstractStep implements Step, InitializingBean, BeanNameAw
return exitStatus;
}
public void setKeyValuesProvider(BatchStepKeyValuesProvider keyValuesProvider) {
this.keyValuesProvider = keyValuesProvider;
public void setObservationConvention(BatchStepObservationConvention observationConvention) {
this.observationConvention = observationConvention;
}
}