Skip to content

Commit 18ffbdb

Browse files
marcingrzejszczakcppwfs
authored andcommitted
Updated micrometer to the latest changes
Updated sample task metrics to include observation dependency
1 parent 5b9ffcc commit 18ffbdb

File tree

8 files changed

+36
-18
lines changed

8 files changed

+36
-18
lines changed

pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@
119119
<maven-checkstyle-plugin.includeTestSourceDirectory>true
120120
</maven-checkstyle-plugin.includeTestSourceDirectory>
121121
<java.version>17</java.version>
122+
<micrometer.version>1.10.0-SNAPSHOT</micrometer.version>
122123
</properties>
123124

124125
<build>

spring-cloud-task-core/pom.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,12 @@
117117
<dependency>
118118
<groupId>io.micrometer</groupId>
119119
<artifactId>micrometer-core</artifactId>
120+
<version>${micrometer.version}</version>
120121
</dependency>
121122
<dependency>
122123
<groupId>io.micrometer</groupId>
123124
<artifactId>micrometer-observation</artifactId>
125+
<version>${micrometer.version}</version>
124126
</dependency>
125127
<dependency>
126128
<groupId>org.junit.jupiter</groupId>
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,15 @@
2525
* @author Marcin Grzejszczak
2626
* @since 3.0.0
2727
*/
28-
public class DefaultTaskKeyValuesProvider implements TaskKeyValuesProvider {
28+
public class DefaultTaskObservationConvention implements TaskObservationConvention {
2929

3030
@Override
3131
public KeyValues getLowCardinalityKeyValues(TaskObservationContext context) {
3232
return KeyValues.of(TaskDocumentedObservation.TaskRunnerTags.BEAN_NAME.of(context.getBeanName()));
3333
}
34+
35+
@Override
36+
public String getName() {
37+
return "spring.cloud.task.runner";
38+
}
3439
}

spring-cloud-task-core/src/main/java/org/springframework/cloud/task/configuration/observation/ObservationApplicationRunner.java

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@
2828
*
2929
* @author Marcin Grzejszczak
3030
*/
31-
class ObservationApplicationRunner implements ApplicationRunner, Observation.KeyValuesProviderAware<TaskKeyValuesProvider> {
31+
class ObservationApplicationRunner implements ApplicationRunner, Observation.KeyValuesProviderAware<TaskObservationConvention> {
32+
33+
private static final DefaultTaskObservationConvention INSTANCE = new DefaultTaskObservationConvention();
3234

3335
private final BeanFactory beanFactory;
3436

@@ -38,7 +40,7 @@ class ObservationApplicationRunner implements ApplicationRunner, Observation.Key
3840

3941
private ObservationRegistry registry;
4042

41-
private TaskKeyValuesProvider keyValuesProvider = new DefaultTaskKeyValuesProvider();
43+
private TaskObservationConvention taskObservationConvention;
4244

4345
ObservationApplicationRunner(BeanFactory beanFactory, ApplicationRunner delegate, String beanName) {
4446
this.beanFactory = beanFactory;
@@ -49,9 +51,8 @@ class ObservationApplicationRunner implements ApplicationRunner, Observation.Key
4951
@Override
5052
public void run(ApplicationArguments args) throws Exception {
5153
TaskObservationContext context = new TaskObservationContext(this.beanName);
52-
Observation observation = TaskDocumentedObservation.TASK_RUNNER_OBSERVATION.observation(registry(), context)
53-
.contextualName(this.beanName)
54-
.keyValuesProvider(this.keyValuesProvider);
54+
Observation observation = TaskDocumentedObservation.TASK_RUNNER_OBSERVATION.observation(this.taskObservationConvention, INSTANCE, context, registry())
55+
.contextualName(this.beanName);
5556
try (Observation.Scope scope = observation.start().openScope()) {
5657
this.delegate.run(args);
5758
}
@@ -72,7 +73,7 @@ private ObservationRegistry registry() {
7273
}
7374

7475
@Override
75-
public void setKeyValuesProvider(TaskKeyValuesProvider keyValuesProvider) {
76-
this.keyValuesProvider = keyValuesProvider;
76+
public void setKeyValuesProvider(TaskObservationConvention keyValuesProvider) {
77+
this.taskObservationConvention = keyValuesProvider;
7778
}
7879
}

spring-cloud-task-core/src/main/java/org/springframework/cloud/task/configuration/observation/ObservationCommandLineRunner.java

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@
2727
*
2828
* @author Marcin Grzejszczak
2929
*/
30-
class ObservationCommandLineRunner implements CommandLineRunner, Observation.KeyValuesProviderAware<TaskKeyValuesProvider> {
30+
class ObservationCommandLineRunner implements CommandLineRunner, Observation.KeyValuesProviderAware<TaskObservationConvention> {
31+
32+
private static final DefaultTaskObservationConvention INSTANCE = new DefaultTaskObservationConvention();
3133

3234
private final BeanFactory beanFactory;
3335

@@ -37,7 +39,7 @@ class ObservationCommandLineRunner implements CommandLineRunner, Observation.Key
3739

3840
private ObservationRegistry registry;
3941

40-
private TaskKeyValuesProvider keyValuesProvider = new DefaultTaskKeyValuesProvider();
42+
private TaskObservationConvention taskObservationConvention;
4143

4244
ObservationCommandLineRunner(BeanFactory beanFactory, CommandLineRunner delegate, String beanName) {
4345
this.beanFactory = beanFactory;
@@ -48,9 +50,8 @@ class ObservationCommandLineRunner implements CommandLineRunner, Observation.Key
4850
@Override
4951
public void run(String... args) throws Exception {
5052
TaskObservationContext context = new TaskObservationContext(this.beanName);
51-
Observation observation = TaskDocumentedObservation.TASK_RUNNER_OBSERVATION.observation(registry(), context)
52-
.contextualName(this.beanName)
53-
.keyValuesProvider(this.keyValuesProvider);
53+
Observation observation = TaskDocumentedObservation.TASK_RUNNER_OBSERVATION.observation(this.taskObservationConvention, INSTANCE, context, registry())
54+
.contextualName(this.beanName);
5455
try (Observation.Scope scope = observation.start().openScope()) {
5556
this.delegate.run(args);
5657
}
@@ -71,7 +72,7 @@ private ObservationRegistry registry() {
7172
}
7273

7374
@Override
74-
public void setKeyValuesProvider(TaskKeyValuesProvider keyValuesProvider) {
75-
this.keyValuesProvider = keyValuesProvider;
75+
public void setKeyValuesProvider(TaskObservationConvention keyValuesProvider) {
76+
this.taskObservationConvention = keyValuesProvider;
7677
}
7778
}

spring-cloud-task-core/src/main/java/org/springframework/cloud/task/configuration/observation/TaskDocumentedObservation.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package org.springframework.cloud.task.configuration.observation;
1818

1919
import io.micrometer.common.docs.KeyName;
20+
import io.micrometer.observation.Observation;
2021
import io.micrometer.observation.docs.DocumentedObservation;
2122

2223
enum TaskDocumentedObservation implements DocumentedObservation {
@@ -25,9 +26,10 @@ enum TaskDocumentedObservation implements DocumentedObservation {
2526
* Observation created when a task runner is executed.
2627
*/
2728
TASK_RUNNER_OBSERVATION {
29+
2830
@Override
29-
public String getName() {
30-
return "spring.cloud.task.runner";
31+
public Class<? extends Observation.ObservationConvention<? extends Observation.Context>> getDefaultConvention() {
32+
return DefaultTaskObservationConvention.class;
3133
}
3234

3335
@Override
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* @author Marcin Grzejszczak
2525
* @since 3.0.0
2626
*/
27-
public interface TaskKeyValuesProvider extends Observation.KeyValuesProvider<TaskObservationContext> {
27+
public interface TaskObservationConvention extends Observation.ObservationConvention<TaskObservationContext> {
2828

2929
@Override
3030
default boolean supportsContext(Observation.Context context) {

spring-cloud-task-samples/task-metrics/pom.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@
5858
<dependency>
5959
<groupId>io.micrometer</groupId>
6060
<artifactId>micrometer-core</artifactId>
61+
<version>1.10.0-SNAPSHOT</version>
62+
</dependency>
63+
<dependency>
64+
<groupId>io.micrometer</groupId>
65+
<artifactId>micrometer-observation</artifactId>
66+
<version>1.10.0-SNAPSHOT</version>
6167
</dependency>
6268
<dependency>
6369
<groupId>com.h2database</groupId>

0 commit comments

Comments
 (0)