opendev/gerrit
Code Issues Proposed changes

Add Histogram0..3 to track bytes sent

Browse Source 
The pack_bytes metric reports on the size of data sent to clients.
Using a histogram allows the server to track the distribution of these
files over time, as well as total amount sent.

The response_bytes metric reports on size of REST API replies,
broken down by view.

Change-Id: I7c06cb9afb2f4a8da1ef1eec85b5831f75b88116
This commit is contained in:
Shawn Pearce
2015-11-12 17:34:26 -08:00
parent 3ac37ad526
commit a093f127d4
15 changed files with 594 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
gerrit-httpd/src/main/java/com/google/gerrit/httpd/restapi/RestApiMetrics.java
View File

@@ -20,6 +20,7 @@ import com.google.gerrit.metrics.Counter1;
import com.google.gerrit.metrics.Counter2;
import com.google.gerrit.metrics.Description;
import com.google.gerrit.metrics.Field;
import com.google.gerrit.metrics.Histogram1;
import com.google.gerrit.metrics.MetricMaker;
import com.google.gerrit.metrics.Timer1;
import com.google.gerrit.metrics.Description.Units;
@@ -36,6 +37,7 @@ public class RestApiMetrics {
final Counter1<String> count;
final Counter2<String, Integer> errorCount;
final Timer1<String> serverLatency;
final Histogram1<String> responseBytes;
@Inject
RestApiMetrics(MetricMaker metrics) {
@@ -59,6 +61,13 @@ public class RestApiMetrics {
.setCumulative()
.setUnit(Units.MILLISECONDS),
view);
responseBytes = metrics.newHistogram(
"http/server/rest_api/response_bytes",
new Description("Size of response on network (may be gzip compressed)")
.setCumulative()
.setUnit(Units.BYTES),
view);
}
String view(ViewData viewData) {

74
gerrit-httpd/src/main/java/com/google/gerrit/httpd/restapi/RestApiServlet.java
View File

@@ -43,6 +43,7 @@ import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
import com.google.common.collect.Sets;
import com.google.common.io.BaseEncoding;
import com.google.common.io.CountingOutputStream;
import com.google.common.math.IntMath;
import com.google.common.net.HttpHeaders;
import com.google.gerrit.audit.AuditService;
@@ -206,6 +207,7 @@ public class RestApiServlet extends HttpServlet {
res.setHeader("Content-Disposition", "attachment");
res.setHeader("X-Content-Type-Options", "nosniff");
int status = SC_OK;
long responseBytes = -1;
Object result = null;
Multimap<String, String> params = LinkedHashMultimap.create();
Object inputRequestBody = null;
@@ -353,46 +355,47 @@ public class RestApiServlet extends HttpServlet {
if (result != Response.none()) {
result = Response.unwrap(result);
if (result instanceof BinaryResult) {
replyBinaryResult(req, res, (BinaryResult) result);
responseBytes = replyBinaryResult(req, res, (BinaryResult) result);
} else {
replyJson(req, res, config, result);
responseBytes = replyJson(req, res, config, result);
}
}
} catch (MalformedJsonException e) {
replyError(req, res, status = SC_BAD_REQUEST,
responseBytes = replyError(req, res, status = SC_BAD_REQUEST,
"Invalid " + JSON_TYPE + " in request", e);
} catch (JsonParseException e) {
replyError(req, res, status = SC_BAD_REQUEST,
responseBytes = replyError(req, res, status = SC_BAD_REQUEST,
"Invalid " + JSON_TYPE + " in request", e);
} catch (BadRequestException e) {
replyError(req, res, status = SC_BAD_REQUEST, messageOr(e, "Bad Request"),
e.caching(), e);
responseBytes = replyError(req, res, status = SC_BAD_REQUEST,
messageOr(e, "Bad Request"), e.caching(), e);
} catch (AuthException e) {
replyError(req, res, status = SC_FORBIDDEN, messageOr(e, "Forbidden"),
e.caching(), e);
responseBytes = replyError(req, res, status = SC_FORBIDDEN,
messageOr(e, "Forbidden"), e.caching(), e);
} catch (AmbiguousViewException e) {
replyError(req, res, status = SC_NOT_FOUND, messageOr(e, "Ambiguous"), e);
responseBytes = replyError(req, res, status = SC_NOT_FOUND,
messageOr(e, "Ambiguous"), e);
} catch (ResourceNotFoundException e) {
replyError(req, res, status = SC_NOT_FOUND, messageOr(e, "Not Found"),
e.caching(), e);
responseBytes = replyError(req, res, status = SC_NOT_FOUND,
messageOr(e, "Not Found"), e.caching(), e);
} catch (MethodNotAllowedException e) {
replyError(req, res, status = SC_METHOD_NOT_ALLOWED,
responseBytes = replyError(req, res, status = SC_METHOD_NOT_ALLOWED,
messageOr(e, "Method Not Allowed"), e.caching(), e);
} catch (ResourceConflictException e) {
replyError(req, res, status = SC_CONFLICT, messageOr(e, "Conflict"),
e.caching(), e);
responseBytes = replyError(req, res, status = SC_CONFLICT,
messageOr(e, "Conflict"), e.caching(), e);
} catch (PreconditionFailedException e) {
replyError(req, res, status = SC_PRECONDITION_FAILED,
responseBytes = replyError(req, res, status = SC_PRECONDITION_FAILED,
messageOr(e, "Precondition Failed"), e.caching(), e);
} catch (UnprocessableEntityException e) {
replyError(req, res, status = 422, messageOr(e, "Unprocessable Entity"),
e.caching(), e);
responseBytes = replyError(req, res, status = 422,
messageOr(e, "Unprocessable Entity"), e.caching(), e);
} catch (NotImplementedException e) {
replyError(req, res, status = SC_NOT_IMPLEMENTED,
responseBytes = replyError(req, res, status = SC_NOT_IMPLEMENTED,
messageOr(e, "Not Implemented"), e);
} catch (Exception e) {
status = SC_INTERNAL_SERVER_ERROR;
handleException(e, req, res);
responseBytes = handleException(e, req, res);
} finally {
String metric = viewData != null && viewData.view != null
? globals.metrics.view(viewData)
@@ -401,6 +404,9 @@ public class RestApiServlet extends HttpServlet {
if (status >= SC_BAD_REQUEST) {
globals.metrics.errorCount.increment(metric, status);
}
if (responseBytes != -1) {
globals.metrics.responseBytes.record(metric, responseBytes);
}
globals.metrics.serverLatency.record(
metric,
System.nanoTime() - startNanos,
@@ -667,7 +673,7 @@ public class RestApiServlet extends HttpServlet {
throw new InstantiationException("Cannot make " + type);
}
public static void replyJson(@Nullable HttpServletRequest req,
public static long replyJson(@Nullable HttpServletRequest req,
HttpServletResponse res,
Multimap<String, String> config,
Object result)
@@ -683,7 +689,7 @@ public class RestApiServlet extends HttpServlet {
}
w.write('\n');
w.flush();
replyBinaryResult(req, res, asBinaryResult(buf)
return replyBinaryResult(req, res, asBinaryResult(buf)
.setContentType(JSON_TYPE)
.setCharacterEncoding(UTF_8));
}
@@ -752,7 +758,7 @@ public class RestApiServlet extends HttpServlet {
}
@SuppressWarnings("resource")
static void replyBinaryResult(
static long replyBinaryResult(
@Nullable HttpServletRequest req,
HttpServletResponse res,
BinaryResult bin) throws IOException {
@@ -783,10 +789,13 @@ public class RestApiServlet extends HttpServlet {
}
if (req == null || !"HEAD".equals(req.getMethod())) {
try (OutputStream dst = res.getOutputStream()) {
try (CountingOutputStream dst =
new CountingOutputStream(res.getOutputStream())) {
bin.writeTo(dst);
return dst.getCount();
}
}
return 0;
} finally {
appResult.close();
}
@@ -993,7 +1002,7 @@ public class RestApiServlet extends HttpServlet {
viewData.pluginName, viewData.view.getClass());
}
private static void handleException(Throwable err, HttpServletRequest req,
private static long handleException(Throwable err, HttpServletRequest req,
HttpServletResponse res) throws IOException {
String uri = req.getRequestURI();
if (!Strings.isNullOrEmpty(req.getQueryString())) {
@@ -1003,16 +1012,17 @@ public class RestApiServlet extends HttpServlet {
if (!res.isCommitted()) {
res.reset();
replyError(req, res, SC_INTERNAL_SERVER_ERROR, "Internal server error", err);
return replyError(req, res, SC_INTERNAL_SERVER_ERROR, "Internal server error", err);
}
return 0;
}
public static void replyError(HttpServletRequest req, HttpServletResponse res,
public static long replyError(HttpServletRequest req, HttpServletResponse res,
int statusCode, String msg, @Nullable Throwable err) throws IOException {
replyError(req, res, statusCode, msg, CacheControl.NONE, err);
return replyError(req, res, statusCode, msg, CacheControl.NONE, err);
}
public static void replyError(HttpServletRequest req,
public static long replyError(HttpServletRequest req,
HttpServletResponse res, int statusCode, String msg,
CacheControl c, @Nullable Throwable err) throws IOException {
if (err != null) {
@@ -1020,18 +1030,18 @@ public class RestApiServlet extends HttpServlet {
}
configureCaching(req, res, null, null, c);
res.setStatus(statusCode);
replyText(req, res, msg);
return replyText(req, res, msg);
}
static void replyText(@Nullable HttpServletRequest req,
static long replyText(@Nullable HttpServletRequest req,
HttpServletResponse res, String text) throws IOException {
if ((req == null || isGetOrHead(req)) && isMaybeHTML(text)) {
replyJson(req, res, ImmutableMultimap.of("pp", "0"), new JsonPrimitive(text));
return replyJson(req, res, ImmutableMultimap.of("pp", "0"), new JsonPrimitive(text));
} else {
if (!text.endsWith("\n")) {
text += "\n";
}
replyBinaryResult(req, res,
return replyBinaryResult(req, res,
BinaryResult.create(text).setContentType("text/plain"));
}
}