Add EPP metrics to flows

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=132591518
This commit is contained in:
shikhman 2016-09-08 13:12:49 -07:00 committed by Ben McIlwain
parent 36c6d59fee
commit aa4ca42cdd
4 changed files with 88 additions and 9 deletions

View file

@ -44,6 +44,7 @@ java_library(
"//java/google/registry/mapreduce", "//java/google/registry/mapreduce",
"//java/google/registry/mapreduce/inputs", "//java/google/registry/mapreduce/inputs",
"//java/google/registry/model", "//java/google/registry/model",
"//java/google/registry/monitoring/metrics",
"//java/google/registry/monitoring/whitebox", "//java/google/registry/monitoring/whitebox",
"//java/google/registry/pricing", "//java/google/registry/pricing",
"//java/google/registry/request", "//java/google/registry/request",

View file

@ -42,7 +42,8 @@ public final class EppController {
@Inject Clock clock; @Inject Clock clock;
@Inject FlowComponent.Builder flowComponentBuilder; @Inject FlowComponent.Builder flowComponentBuilder;
@Inject EppMetric.Builder metric; @Inject EppMetric.Builder metricBuilder;
@Inject EppMetrics eppMetrics;
@Inject BigQueryMetricsEnqueuer bigQueryMetricsEnqueuer; @Inject BigQueryMetricsEnqueuer bigQueryMetricsEnqueuer;
@Inject EppController() {} @Inject EppController() {}
@ -54,20 +55,20 @@ public final class EppController {
boolean isDryRun, boolean isDryRun,
boolean isSuperuser, boolean isSuperuser,
byte[] inputXmlBytes) { byte[] inputXmlBytes) {
metric.setClientId(sessionMetadata.getClientId()); metricBuilder.setClientId(sessionMetadata.getClientId());
metric.setPrivilegeLevel(isSuperuser ? "SUPERUSER" : "NORMAL"); metricBuilder.setPrivilegeLevel(isSuperuser ? "SUPERUSER" : "NORMAL");
try { try {
EppInput eppInput; EppInput eppInput;
try { try {
eppInput = unmarshal(EppInput.class, inputXmlBytes); eppInput = unmarshal(EppInput.class, inputXmlBytes);
} catch (EppException e) { } catch (EppException e) {
// Send the client an error message, with no clTRID since we couldn't unmarshal it. // Send the client an error message, with no clTRID since we couldn't unmarshal it.
metric.setStatus(e.getResult().getCode()); metricBuilder.setStatus(e.getResult().getCode());
return getErrorResponse(clock, e.getResult(), Trid.create(null)); return getErrorResponse(clock, e.getResult(), Trid.create(null));
} }
metric.setCommandName(eppInput.getCommandName()); metricBuilder.setCommandName(eppInput.getCommandName());
if (!eppInput.getTargetIds().isEmpty()) { if (!eppInput.getTargetIds().isEmpty()) {
metric.setEppTarget(Joiner.on(',').join(eppInput.getTargetIds())); metricBuilder.setEppTarget(Joiner.on(',').join(eppInput.getTargetIds()));
} }
EppOutput output = runFlowConvertEppErrors(flowComponentBuilder EppOutput output = runFlowConvertEppErrors(flowComponentBuilder
.flowModule(new FlowModule.Builder() .flowModule(new FlowModule.Builder()
@ -81,11 +82,14 @@ public final class EppController {
.build()) .build())
.build()); .build());
if (output.isResponse()) { if (output.isResponse()) {
metric.setStatus(output.getResponse().getResult().getCode()); metricBuilder.setStatus(output.getResponse().getResult().getCode());
} }
return output; return output;
} finally { } finally {
bigQueryMetricsEnqueuer.export(metric.build()); EppMetric metric = metricBuilder.build();
bigQueryMetricsEnqueuer.export(metric);
eppMetrics.incrementEppRequests(metric);
eppMetrics.recordProcessingTime(metric);
} }
} }

View file

@ -0,0 +1,72 @@
// Copyright 2016 The Domain Registry Authors. All Rights Reserved.
//
// 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 google.registry.flows;
import com.google.common.collect.ImmutableSet;
import google.registry.monitoring.metrics.EventMetric;
import google.registry.monitoring.metrics.IncrementableMetric;
import google.registry.monitoring.metrics.LabelDescriptor;
import google.registry.monitoring.metrics.MetricRegistryImpl;
import google.registry.monitoring.whitebox.EppMetric;
import javax.inject.Inject;
/** EPP Instrumentation. */
public class EppMetrics {
private static final ImmutableSet<LabelDescriptor> LABEL_DESCRIPTORS =
ImmutableSet.of(
LabelDescriptor.create("command", "The name of the command."),
LabelDescriptor.create("client_id", "The name of the client."),
LabelDescriptor.create("status", "The return status of the command."));
private static final IncrementableMetric eppRequests =
MetricRegistryImpl.getDefault()
.newIncrementableMetric(
"/epp/requests", "Count of EPP Requests", "count", LABEL_DESCRIPTORS);
private static final EventMetric processingTime =
MetricRegistryImpl.getDefault()
.newEventMetric(
"/epp/processing_time",
"EPP Processing Time",
"milliseconds",
LABEL_DESCRIPTORS,
EventMetric.DEFAULT_FITTER);
@Inject
public EppMetrics() {}
/**
* Increment a counter which tracks EPP requests.
*
* @see EppController
* @see FlowRunner
*/
public void incrementEppRequests(EppMetric metric) {
eppRequests.increment(
metric.getCommandName().or(""),
metric.getClientId().or(""),
metric.getStatus().isPresent() ? metric.getStatus().toString() : "");
}
/** Record the server-side processing time for an EPP request. */
public void recordProcessingTime(EppMetric metric) {
processingTime.record(
metric.getEndTimestamp().getMillis() - metric.getStartTimestamp().getMillis(),
metric.getCommandName().or(""),
metric.getClientId().or(""),
metric.getStatus().isPresent() ? metric.getStatus().toString() : "");
}
}

View file

@ -52,6 +52,7 @@ public class EppControllerTest extends ShardableTestCase {
@Mock SessionMetadata sessionMetadata; @Mock SessionMetadata sessionMetadata;
@Mock TransportCredentials transportCredentials; @Mock TransportCredentials transportCredentials;
@Mock EppMetrics eppMetrics;
@Mock BigQueryMetricsEnqueuer metricsEnqueuer; @Mock BigQueryMetricsEnqueuer metricsEnqueuer;
@Mock FlowComponent.Builder flowComponentBuilder; @Mock FlowComponent.Builder flowComponentBuilder;
@Mock FlowComponent flowComponent; @Mock FlowComponent flowComponent;
@ -76,10 +77,11 @@ public class EppControllerTest extends ShardableTestCase {
when(result.getCode()).thenReturn(Code.SuccessWithNoMessages); when(result.getCode()).thenReturn(Code.SuccessWithNoMessages);
eppController = new EppController(); eppController = new EppController();
eppController.metric = new EppMetric.Builder(); eppController.metricBuilder = new EppMetric.Builder();
eppController.bigQueryMetricsEnqueuer = metricsEnqueuer; eppController.bigQueryMetricsEnqueuer = metricsEnqueuer;
eppController.clock = new FakeClock(); eppController.clock = new FakeClock();
eppController.flowComponentBuilder = flowComponentBuilder; eppController.flowComponentBuilder = flowComponentBuilder;
eppController.eppMetrics = eppMetrics;
} }
@Test @Test