datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/utils/ThrottleFilter.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START==================================================\r
   3  * * org.onap.dmaap\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * *\r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * *\r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 \r
  24 \r
  25 package org.onap.dmaap.datarouter.provisioning.utils;\r
  26 \r
  27 import java.io.IOException;\r
  28 import java.io.InputStream;\r
  29 import java.util.ArrayList;\r
  30 import java.util.HashMap;\r
  31 import java.util.List;\r
  32 import java.util.Map;\r
  33 import java.util.Timer;\r
  34 import java.util.TimerTask;\r
  35 import java.util.Vector;\r
  36 \r
  37 import javax.servlet.Filter;\r
  38 import javax.servlet.FilterChain;\r
  39 import javax.servlet.FilterConfig;\r
  40 import javax.servlet.ServletException;\r
  41 import javax.servlet.ServletRequest;\r
  42 import javax.servlet.ServletResponse;\r
  43 import javax.servlet.http.HttpServletRequest;\r
  44 import javax.servlet.http.HttpServletResponse;\r
  45 \r
  46 import com.att.eelf.configuration.EELFLogger;\r
  47 import com.att.eelf.configuration.EELFManager;\r
  48 import org.eclipse.jetty.continuation.Continuation;\r
  49 import org.eclipse.jetty.continuation.ContinuationSupport;\r
  50 import org.eclipse.jetty.server.*;\r
  51 import org.onap.dmaap.datarouter.provisioning.beans.Parameters;\r
  52 \r
  53 /**\r
  54  * This filter checks /publish requests to the provisioning server to allow ill-behaved publishers to be throttled.\r
  55  * It is configured via the provisioning parameter THROTTLE_FILTER.\r
  56  * The THROTTLE_FILTER provisioning parameter can have these values:\r
  57  * <table>\r
  58  * <tr><td>(no value)</td><td>filter disabled</td></tr>\r
  59  * <tr><td>off</td><td>filter disabled</td></tr>\r
  60  * <tr><td>N[,M[,action]]</td><td>set N, M, and action (used in the algorithm below).\r
  61  * Action is <i>drop</i> or <i>throttle</i>.\r
  62  * If M is missing, it defaults to 5 minutes.\r
  63  * If the action is missing, it defaults to <i>drop</i>.\r
  64  * </td></tr>\r
  65  * </table>\r
  66  * <p>\r
  67  * The <i>action</i> is triggered iff:\r
  68  * <ol>\r
  69  * <li>the filter is enabled, and</li>\r
  70  * <li>N /publish requests come to the provisioning server in M minutes\r
  71  * <ol>\r
  72  * <li>from the same IP address</li>\r
  73  * <li>for the same feed</li>\r
  74  * <li>lacking the <i>Expect: 100-continue</i> header</li>\r
  75  * </ol>\r
  76  * </li>\r
  77  * </ol>\r
  78  * The action that can be performed (if triggered) are:\r
  79  * <ol>\r
  80  * <li><i>drop</i> - the connection is dropped immediately.</li>\r
  81  * <li><i>throttle</i> - [not supported] the connection is put into a low priority queue with all other throttled connections.\r
  82  * These are then processed at a slower rate.  Note: this option does not work correctly, and is disabled.\r
  83  * The only action that is supported is <i>drop</i>.\r
  84  * </li>\r
  85  * </ol>\r
  86  *\r
  87  * @author Robert Eby\r
  88  * @version $Id: ThrottleFilter.java,v 1.2 2014/03/12 19:45:41 eby Exp $\r
  89  */\r
  90 public class ThrottleFilter extends TimerTask implements Filter {\r
  91     public static final int DEFAULT_N = 10;\r
  92     public static final int DEFAULT_M = 5;\r
  93     public static final String THROTTLE_MARKER = "org.onap.dmaap.datarouter.provisioning.THROTTLE_MARKER";\r
  94     private static final String JETTY_REQUEST = "org.eclipse.jetty.server.Request";\r
  95     private static final long ONE_MINUTE = 60000L;\r
  96     private static final int ACTION_DROP = 0;\r
  97     private static final int ACTION_THROTTLE = 1;\r
  98 \r
  99     // Configuration\r
 100     private static boolean enabled = false;        // enabled or not\r
 101     private static int n_requests = 0;            // number of requests in M minutes\r
 102     private static int m_minutes = 0;            // sampling period\r
 103     private static int action = ACTION_DROP;    // action to take (throttle or drop)\r
 104 \r
 105     private static EELFLogger logger = EELFManager.getInstance().getLogger("InternalLog");\r
 106     private static Map<String, Counter> map = new HashMap<>();\r
 107     private static final Timer rolex = new Timer();\r
 108 \r
 109     @Override\r
 110     public void init(FilterConfig arg0) throws ServletException {\r
 111         configure();\r
 112         rolex.scheduleAtFixedRate(this, 5 * 60000L, 5 * 60000L);    // Run once every 5 minutes to clean map\r
 113     }\r
 114 \r
 115     /**\r
 116      * Configure the throttle.  This should be called from BaseServlet.provisioningParametersChanged(), to make sure it stays up to date.\r
 117      */\r
 118     public static void configure() {\r
 119         Parameters p = Parameters.getParameter(Parameters.THROTTLE_FILTER);\r
 120         if (p != null) {\r
 121             try {\r
 122                 Class.forName(JETTY_REQUEST);\r
 123                 String v = p.getValue();\r
 124                 if (v != null && !v.equals("off")) {\r
 125                     String[] pp = v.split(",");\r
 126                     if (pp != null) {\r
 127                         n_requests = (pp.length > 0) ? getInt(pp[0], DEFAULT_N) : DEFAULT_N;\r
 128                         m_minutes = (pp.length > 1) ? getInt(pp[1], DEFAULT_M) : DEFAULT_M;\r
 129                         action = (pp.length > 2 && pp[2] != null && pp[2].equalsIgnoreCase("throttle")) ? ACTION_THROTTLE : ACTION_DROP;\r
 130                         enabled = true;\r
 131                         // ACTION_THROTTLE is not currently working, so is not supported\r
 132                         if (action == ACTION_THROTTLE) {\r
 133                             action = ACTION_DROP;\r
 134                             logger.info("Throttling is not currently supported; action changed to DROP");\r
 135                         }\r
 136                         logger.info("ThrottleFilter is ENABLED for /publish requests; N=" + n_requests + ", M=" + m_minutes + ", Action=" + action);\r
 137                         return;\r
 138                     }\r
 139                 }\r
 140             } catch (ClassNotFoundException e) {\r
 141                 logger.warn("Class " + JETTY_REQUEST + " is not available; this filter requires Jetty.", e);\r
 142             }\r
 143         }\r
 144         logger.info("ThrottleFilter is DISABLED for /publish requests.");\r
 145         enabled = false;\r
 146         map.clear();\r
 147     }\r
 148 \r
 149     private static int getInt(String s, int deflt) {\r
 150         try {\r
 151             return Integer.parseInt(s);\r
 152         } catch (NumberFormatException x) {\r
 153             return deflt;\r
 154         }\r
 155     }\r
 156 \r
 157     @Override\r
 158     public void destroy() {\r
 159         rolex.cancel();\r
 160         map.clear();\r
 161     }\r
 162 \r
 163     @Override\r
 164     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)\r
 165             throws IOException, ServletException {\r
 166         if (enabled && action == ACTION_THROTTLE) {\r
 167             throttleFilter((HttpServletRequest) request, (HttpServletResponse) response, chain);\r
 168         } else if (enabled) {\r
 169             dropFilter((HttpServletRequest) request, (HttpServletResponse) response, chain);\r
 170         } else {\r
 171             chain.doFilter(request, response);\r
 172         }\r
 173     }\r
 174 \r
 175     public void dropFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)\r
 176             throws IOException, ServletException {\r
 177         int rate = getRequestRate(request);\r
 178         if (rate >= n_requests) {\r
 179             // drop request - only works under Jetty\r
 180             String m = String.format("Dropping connection: %s %d bad connections in %d minutes", getConnectionId(request), rate, m_minutes);\r
 181             logger.info(m);\r
 182             Request base_request = (request instanceof Request)\r
 183                     ? (Request) request\r
 184                     : HttpConnection.getCurrentConnection().getHttpChannel().getRequest();\r
 185             base_request.getHttpChannel().getEndPoint().close();\r
 186         } else {\r
 187             chain.doFilter(request, response);\r
 188         }\r
 189     }\r
 190 \r
 191     public void throttleFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)\r
 192             throws IOException, ServletException {\r
 193         // throttle request\r
 194         String id = getConnectionId(request);\r
 195         int rate = getRequestRate(request);\r
 196         Object results = request.getAttribute(THROTTLE_MARKER);\r
 197         if (rate >= n_requests && results == null) {\r
 198             String m = String.format("Throttling connection: %s %d bad connections in %d minutes", getConnectionId(request), rate, m_minutes);\r
 199             logger.info(m);\r
 200             Continuation continuation = ContinuationSupport.getContinuation(request);\r
 201             continuation.suspend();\r
 202             register(id, continuation);\r
 203             continuation.undispatch();\r
 204         } else {\r
 205             chain.doFilter(request, response);\r
 206             @SuppressWarnings("resource")\r
 207             InputStream is = request.getInputStream();\r
 208             byte[] b = new byte[4096];\r
 209             int n = is.read(b);\r
 210             while (n > 0) {\r
 211                 n = is.read(b);\r
 212             }\r
 213             resume(id);\r
 214         }\r
 215     }\r
 216 \r
 217     private Map<String, List<Continuation>> suspended_requests = new HashMap<>();\r
 218 \r
 219     private void register(String id, Continuation continuation) {\r
 220         synchronized (suspended_requests) {\r
 221             List<Continuation> list = suspended_requests.get(id);\r
 222             if (list == null) {\r
 223                 list = new ArrayList<>();\r
 224                 suspended_requests.put(id, list);\r
 225             }\r
 226             list.add(continuation);\r
 227         }\r
 228     }\r
 229 \r
 230     private void resume(String id) {\r
 231         synchronized (suspended_requests) {\r
 232             List<Continuation> list = suspended_requests.get(id);\r
 233             if (list != null) {\r
 234                 // when the waited for event happens\r
 235                 Continuation continuation = list.remove(0);\r
 236                 continuation.setAttribute(ThrottleFilter.THROTTLE_MARKER, new Object());\r
 237                 continuation.resume();\r
 238             }\r
 239         }\r
 240     }\r
 241 \r
 242     /**\r
 243      * Return a count of number of requests in the last M minutes, iff this is a "bad" request.\r
 244      * If the request has been resumed (if it contains the THROTTLE_MARKER) it is considered good.\r
 245      *\r
 246      * @param request the request\r
 247      * @return number of requests in the last M minutes, 0 means it is a "good" request\r
 248      */\r
 249     private int getRequestRate(HttpServletRequest request) {\r
 250         String expecthdr = request.getHeader("Expect");\r
 251         if (expecthdr != null && expecthdr.equalsIgnoreCase("100-continue"))\r
 252             return 0;\r
 253 \r
 254         String key = getConnectionId(request);\r
 255         synchronized (map) {\r
 256             Counter cnt = map.get(key);\r
 257             if (cnt == null) {\r
 258                 cnt = new Counter();\r
 259                 map.put(key, cnt);\r
 260             }\r
 261             return cnt.getRequestRate();\r
 262         }\r
 263     }\r
 264 \r
 265     public class Counter {\r
 266         private List<Long> times = new Vector<>();    // a record of request times\r
 267 \r
 268         public int prune() {\r
 269             try {\r
 270                 long n = System.currentTimeMillis() - (m_minutes * ONE_MINUTE);\r
 271                 long t = times.get(0);\r
 272                 while (t < n) {\r
 273                     times.remove(0);\r
 274                     t = times.get(0);\r
 275                 }\r
 276             } catch (IndexOutOfBoundsException e) {\r
 277                 logger.trace("Exception: " + e.getMessage(), e);\r
 278             }\r
 279             return times.size();\r
 280         }\r
 281 \r
 282         public int getRequestRate() {\r
 283             times.add(System.currentTimeMillis());\r
 284             return prune();\r
 285         }\r
 286     }\r
 287 \r
 288     /**\r
 289      * Identify a connection by endpoint IP address, and feed ID.\r
 290      */\r
 291     private String getConnectionId(HttpServletRequest req) {\r
 292         return req.getRemoteAddr() + "/" + getFeedId(req);\r
 293     }\r
 294 \r
 295     private int getFeedId(HttpServletRequest req) {\r
 296         String path = req.getPathInfo();\r
 297         if (path == null || path.length() < 2)\r
 298             return -1;\r
 299         path = path.substring(1);\r
 300         int ix = path.indexOf('/');\r
 301         if (ix < 0 || ix == path.length() - 1)\r
 302             return -2;\r
 303         try {\r
 304             return Integer.parseInt(path.substring(0, ix));\r
 305         } catch (NumberFormatException e) {\r
 306             return -1;\r
 307         }\r
 308     }\r
 309 \r
 310     @Override\r
 311     public void run() {\r
 312         // Once every 5 minutes, go through the map, and remove empty entrys\r
 313         for (Object s : map.keySet().toArray()) {\r
 314             synchronized (map) {\r
 315                 Counter c = map.get(s);\r
 316                 if (c.prune() <= 0)\r
 317                     map.remove(s);\r
 318             }\r
 319         }\r
 320     }\r
 321 }\r