You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@polaris.apache.org by em...@apache.org on 2024/11/12 18:09:39 UTC

(polaris) branch main updated: Make requests emit metrics when rate limited (#423)

This is an automated email from the ASF dual-hosted git repository.

emaynard pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git


The following commit(s) were added to refs/heads/main by this push:
     new 455423d7 Make requests emit metrics when rate limited (#423)
455423d7 is described below

commit 455423d774fb128fd70e7a605c738960b59ca4e4
Author: Andrew Guterman <an...@gmail.com>
AuthorDate: Tue Nov 12 10:09:34 2024 -0800

    Make requests emit metrics when rate limited (#423)
---
 .../apache/polaris/service/PolarisApplication.java |  5 +-
 .../service/TimedApplicationEventListener.java     |  6 +--
 .../service/ratelimiter/RateLimiterFilter.java     | 24 ++++------
 .../service/ratelimiter/RateLimiterFilterTest.java | 53 ++++++++++++++++++++--
 4 files changed, 60 insertions(+), 28 deletions(-)

diff --git a/polaris-service/src/main/java/org/apache/polaris/service/PolarisApplication.java b/polaris-service/src/main/java/org/apache/polaris/service/PolarisApplication.java
index 8ccfccf1..908496da 100644
--- a/polaris-service/src/main/java/org/apache/polaris/service/PolarisApplication.java
+++ b/polaris-service/src/main/java/org/apache/polaris/service/PolarisApplication.java
@@ -263,10 +263,7 @@ public class PolarisApplication extends Application<PolarisApplicationConfig> {
         .addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true, "/*");
 
     if (configuration.getRateLimiter() != null) {
-      environment
-          .servlets()
-          .addFilter("ratelimiter", new RateLimiterFilter(configuration.getRateLimiter()))
-          .addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true, "/*");
+      environment.jersey().register(new RateLimiterFilter(configuration.getRateLimiter()));
     }
 
     DiscoverableAuthenticator<String, AuthenticatedPolarisPrincipal> authenticator =
diff --git a/polaris-service/src/main/java/org/apache/polaris/service/TimedApplicationEventListener.java b/polaris-service/src/main/java/org/apache/polaris/service/TimedApplicationEventListener.java
index cf24ab69..e4ab8afd 100644
--- a/polaris-service/src/main/java/org/apache/polaris/service/TimedApplicationEventListener.java
+++ b/polaris-service/src/main/java/org/apache/polaris/service/TimedApplicationEventListener.java
@@ -66,16 +66,16 @@ public class TimedApplicationEventListener implements ApplicationEventListener {
     @Override
     public void onEvent(RequestEvent event) {
       String realmId = CallContext.getCurrentContext().getRealmContext().getRealmIdentifier();
-      if (event.getType() == RequestEvent.Type.RESOURCE_METHOD_START) {
+      if (event.getType() == RequestEvent.Type.REQUEST_MATCHED) {
         Method method =
             event.getUriInfo().getMatchedResourceMethod().getInvocable().getHandlingMethod();
         if (method.isAnnotationPresent(TimedApi.class)) {
           TimedApi timedApi = method.getAnnotation(TimedApi.class);
           metric = timedApi.value();
-          sw = Stopwatch.createStarted();
           polarisMetricRegistry.incrementCounter(metric, realmId);
         }
-
+      } else if (event.getType() == RequestEvent.Type.RESOURCE_METHOD_START && metric != null) {
+        sw = Stopwatch.createStarted();
       } else if (event.getType() == RequestEvent.Type.FINISHED && metric != null) {
         if (event.isSuccess()) {
           sw.stop();
diff --git a/polaris-service/src/main/java/org/apache/polaris/service/ratelimiter/RateLimiterFilter.java b/polaris-service/src/main/java/org/apache/polaris/service/ratelimiter/RateLimiterFilter.java
index 580da51f..034717c4 100644
--- a/polaris-service/src/main/java/org/apache/polaris/service/ratelimiter/RateLimiterFilter.java
+++ b/polaris-service/src/main/java/org/apache/polaris/service/ratelimiter/RateLimiterFilter.java
@@ -18,22 +18,17 @@
  */
 package org.apache.polaris.service.ratelimiter;
 
-import jakarta.annotation.Priority;
-import jakarta.servlet.Filter;
-import jakarta.servlet.FilterChain;
-import jakarta.servlet.ServletException;
-import jakarta.servlet.ServletRequest;
-import jakarta.servlet.ServletResponse;
-import jakarta.servlet.http.HttpServletResponse;
-import jakarta.ws.rs.Priorities;
+import jakarta.ws.rs.container.ContainerRequestContext;
+import jakarta.ws.rs.container.ContainerRequestFilter;
 import jakarta.ws.rs.core.Response;
 import java.io.IOException;
+import javax.ws.rs.ext.Provider;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /** Request filter that returns a 429 Too Many Requests if the rate limiter says so */
-@Priority(Priorities.AUTHORIZATION + 1)
-public class RateLimiterFilter implements Filter {
+@Provider
+public class RateLimiterFilter implements ContainerRequestFilter {
   private static final Logger LOGGER = LoggerFactory.getLogger(RateLimiterFilter.class);
 
   private final RateLimiter rateLimiter;
@@ -44,13 +39,10 @@ public class RateLimiterFilter implements Filter {
 
   /** Returns a 429 if the rate limiter says so. Otherwise, forwards the request along. */
   @Override
-  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
-      throws IOException, ServletException {
-    if (response instanceof HttpServletResponse servletResponse && !rateLimiter.tryAcquire()) {
-      servletResponse.setStatus(Response.Status.TOO_MANY_REQUESTS.getStatusCode());
+  public void filter(ContainerRequestContext ctx) throws IOException {
+    if (!rateLimiter.tryAcquire()) {
+      ctx.abortWith(Response.status(Response.Status.TOO_MANY_REQUESTS).build());
       LOGGER.atDebug().log("Rate limiting request");
-      return;
     }
-    chain.doFilter(request, response);
   }
 }
diff --git a/polaris-service/src/test/java/org/apache/polaris/service/ratelimiter/RateLimiterFilterTest.java b/polaris-service/src/test/java/org/apache/polaris/service/ratelimiter/RateLimiterFilterTest.java
index aa25afd2..90c72a7d 100644
--- a/polaris-service/src/test/java/org/apache/polaris/service/ratelimiter/RateLimiterFilterTest.java
+++ b/polaris-service/src/test/java/org/apache/polaris/service/ratelimiter/RateLimiterFilterTest.java
@@ -18,6 +18,9 @@
  */
 package org.apache.polaris.service.ratelimiter;
 
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
 import io.dropwizard.testing.ConfigOverride;
 import io.dropwizard.testing.ResourceHelpers;
 import io.dropwizard.testing.junit5.DropwizardAppExtension;
@@ -25,14 +28,15 @@ import io.dropwizard.testing.junit5.DropwizardExtensionsSupport;
 import jakarta.ws.rs.core.Response;
 import java.time.Duration;
 import java.util.function.Consumer;
-import org.apache.polaris.core.context.CallContext;
 import org.apache.polaris.service.PolarisApplication;
 import org.apache.polaris.service.config.PolarisApplicationConfig;
 import org.apache.polaris.service.test.PolarisConnectionExtension;
 import org.apache.polaris.service.test.PolarisRealm;
 import org.apache.polaris.service.test.SnowmanCredentialsExtension;
 import org.apache.polaris.service.test.TestEnvironmentExtension;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.threeten.extra.MutableClock;
@@ -62,6 +66,7 @@ public class RateLimiterFilterTest {
 
   private static String userToken;
   private static String realm;
+  private static MutableClock clock = MockRealmTokenBucketRateLimiter.CLOCK;
 
   @BeforeAll
   public static void setup(
@@ -70,20 +75,58 @@ public class RateLimiterFilterTest {
     RateLimiterFilterTest.userToken = userToken.token();
   }
 
+  @BeforeEach
+  @AfterEach
+  public void resetRateLimiter() {
+    clock.add(
+        Duration.ofSeconds(2 * WINDOW_SECONDS)); // Clear any counters from before/after this test
+  }
+
   @Test
   public void testRateLimiter() {
     Consumer<Response.Status> requestAsserter =
         TestUtil.constructRequestAsserter(EXT, userToken, realm);
-    CallContext.setCurrentContext(CallContext.of(() -> "myrealm", null));
 
-    MutableClock clock = MockRealmTokenBucketRateLimiter.CLOCK;
-    clock.add(Duration.ofSeconds(2 * WINDOW_SECONDS)); // Clear any counters from before this test
+    for (int i = 0; i < REQUESTS_PER_SECOND * WINDOW_SECONDS; i++) {
+      requestAsserter.accept(Response.Status.OK);
+    }
+    requestAsserter.accept(Response.Status.TOO_MANY_REQUESTS);
+
+    // Ensure that a different realm identifier gets a separate limit
+    Consumer<Response.Status> requestAsserter2 =
+        TestUtil.constructRequestAsserter(EXT, userToken, realm + "2");
+    requestAsserter2.accept(Response.Status.OK);
+  }
+
+  @Test
+  public void testMetricsAreEmittedWhenRateLimiting() {
+    Consumer<Response.Status> requestAsserter =
+        TestUtil.constructRequestAsserter(EXT, userToken, realm);
 
     for (int i = 0; i < REQUESTS_PER_SECOND * WINDOW_SECONDS; i++) {
       requestAsserter.accept(Response.Status.OK);
     }
     requestAsserter.accept(Response.Status.TOO_MANY_REQUESTS);
 
-    clock.add(Duration.ofSeconds(4 * WINDOW_SECONDS)); // Clear any counters from during this test
+    assertTrue(
+        getCounter(
+                "polaris_principal_roles_listPrincipalRoles_error_total{HTTP_RESPONSE_CODE=\"429\"}")
+            > 0);
+  }
+
+  private double getCounter(String metricName) {
+    Response response =
+        EXT.client()
+            .target(String.format("http://localhost:%d/metrics", EXT.getAdminPort()))
+            .request()
+            .get();
+    assertThat(response).returns(Response.Status.OK.getStatusCode(), Response::getStatus);
+    String[] responseLines = response.readEntity(String.class).split("\n");
+    for (String line : responseLines) {
+      if (line.startsWith(metricName)) {
+        return Double.parseDouble(line.split(" ")[1]);
+      }
+    }
+    return 0;
   }
 }