Skip to content

Produce Dropwizard timer metrics instead of gauges in MetricsFilter #9555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,16 @@ public class MetricFilterProperties {
*/
private Set<MetricsFilterSubmission> counterSubmissions;

/**
* Submissions that should be made to the timer.
*/
private Set<MetricsFilterSubmission> timerSubmissions;

public MetricFilterProperties() {
this.gaugeSubmissions = new HashSet<>(EnumSet.of(MetricsFilterSubmission.MERGED));
this.counterSubmissions = new HashSet<>(
EnumSet.of(MetricsFilterSubmission.MERGED));
this.timerSubmissions = new HashSet<>();
}

public Set<MetricsFilterSubmission> getGaugeSubmissions() {
Expand All @@ -64,6 +70,14 @@ public void setCounterSubmissions(Set<MetricsFilterSubmission> counterSubmission
this.counterSubmissions = counterSubmissions;
}

public Set<MetricsFilterSubmission> getTimerSubmissions() {
return this.timerSubmissions;
}

public void setTimerSubmissions(Set<MetricsFilterSubmission> timerSubmissions) {
this.timerSubmissions = timerSubmissions;
}

boolean shouldSubmitToGauge(MetricsFilterSubmission submission) {
return shouldSubmit(this.gaugeSubmissions, submission);
}
Expand All @@ -72,6 +86,10 @@ boolean shouldSubmitToCounter(MetricsFilterSubmission submission) {
return shouldSubmit(this.counterSubmissions, submission);
}

boolean shouldSubmitToTimer(MetricsFilterSubmission submission) {
return shouldSubmit(this.timerSubmissions, submission);
}

private boolean shouldSubmit(Set<MetricsFilterSubmission> submissions,
MetricsFilterSubmission submission) {
return submissions != null && submissions.contains(submission);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,9 @@ private void submitMetrics(MetricsFilterSubmission submission,
if (this.properties.shouldSubmitToCounter(submission)) {
incrementCounter(getKey("status." + prefix + status + suffix));
}
if (this.properties.shouldSubmitToTimer(submission)) {
submitToGauge(getKey("timer.response." + prefix + suffix), time);
}
}

private String getKey(String string) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.asyncDispatch;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
Expand All @@ -89,6 +90,7 @@ public void defaultMetricFilterAutoConfigurationProperties() {
.containsExactly(MetricsFilterSubmission.MERGED);
assertThat(properties.getCounterSubmissions())
.containsExactly(MetricsFilterSubmission.MERGED);
assertThat(properties.getTimerSubmissions()).isEmpty();
}

@Test
Expand Down Expand Up @@ -409,6 +411,37 @@ public Object answer(InvocationOnMock invocation) throws Throwable {
context.close();
}

@Test
public void recordsTimerMetricsIfConfigured() throws Exception {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
context.register(Config.class, MetricFilterAutoConfiguration.class);
TestPropertyValues.of("endpoints.metrics.filter.gauge-submissions=",
"endpoints.metrics.filter.counter-submissions=",
"endpoints.metrics.filter.timer-submissions=merged,per-http-method"
).applyTo(context);
context.refresh();
Filter filter = context.getBean(Filter.class);
final MockHttpServletRequest request = new MockHttpServletRequest("PUT",
"/test/path");
final MockHttpServletResponse response = new MockHttpServletResponse();
FilterChain chain = mock(FilterChain.class);
willAnswer(new Answer<Object>() {
@Override
public Object answer(InvocationOnMock invocation) throws Throwable {
response.setStatus(200);
return null;
}
}).given(chain).doFilter(request, response);
filter.doFilter(request, response, chain);
verify(context.getBean(GaugeService.class)).submit(eq("timer.response.test.path"),
anyDouble());
verify(context.getBean(GaugeService.class)).submit(eq("timer.response.PUT.test.path"),
anyDouble());
verifyNoMoreInteractions(context.getBean(GaugeService.class));
verify(context.getBean(CounterService.class), never()).increment(anyString());
context.close();
}

@Test
public void whenExceptionIsThrownResponseStatusIsUsedWhenResponseHasBeenCommitted()
throws Exception {
Expand Down