Differentiate between websocket and "boring" HTTP traffic.

This commit is contained in:
Jon Chambers 2020-05-27 17:36:04 -04:00 committed by Jon Chambers
parent f18ab9e5cc
commit 228ffcbfce
5 changed files with 37 additions and 22 deletions

View File

@ -86,6 +86,7 @@ import org.whispersystems.textsecuregcm.metrics.FreeMemoryGauge;
import org.whispersystems.textsecuregcm.metrics.MetricsApplicationEventListener; import org.whispersystems.textsecuregcm.metrics.MetricsApplicationEventListener;
import org.whispersystems.textsecuregcm.metrics.NetworkReceivedGauge; import org.whispersystems.textsecuregcm.metrics.NetworkReceivedGauge;
import org.whispersystems.textsecuregcm.metrics.NetworkSentGauge; import org.whispersystems.textsecuregcm.metrics.NetworkSentGauge;
import org.whispersystems.textsecuregcm.metrics.TrafficSource;
import org.whispersystems.textsecuregcm.providers.RedisClientFactory; import org.whispersystems.textsecuregcm.providers.RedisClientFactory;
import org.whispersystems.textsecuregcm.providers.RedisHealthCheck; import org.whispersystems.textsecuregcm.providers.RedisHealthCheck;
import org.whispersystems.textsecuregcm.push.APNSender; import org.whispersystems.textsecuregcm.push.APNSender;
@ -318,7 +319,7 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
AuthFilter<BasicCredentials, Account> accountAuthFilter = new BasicCredentialAuthFilter.Builder<Account>().setAuthenticator(accountAuthenticator).buildAuthFilter (); AuthFilter<BasicCredentials, Account> accountAuthFilter = new BasicCredentialAuthFilter.Builder<Account>().setAuthenticator(accountAuthenticator).buildAuthFilter ();
AuthFilter<BasicCredentials, DisabledPermittedAccount> disabledPermittedAccountAuthFilter = new BasicCredentialAuthFilter.Builder<DisabledPermittedAccount>().setAuthenticator(disabledPermittedAccountAuthenticator).buildAuthFilter(); AuthFilter<BasicCredentials, DisabledPermittedAccount> disabledPermittedAccountAuthFilter = new BasicCredentialAuthFilter.Builder<DisabledPermittedAccount>().setAuthenticator(disabledPermittedAccountAuthenticator).buildAuthFilter();
environment.jersey().register(new MetricsApplicationEventListener()); environment.jersey().register(new MetricsApplicationEventListener(TrafficSource.HTTP));
environment.jersey().register(new PolymorphicAuthDynamicFeature<>(ImmutableMap.of(Account.class, accountAuthFilter, environment.jersey().register(new PolymorphicAuthDynamicFeature<>(ImmutableMap.of(Account.class, accountAuthFilter,
DisabledPermittedAccount.class, disabledPermittedAccountAuthFilter))); DisabledPermittedAccount.class, disabledPermittedAccountAuthFilter)));
@ -347,7 +348,7 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
WebSocketEnvironment<Account> webSocketEnvironment = new WebSocketEnvironment<>(environment, config.getWebSocketConfiguration(), 90000); WebSocketEnvironment<Account> webSocketEnvironment = new WebSocketEnvironment<>(environment, config.getWebSocketConfiguration(), 90000);
webSocketEnvironment.setAuthenticator(new WebSocketAccountAuthenticator(accountAuthenticator)); webSocketEnvironment.setAuthenticator(new WebSocketAccountAuthenticator(accountAuthenticator));
webSocketEnvironment.setConnectListener(new AuthenticatedConnectListener(pushSender, receiptSender, messagesManager, pubSubManager, apnFallbackManager)); webSocketEnvironment.setConnectListener(new AuthenticatedConnectListener(pushSender, receiptSender, messagesManager, pubSubManager, apnFallbackManager));
webSocketEnvironment.jersey().register(new MetricsApplicationEventListener()); webSocketEnvironment.jersey().register(new MetricsApplicationEventListener(TrafficSource.WEBSOCKET));
webSocketEnvironment.jersey().register(new KeepAliveController(pubSubManager)); webSocketEnvironment.jersey().register(new KeepAliveController(pubSubManager));
webSocketEnvironment.jersey().register(messageController); webSocketEnvironment.jersey().register(messageController);
webSocketEnvironment.jersey().register(profileController); webSocketEnvironment.jersey().register(profileController);
@ -358,7 +359,7 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
WebSocketEnvironment<Account> provisioningEnvironment = new WebSocketEnvironment<>(environment, webSocketEnvironment.getRequestLog(), 60000); WebSocketEnvironment<Account> provisioningEnvironment = new WebSocketEnvironment<>(environment, webSocketEnvironment.getRequestLog(), 60000);
provisioningEnvironment.setConnectListener(new ProvisioningConnectListener(pubSubManager)); provisioningEnvironment.setConnectListener(new ProvisioningConnectListener(pubSubManager));
provisioningEnvironment.jersey().register(new MetricsApplicationEventListener()); provisioningEnvironment.jersey().register(new MetricsApplicationEventListener(TrafficSource.WEBSOCKET));
provisioningEnvironment.jersey().register(new KeepAliveController(pubSubManager)); provisioningEnvironment.jersey().register(new KeepAliveController(pubSubManager));
registerCorsFilter(environment); registerCorsFilter(environment);

View File

@ -10,7 +10,11 @@ import org.glassfish.jersey.server.monitoring.RequestEventListener;
*/ */
public class MetricsApplicationEventListener implements ApplicationEventListener { public class MetricsApplicationEventListener implements ApplicationEventListener {
private final MetricsRequestEventListener metricsRequestEventListener = new MetricsRequestEventListener(); private final MetricsRequestEventListener metricsRequestEventListener;
public MetricsApplicationEventListener(final TrafficSource trafficSource) {
this.metricsRequestEventListener = new MetricsRequestEventListener(trafficSource);
}
@Override @Override
public void onEvent(final ApplicationEvent event) { public void onEvent(final ApplicationEvent event) {

View File

@ -17,19 +17,22 @@ import java.util.List;
*/ */
class MetricsRequestEventListener implements RequestEventListener { class MetricsRequestEventListener implements RequestEventListener {
static final String COUNTER_NAME = MetricRegistry.name(MetricsRequestEventListener.class, "request"); static final String COUNTER_NAME = MetricRegistry.name(MetricsRequestEventListener.class, "request");
static final String PATH_TAG = "path"; static final String PATH_TAG = "path";
static final String STATUS_CODE_TAG = "status"; static final String STATUS_CODE_TAG = "status";
static final String TRAFFIC_SOURCE_TAG = "trafficSource";
private final MeterRegistry meterRegistry; private final TrafficSource trafficSource;
private final MeterRegistry meterRegistry;
public MetricsRequestEventListener() { public MetricsRequestEventListener(final TrafficSource trafficSource) {
this(Metrics.globalRegistry); this(trafficSource, Metrics.globalRegistry);
} }
@VisibleForTesting @VisibleForTesting
MetricsRequestEventListener(final MeterRegistry meterRegistry) { MetricsRequestEventListener(final TrafficSource trafficSource, final MeterRegistry meterRegistry) {
this.trafficSource = trafficSource;
this.meterRegistry = meterRegistry; this.meterRegistry = meterRegistry;
} }
@ -37,9 +40,10 @@ class MetricsRequestEventListener implements RequestEventListener {
public void onEvent(final RequestEvent event) { public void onEvent(final RequestEvent event) {
if (event.getType() == RequestEvent.Type.FINISHED) { if (event.getType() == RequestEvent.Type.FINISHED) {
if (!event.getUriInfo().getMatchedTemplates().isEmpty()) { if (!event.getUriInfo().getMatchedTemplates().isEmpty()) {
final List<Tag> tags = new ArrayList<>(4); final List<Tag> tags = new ArrayList<>(5);
tags.add(Tag.of(PATH_TAG, getPathTemplate(event.getUriInfo()))); tags.add(Tag.of(PATH_TAG, getPathTemplate(event.getUriInfo())));
tags.add(Tag.of(STATUS_CODE_TAG, String.valueOf(event.getContainerResponse().getStatus()))); tags.add(Tag.of(STATUS_CODE_TAG, String.valueOf(event.getContainerResponse().getStatus())));
tags.add(Tag.of(TRAFFIC_SOURCE_TAG, trafficSource.name().toLowerCase()));
event.getContainerRequest().getRequestHeader("User-Agent") event.getContainerRequest().getRequestHeader("User-Agent")
.stream() .stream()

View File

@ -0,0 +1,6 @@
package org.whispersystems.textsecuregcm.metrics;
public enum TrafficSource {
HTTP,
WEBSOCKET
}

View File

@ -3,7 +3,6 @@ package org.whispersystems.textsecuregcm.metrics;
import io.micrometer.core.instrument.Counter; import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry; import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag; import io.micrometer.core.instrument.Tag;
import org.bouncycastle.ocsp.Req;
import org.glassfish.jersey.server.ContainerRequest; import org.glassfish.jersey.server.ContainerRequest;
import org.glassfish.jersey.server.ContainerResponse; import org.glassfish.jersey.server.ContainerResponse;
import org.glassfish.jersey.server.ExtendedUriInfo; import org.glassfish.jersey.server.ExtendedUriInfo;
@ -13,15 +12,13 @@ import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import org.mockito.ArgumentCaptor; import org.mockito.ArgumentCaptor;
import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.Collections; import java.util.Collections;
import java.util.HashSet; import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set; import java.util.Set;
import static org.junit.Assert.*; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq; import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mock;
@ -30,17 +27,19 @@ import static org.mockito.Mockito.when;
public class MetricsRequestEventListenerTest { public class MetricsRequestEventListenerTest {
private MeterRegistry meterRegistry; private MeterRegistry meterRegistry;
private Counter counter; private Counter counter;
private MetricsRequestEventListener listener; private MetricsRequestEventListener listener;
private static final TrafficSource TRAFFIC_SOURCE = TrafficSource.HTTP;
@Before @Before
public void setup() { public void setup() {
meterRegistry = mock(MeterRegistry.class); meterRegistry = mock(MeterRegistry.class);
counter = mock(Counter.class); counter = mock(Counter.class);
listener = new MetricsRequestEventListener(meterRegistry); listener = new MetricsRequestEventListener(TRAFFIC_SOURCE, meterRegistry);
} }
@Test @Test
@ -78,9 +77,10 @@ public class MetricsRequestEventListenerTest {
tags.add(tag); tags.add(tag);
} }
assertEquals(4, tags.size()); assertEquals(5, tags.size());
assertTrue(tags.contains(Tag.of(MetricsRequestEventListener.PATH_TAG, path))); assertTrue(tags.contains(Tag.of(MetricsRequestEventListener.PATH_TAG, path)));
assertTrue(tags.contains(Tag.of(MetricsRequestEventListener.STATUS_CODE_TAG, String.valueOf(statusCode)))); assertTrue(tags.contains(Tag.of(MetricsRequestEventListener.STATUS_CODE_TAG, String.valueOf(statusCode))));
assertTrue(tags.contains(Tag.of(MetricsRequestEventListener.TRAFFIC_SOURCE_TAG, TRAFFIC_SOURCE.name().toLowerCase())));
assertTrue(tags.contains(Tag.of(UserAgentTagUtil.PLATFORM_TAG, "android"))); assertTrue(tags.contains(Tag.of(UserAgentTagUtil.PLATFORM_TAG, "android")));
assertTrue(tags.contains(Tag.of(UserAgentTagUtil.VERSION_TAG, "4.53.7"))); assertTrue(tags.contains(Tag.of(UserAgentTagUtil.VERSION_TAG, "4.53.7")));
} }