From aa36dc95ef7200359cbf3d18e97e1957e30f2575 Mon Sep 17 00:00:00 2001
From: Chris Eager <chris@signal.org>
Date: Wed, 27 Jul 2022 14:58:12 -0500
Subject: [PATCH] Add `MicrometerCommandLatencyRecorder` to Redis clusters

---
 .../textsecuregcm/WhisperServerService.java   | 18 ++++++++----
 .../metrics/LettuceMetricsMeterFilter.java    | 29 +++++++++++++++++++
 2 files changed, 41 insertions(+), 6 deletions(-)
 create mode 100644 service/src/main/java/org/whispersystems/textsecuregcm/metrics/LettuceMetricsMeterFilter.java

diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java b/service/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java
index f0d6b08cf..84c395ecf 100644
--- a/service/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java
+++ b/service/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java
@@ -25,6 +25,8 @@ import io.dropwizard.auth.basic.BasicCredentialAuthFilter;
 import io.dropwizard.auth.basic.BasicCredentials;
 import io.dropwizard.setup.Bootstrap;
 import io.dropwizard.setup.Environment;
+import io.lettuce.core.metrics.MicrometerCommandLatencyRecorder;
+import io.lettuce.core.metrics.MicrometerOptions;
 import io.lettuce.core.resource.ClientResources;
 import io.micrometer.core.instrument.Meter.Id;
 import io.micrometer.core.instrument.Metrics;
@@ -125,6 +127,7 @@ import org.whispersystems.textsecuregcm.metrics.CpuUsageGauge;
 import org.whispersystems.textsecuregcm.metrics.FileDescriptorGauge;
 import org.whispersystems.textsecuregcm.metrics.FreeMemoryGauge;
 import org.whispersystems.textsecuregcm.metrics.GarbageCollectionGauges;
+import org.whispersystems.textsecuregcm.metrics.LettuceMetricsMeterFilter;
 import org.whispersystems.textsecuregcm.metrics.MaxFileDescriptorGauge;
 import org.whispersystems.textsecuregcm.metrics.MetricsApplicationEventListener;
 import org.whispersystems.textsecuregcm.metrics.MetricsRequestEventListener;
@@ -263,15 +266,16 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
           config.getDatadogConfiguration(), io.micrometer.core.instrument.Clock.SYSTEM);
 
       datadogMeterRegistry.config().commonTags(
-          Tags.of(
-              "service", "chat",
-              "host", HostnameUtil.getLocalHostname(),
-              "version", WhisperServerVersion.getServerVersion(),
-              "env", config.getDatadogConfiguration().getEnvironment()))
+              Tags.of(
+                  "service", "chat",
+                  "host", HostnameUtil.getLocalHostname(),
+                  "version", WhisperServerVersion.getServerVersion(),
+                  "env", config.getDatadogConfiguration().getEnvironment()))
           .meterFilter(MeterFilter.denyNameStartsWith(MetricsRequestEventListener.REQUEST_COUNTER_NAME))
           .meterFilter(MeterFilter.denyNameStartsWith(MetricsRequestEventListener.ANDROID_REQUEST_COUNTER_NAME))
           .meterFilter(MeterFilter.denyNameStartsWith(MetricsRequestEventListener.DESKTOP_REQUEST_COUNTER_NAME))
           .meterFilter(MeterFilter.denyNameStartsWith(MetricsRequestEventListener.IOS_REQUEST_COUNTER_NAME))
+          .meterFilter(new LettuceMetricsMeterFilter())
           .meterFilter(new MeterFilter() {
             @Override
             public DistributionStatisticConfig configure(final Id id, final DistributionStatisticConfig config) {
@@ -355,7 +359,9 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
     RedisClientFactory  pubSubClientFactory = new RedisClientFactory("pubsub_cache", config.getPubsubCacheConfiguration().getUrl(), config.getPubsubCacheConfiguration().getReplicaUrls(), config.getPubsubCacheConfiguration().getCircuitBreakerConfiguration());
     ReplicatedJedisPool pubsubClient        = pubSubClientFactory.getRedisClientPool();
 
-    ClientResources redisClientResources = ClientResources.builder().build();
+    MicrometerOptions options = MicrometerOptions.builder().build();
+    ClientResources redisClientResources = ClientResources.builder()
+        .commandLatencyRecorder(new MicrometerCommandLatencyRecorder(Metrics.globalRegistry, options)).build();
     ConnectionEventLogger.logConnectionEvents(redisClientResources);
 
     FaultTolerantRedisCluster cacheCluster             = new FaultTolerantRedisCluster("main_cache_cluster", config.getCacheClusterConfiguration(), redisClientResources);
diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/metrics/LettuceMetricsMeterFilter.java b/service/src/main/java/org/whispersystems/textsecuregcm/metrics/LettuceMetricsMeterFilter.java
new file mode 100644
index 000000000..b5a53d3e6
--- /dev/null
+++ b/service/src/main/java/org/whispersystems/textsecuregcm/metrics/LettuceMetricsMeterFilter.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2022 Signal Messenger, LLC
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+package org.whispersystems.textsecuregcm.metrics;
+
+import io.micrometer.core.instrument.Meter;
+import io.micrometer.core.instrument.config.MeterFilter;
+
+public class LettuceMetricsMeterFilter implements MeterFilter {
+
+  private static final String METRIC_NAME_PREFIX = "lettuce.command";
+  private static final String REMOTE_TAG = "remote";
+
+  // the `remote` tag is very high-cardinality, so we ignore it.
+  // In the future, it would be nice to map a remote (address:port) to a logical cluster name
+  private static final MeterFilter IGNORE_TAGS_FILTER = MeterFilter.ignoreTags(REMOTE_TAG);
+
+  @Override
+  public Meter.Id map(final Meter.Id id) {
+
+    if (id.getName().startsWith(METRIC_NAME_PREFIX)) {
+      return IGNORE_TAGS_FILTER.map(id);
+    }
+
+    return id;
+  }
+}