opendev/gerrit
Code Issues Proposed changes

Add metrics for HTTP responses

Browse Source 
Create a helper class, RequestMetrics, which gets a MetricMaker injected
and uses it to create metrics for HTTP responses.

Add a RequestMetricsFilter which filters all requests and sends metrics
for successful and error responses.

Change-Id: Ib8da47b7f80c6f7ccb4206157e7f5139c099cfdd
This commit is contained in:
David Pursehouse 2015-11-11 15:34:12 -08:00
parent 76803cac36
commit b65b83a5f6
4 changed files with 155 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
gerrit-httpd/src/main/java/com/google/gerrit/httpd/RequestMetrics.java Normal file
View File

@ -0,0 +1,44 @@
// Copyright (C) 2015 The Android Open Source Project
//
// 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
//
// http://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 com.google.gerrit.httpd;
import com.google.gerrit.metrics.Counter1;
import com.google.gerrit.metrics.Description;
import com.google.gerrit.metrics.Field;
import com.google.gerrit.metrics.MetricMaker;
import com.google.inject.Inject;
import com.google.inject.Singleton;
@Singleton
public class RequestMetrics {
final Counter1<Integer> errors;
final Counter1<Integer> successes;
@Inject
public RequestMetrics(MetricMaker metricMaker) {
errors = metricMaker.newCounter(
"http/server/error_count",
new Description("Rate of REST API error responses")
.setRate()
.setUnit("errors"),
Field.ofInteger("status", "HTTP status code"));
successes = metricMaker.newCounter(
"http/server/success_count",
new Description("Rate of REST API success responses")
.setRate()
.setUnit("successes"),
Field.ofInteger("status", "HTTP status code"));
}
}

108
gerrit-httpd/src/main/java/com/google/gerrit/httpd/RequestMetricsFilter.java Normal file
View File

@ -0,0 +1,108 @@
// Copyright (C) 2015 The Android Open Source Project
//
// 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
//
// http://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 com.google.gerrit.httpd;
import com.google.inject.Inject;
import com.google.inject.Module;
import com.google.inject.Singleton;
import com.google.inject.servlet.ServletModule;
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
@Singleton
public class RequestMetricsFilter implements Filter {
public static Module module() {
return new ServletModule() {
@Override
protected void configureServlets() {
filter("/*").through(RequestMetricsFilter.class);
}
};
}
private final RequestMetrics metrics;
@Inject
RequestMetricsFilter(RequestMetrics metrics) {
this.metrics = metrics;
}
@Override
public void destroy() {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
Response rsp = new Response((HttpServletResponse) response, metrics);
chain.doFilter(request, rsp);
}
@Override
public void init(FilterConfig cfg) throws ServletException {
}
private static class Response extends HttpServletResponseWrapper {
private final RequestMetrics metrics;
Response(HttpServletResponse response, RequestMetrics metrics) {
super(response);
this.metrics = metrics;
}
@Override
public void sendError(int sc, String msg) throws IOException {
status(sc);
super.sendError(sc, msg);
}
@Override
public void sendError(int sc) throws IOException {
status(sc);
super.sendError(sc);
}
@Override
@Deprecated
public void setStatus(int sc, String sm) {
status(sc);
super.setStatus(sc, sm);
}
@Override
public void setStatus(int sc) {
status(sc);
super.setStatus(sc);
}
private void status(int sc) {
if (sc >= SC_BAD_REQUEST) {
metrics.errors.increment(sc);
} else {
metrics.successes.increment(sc);
}
}
}
}

2
gerrit-pgm/src/main/java/com/google/gerrit/pgm/Daemon.java
View File

@ -28,6 +28,7 @@ import com.google.gerrit.httpd.GitOverHttpModule;
import com.google.gerrit.httpd.H2CacheBasedWebSession;
import com.google.gerrit.httpd.HttpCanonicalWebUrlProvider;
import com.google.gerrit.httpd.RequestContextFilter;
import com.google.gerrit.httpd.RequestMetricsFilter;
import com.google.gerrit.httpd.RequireSslFilter;
import com.google.gerrit.httpd.WebModule;
import com.google.gerrit.httpd.WebSshGlueModule;
@ -445,6 +446,7 @@ public class Daemon extends SiteProgram {
}
modules.add(RequestContextFilter.module());
modules.add(AllRequestFilter.module());
modules.add(RequestMetricsFilter.module());
modules.add(H2CacheBasedWebSession.module());
modules.add(sysInjector.getInstance(GitOverHttpModule.class));
modules.add(sysInjector.getInstance(WebModule.class));

1
gerrit-war/src/main/java/com/google/gerrit/httpd/WebAppInitializer.java
View File

@ -349,6 +349,7 @@ public class WebAppInitializer extends GuiceServletContextListener
final List<Module> modules = new ArrayList<>();
modules.add(RequestContextFilter.module());
modules.add(AllRequestFilter.module());
modules.add(RequestMetricsFilter.module());
modules.add(sysInjector.getInstance(GitOverHttpModule.class));
modules.add(sysInjector.getInstance(WebModule.class));
modules.add(sysInjector.getInstance(RequireSslFilter.Module.class));