-
Notifications
You must be signed in to change notification settings - Fork 40.2k
/
RepositoryMetricsAutoConfigurationTests.java
217 lines (176 loc) · 8.08 KB
/
RepositoryMetricsAutoConfigurationTests.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
* 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.data;
import java.util.Collection;
import java.util.Collections;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.Timer;
import io.micrometer.core.instrument.binder.MeterBinder;
import io.micrometer.core.instrument.distribution.HistogramSnapshot;
import org.junit.jupiter.api.Test;
import org.springframework.boot.actuate.autoconfigure.metrics.test.MetricsRun;
import org.springframework.boot.actuate.metrics.AutoTimer;
import org.springframework.boot.actuate.metrics.data.DefaultRepositoryTagsProvider;
import org.springframework.boot.actuate.metrics.data.MetricsRepositoryMethodInvocationListener;
import org.springframework.boot.actuate.metrics.data.RepositoryTagsProvider;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener.RepositoryMethodInvocation;
import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener.RepositoryMethodInvocationResult;
import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener.RepositoryMethodInvocationResult.State;
import org.springframework.util.ReflectionUtils;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link RepositoryMetricsAutoConfiguration}.
*
* @author Phillip Webb
*/
class RepositoryMetricsAutoConfigurationTests {
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner().with(MetricsRun.simple())
.withConfiguration(AutoConfigurations.of(RepositoryMetricsAutoConfiguration.class));
@Test
void backsOffWhenMeterRegistryIsMissing() {
new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(RepositoryMetricsAutoConfiguration.class))
.run((context) -> assertThat(context).doesNotHaveBean(RepositoryTagsProvider.class));
}
@Test
void definesTagsProviderAndListenerWhenMeterRegistryIsPresent() {
this.contextRunner.run((context) -> {
assertThat(context).hasSingleBean(DefaultRepositoryTagsProvider.class);
assertThat(context).hasSingleBean(MetricsRepositoryMethodInvocationListener.class);
assertThat(context).hasSingleBean(MetricsRepositoryMethodInvocationListenerBeanPostProcessor.class);
});
}
@Test
void tagsProviderBacksOff() {
this.contextRunner.withUserConfiguration(TagsProviderConfiguration.class).run((context) -> {
assertThat(context).doesNotHaveBean(DefaultRepositoryTagsProvider.class);
assertThat(context).hasSingleBean(TestRepositoryTagsProvider.class);
});
}
@Test
void metricsRepositoryMethodInvocationListenerBacksOff() {
this.contextRunner.withUserConfiguration(MetricsRepositoryMethodInvocationListenerConfiguration.class)
.run((context) -> {
assertThat(context).hasSingleBean(MetricsRepositoryMethodInvocationListener.class);
assertThat(context).hasSingleBean(TestMetricsRepositoryMethodInvocationListener.class);
});
}
@Test
void metricNameCanBeConfigured() {
this.contextRunner.withPropertyValues("management.metrics.data.repository.metric-name=datarepo")
.run((context) -> {
MeterRegistry registry = getInitializedMeterRegistry(context, ExampleRepository.class);
Timer timer = registry.get("datarepo").timer();
assertThat(timer).isNotNull();
});
}
@Test
void autoTimeRequestsCanBeConfigured() {
this.contextRunner.withPropertyValues("management.metrics.data.repository.autotime.enabled=true",
"management.metrics.data.repository.autotime.percentiles=0.5,0.7").run((context) -> {
MeterRegistry registry = getInitializedMeterRegistry(context, ExampleRepository.class);
Timer timer = registry.get("spring.data.repository.invocations").timer();
HistogramSnapshot snapshot = timer.takeSnapshot();
assertThat(snapshot.percentileValues()).hasSize(2);
assertThat(snapshot.percentileValues()[0].percentile()).isEqualTo(0.5);
assertThat(snapshot.percentileValues()[1].percentile()).isEqualTo(0.7);
});
}
@Test
void timerWorksWithTimedAnnotationsWhenAutoTimeRequestsIsFalse() {
this.contextRunner.withPropertyValues("management.metrics.data.repository.autotime.enabled=false")
.run((context) -> {
MeterRegistry registry = getInitializedMeterRegistry(context, ExampleAnnotatedRepository.class);
Collection<Meter> meters = registry.get("spring.data.repository.invocations").meters();
assertThat(meters).hasSize(1);
Meter meter = meters.iterator().next();
assertThat(meter.getId().getTag("method")).isEqualTo("count");
});
}
@Test
void doesNotTriggerEarlyInitializationThatPreventsMeterBindersFromBindingMeters() {
this.contextRunner.withUserConfiguration(MeterBinderConfiguration.class)
.run((context) -> assertThat(context.getBean(MeterRegistry.class).find("binder.test").counter())
.isNotNull());
}
private MeterRegistry getInitializedMeterRegistry(AssertableApplicationContext context,
Class<?> repositoryInterface) {
MetricsRepositoryMethodInvocationListener listener = context
.getBean(MetricsRepositoryMethodInvocationListener.class);
ReflectionUtils.doWithLocalMethods(repositoryInterface, (method) -> {
RepositoryMethodInvocationResult result = mock(RepositoryMethodInvocationResult.class);
given(result.getState()).willReturn(State.SUCCESS);
RepositoryMethodInvocation invocation = new RepositoryMethodInvocation(repositoryInterface, method, result,
10);
listener.afterInvocation(invocation);
});
return context.getBean(MeterRegistry.class);
}
@Configuration(proxyBeanMethods = false)
static class TagsProviderConfiguration {
@Bean
TestRepositoryTagsProvider tagsProvider() {
return new TestRepositoryTagsProvider();
}
}
private static final class TestRepositoryTagsProvider implements RepositoryTagsProvider {
@Override
public Iterable<Tag> repositoryTags(RepositoryMethodInvocation invocation) {
return Collections.emptyList();
}
}
@Configuration(proxyBeanMethods = false)
static class MeterBinderConfiguration {
@Bean
MeterBinder meterBinder() {
return (registry) -> registry.counter("binder.test");
}
}
@Configuration(proxyBeanMethods = false)
static class MetricsRepositoryMethodInvocationListenerConfiguration {
@Bean
MetricsRepositoryMethodInvocationListener metricsRepositoryMethodInvocationListener(MeterRegistry registry,
RepositoryTagsProvider tagsProvider) {
return new TestMetricsRepositoryMethodInvocationListener(registry, tagsProvider);
}
}
static class TestMetricsRepositoryMethodInvocationListener extends MetricsRepositoryMethodInvocationListener {
TestMetricsRepositoryMethodInvocationListener(MeterRegistry registry, RepositoryTagsProvider tagsProvider) {
super(registry, tagsProvider, "test", AutoTimer.DISABLED);
}
}
interface ExampleRepository extends Repository<Example, Long> {
long count();
}
interface ExampleAnnotatedRepository extends Repository<Example, Long> {
@Timed
long count();
long delete();
}
static class Example {
}
}