overload: scale transport socket connect timeout

api/envoy/config/overload/v3/overload.proto

@@ -93,6 +93,11 @@ message ScaleTimersOverloadActionConfig {
     // Adjusts the idle timer for downstream HTTP connections that takes effect when there are no active streams.
     // This affects the value of :ref:`RouteAction.idle_timeout <envoy_v3_api_field_config.route.v3.RouteAction.idle_timeout>`.
     HTTP_DOWNSTREAM_CONNECTION_IDLE = 1;
+
+    // Adjusts the timer for how long downstream clients have to finish transport-level negotiations before the connection is closed.
+    // This affects the value of
+    // :ref:`FilterChain.transport_socket_connect_timeout <envoy_v3_api_field_config.listener.v3.FilterChain.transport_socket_connect_timeout>`.
+    TRANSPORT_SOCKET_CONNECT = 2;
   }
 
   message ScaleTimer {

include/envoy/event/BUILD

@@ -31,6 +31,7 @@ envoy_cc_library(
         "//include/envoy/network:listen_socket_interface",
         "//include/envoy/network:listener_interface",
         "//include/envoy/network:transport_socket_interface",
+        "//include/envoy/server/overload:thread_local_overload_state",
         "//include/envoy/thread:thread_interface",
     ],
 )

include/envoy/event/dispatcher.h

@@ -19,6 +19,7 @@
 #include "envoy/network/listen_socket.h"
 #include "envoy/network/listener.h"
 #include "envoy/network/transport_socket.h"
+#include "envoy/server/overload/thread_local_overload_state.h"
 #include "envoy/stats/scope.h"
 #include "envoy/stats/stats_macros.h"
 #include "envoy/stream_info/stream_info.h"
@@ -90,12 +91,12 @@ class Dispatcher {
    *        connection. Takes ownership of the socket.
    * @param transport_socket supplies a transport socket to be used by the connection.
    * @param stream_info info object for the server connection
+   * @param overload_state the overload state for this dispatcher.
    * @return Network::ConnectionPtr a server connection that is owned by the caller.
    */
-  virtual Network::ServerConnectionPtr
-  createServerConnection(Network::ConnectionSocketPtr&& socket,
-                         Network::TransportSocketPtr&& transport_socket,
-                         StreamInfo::StreamInfo& stream_info) PURE;
+  virtual Network::ServerConnectionPtr createServerConnection(
+      Network::ConnectionSocketPtr&& socket, Network::TransportSocketPtr&& transport_socket,
+      StreamInfo::StreamInfo& stream_info, Server::ThreadLocalOverloadState& overload_state) PURE;
 
   /**
    * Creates an instance of Envoy's Network::ClientConnection. Does NOT initiate the connection;

include/envoy/runtime/BUILD

@@ -17,7 +17,7 @@ envoy_cc_library(
     ],
     deps = [
         "//include/envoy/stats:stats_interface",
-        "//include/envoy/thread_local:thread_local_interface",
+        "//include/envoy/thread_local:thread_local_object",
         "//source/common/common:assert_lib",
         "//source/common/singleton:threadsafe_singleton",
         "@envoy_api//envoy/type/v3:pkg_cc_proto",

include/envoy/runtime/runtime.h

@@ -9,7 +9,7 @@
 
 #include "envoy/common/pure.h"
 #include "envoy/stats/store.h"
-#include "envoy/thread_local/thread_local.h"
+#include "envoy/thread_local/thread_local_object.h"
 #include "envoy/type/v3/percent.pb.h"
 
 #include "common/common/assert.h"

include/envoy/server/BUILD

@@ -126,7 +126,7 @@ envoy_cc_library(
         "//include/envoy/local_info:local_info_interface",
         "//include/envoy/runtime:runtime_interface",
         "//include/envoy/secret:secret_manager_interface",
-        "//include/envoy/server:overload_manager_interface",
+        "//include/envoy/server/overload:overload_manager_interface",
         "//include/envoy/ssl:context_manager_interface",
         "//include/envoy/thread_local:thread_local_interface",
         "//include/envoy/tracing:http_tracer_interface",
@@ -150,8 +150,8 @@ envoy_cc_library(
     name = "worker_interface",
     hdrs = ["worker.h"],
     deps = [
-        ":overload_manager_interface",
         "//include/envoy/server:guarddog_interface",
+        "//include/envoy/server/overload:overload_manager_interface",
     ],
 )
 
@@ -184,7 +184,7 @@ envoy_cc_library(
         "//include/envoy/local_info:local_info_interface",
         "//include/envoy/network:drain_decision_interface",
         "//include/envoy/runtime:runtime_interface",
-        "//include/envoy/server:overload_manager_interface",
+        "//include/envoy/server/overload:overload_manager_interface",
         "//include/envoy/singleton:manager_interface",
         "//include/envoy/thread_local:thread_local_interface",
         "//include/envoy/tracing:http_tracer_interface",
@@ -208,8 +208,8 @@ envoy_cc_library(
         "//include/envoy/config:typed_config_interface",
         "//include/envoy/http:codes_interface",
         "//include/envoy/http:filter_interface",
-        "//include/envoy/server:overload_manager_interface",
         "//include/envoy/server:transport_socket_config_interface",
+        "//include/envoy/server/overload:overload_manager_interface",
         "//include/envoy/singleton:manager_interface",
         "//include/envoy/thread_local:thread_local_interface",
         "//include/envoy/tracing:http_tracer_interface",
@@ -303,16 +303,6 @@ envoy_cc_library(
     ],
 )
 
-envoy_cc_library(
-    name = "overload_manager_interface",
-    hdrs = ["overload_manager.h"],
-    deps = [
-        "//include/envoy/event:timer_interface",
-        "//include/envoy/thread_local:thread_local_interface",
-        "//source/common/singleton:const_singleton",
-    ],
-)
-
 envoy_cc_library(
     name = "tracer_config_interface",
     hdrs = ["tracer_config.h"],

include/envoy/server/factory_context.h

@@ -19,7 +19,7 @@
 #include "envoy/server/admin.h"
 #include "envoy/server/drain_manager.h"
 #include "envoy/server/lifecycle_notifier.h"
-#include "envoy/server/overload_manager.h"
+#include "envoy/server/overload/overload_manager.h"
 #include "envoy/server/process_context.h"
 #include "envoy/singleton/manager.h"
 #include "envoy/stats/scope.h"

include/envoy/server/instance.h

@@ -23,7 +23,7 @@
 #include "envoy/server/lifecycle_notifier.h"
 #include "envoy/server/listener_manager.h"
 #include "envoy/server/options.h"
-#include "envoy/server/overload_manager.h"
+#include "envoy/server/overload/overload_manager.h"
 #include "envoy/ssl/context_manager.h"
 #include "envoy/thread_local/thread_local.h"
 #include "envoy/tracing/http_tracer.h"

include/envoy/server/overload/BUILD

@@ -0,0 +1,29 @@
+load(
+    "//bazel:envoy_build_system.bzl",
+    "envoy_cc_library",
+    "envoy_package",
+)
+
+licenses(["notice"])  # Apache 2
+
+envoy_package()
+
+envoy_cc_library(
+    name = "overload_manager_interface",
+    hdrs = ["overload_manager.h"],
+    deps = [
+        ":thread_local_overload_state",
+        "//include/envoy/event:dispatcher_interface",
+        "//include/envoy/thread_local:thread_local_interface",
+        "//source/common/singleton:const_singleton",
+    ],
+)
+
+envoy_cc_library(
+    name = "thread_local_overload_state",
+    hdrs = ["thread_local_overload_state.h"],
+    deps = [
+        "//include/envoy/event:timer_interface",
+        "//include/envoy/thread_local:thread_local_object",
+    ],
+)

include/envoy/server/overload_manager.h → include/envoy/server/overload/overload_manager.h

@@ -3,64 +3,13 @@
 #include <string>
 
 #include "envoy/common/pure.h"
-#include "envoy/event/timer.h"
-#include "envoy/thread_local/thread_local.h"
+#include "envoy/event/dispatcher.h"
+#include "envoy/server/overload/thread_local_overload_state.h"
 
-#include "common/common/macros.h"
 #include "common/singleton/const_singleton.h"
 
 namespace Envoy {
 namespace Server {
-
-/**
- * Tracks the state of an overload action. The state is a number between 0 and 1 that represents the
- * level of saturation. The values are categorized in two groups:
- * - Saturated (value = 1): indicates that an overload action is active because at least one of its
- *   triggers has reached saturation.
- * - Scaling (0 <= value < 1): indicates that an overload action is not saturated.
- */
-class OverloadActionState {
-public:
-  static constexpr OverloadActionState inactive() { return OverloadActionState(0); }
-
-  static constexpr OverloadActionState saturated() { return OverloadActionState(1.0); }
-
-  explicit constexpr OverloadActionState(float value)
-      : action_value_(std::min(1.0f, std::max(0.0f, value))) {}
-
-  float value() const { return action_value_; }
-  bool isSaturated() const { return action_value_ == 1; }
-
-private:
-  float action_value_;
-};
-
-/**
- * Callback invoked when an overload action changes state.
- */
-using OverloadActionCb = std::function<void(OverloadActionState)>;
-
-enum class OverloadTimerType {
-  // Timers created with this type will never be scaled. This should only be used for testing.
-  UnscaledRealTimerForTest,
-  // The amount of time an HTTP connection to a downstream client can remain idle (no streams). This
-  // corresponds to the HTTP_DOWNSTREAM_CONNECTION_IDLE TimerType in overload.proto.
-  HttpDownstreamIdleConnectionTimeout,
-};
-
-/**
- * Thread-local copy of the state of each configured overload action.
- */
-class ThreadLocalOverloadState : public ThreadLocal::ThreadLocalObject {
-public:
-  // Get a thread-local reference to the value for the given action key.
-  virtual const OverloadActionState& getState(const std::string& action) PURE;
-
-  // Get a scaled timer whose minimum corresponds to the configured value for the given timer type.
-  virtual Event::TimerPtr createScaledTimer(OverloadTimerType timer_type,
-                                            Event::TimerCb callback) PURE;
-};
-
 /**
  * Well-known overload action names.
  */

include/envoy/server/overload/thread_local_overload_state.h

@@ -0,0 +1,67 @@
+
+#pragma once
+
+#include <string>
+
+#include "envoy/common/pure.h"
+#include "envoy/event/timer.h"
+#include "envoy/thread_local/thread_local_object.h"
+
+namespace Envoy {
+namespace Server {
+
+/**
+ * Tracks the state of an overload action. The state is a number between 0 and 1 that represents the
+ * level of saturation. The values are categorized in two groups:
+ * - Saturated (value = 1): indicates that an overload action is active because at least one of its
+ *   triggers has reached saturation.
+ * - Scaling (0 <= value < 1): indicates that an overload action is not saturated.
+ */
+class OverloadActionState {
+public:
+  static constexpr OverloadActionState inactive() { return OverloadActionState(0); }
+
+  static constexpr OverloadActionState saturated() { return OverloadActionState(1.0); }
+
+  explicit constexpr OverloadActionState(float value)
+      : action_value_(std::min(1.0f, std::max(0.0f, value))) {}
+
+  float value() const { return action_value_; }
+  bool isSaturated() const { return action_value_ == 1; }
+
+private:
+  float action_value_;
+};
+
+/**
+ * Callback invoked when an overload action changes state.
+ */
+using OverloadActionCb = std::function<void(OverloadActionState)>;
+
+enum class OverloadTimerType {
+  // Timers created with this type will never be scaled. This should only be used for testing.
+  UnscaledRealTimerForTest,
+  // The amount of time an HTTP connection to a downstream client can remain idle (no streams). This
+  // corresponds to the HTTP_DOWNSTREAM_CONNECTION_IDLE TimerType in overload.proto.
+  HttpDownstreamIdleConnectionTimeout,
+  // The amount of time a connection to a downstream client can spend waiting for the transport to
+  // report connection establishment before the connection is closed.
+  // This corresponds to the TRANSPORT_SOCKET_CONNECT_TIMEOUT TimerType in overload.proto.
+  TransportSocketConnectTimeout,
+};
+
+/**
+ * Thread-local copy of the state of each configured overload action.
+ */
+class ThreadLocalOverloadState : public ThreadLocal::ThreadLocalObject {
+public:
+  // Get a thread-local reference to the value for the given action key.
+  virtual const OverloadActionState& getState(const std::string& action) PURE;
+
+  // Get a scaled timer whose minimum corresponds to the configured value for the given timer type.
+  virtual Event::TimerPtr createScaledTimer(OverloadTimerType timer_type,
+                                            Event::TimerCb callback) PURE;
+};
+
+} // namespace Server
+} // namespace Envoy

include/envoy/server/worker.h

@@ -3,7 +3,7 @@
 #include <functional>
 
 #include "envoy/server/guarddog.h"
-#include "envoy/server/overload_manager.h"
+#include "envoy/server/overload/overload_manager.h"
 
 namespace Envoy {
 namespace Server {

include/envoy/thread_local/BUILD

@@ -11,5 +11,15 @@ envoy_package()
 envoy_cc_library(
     name = "thread_local_interface",
     hdrs = ["thread_local.h"],
-    deps = ["//include/envoy/event:dispatcher_interface"],
+    deps = [
+        ":thread_local_object",
+        "//include/envoy/event:dispatcher_interface",
+        "//source/common/common:assert_lib",
+    ],
+)
+
+envoy_cc_library(
+    name = "thread_local_object",
+    hdrs = ["thread_local_object.h"],
+    deps = ["//source/common/common:assert_lib"],
 )

include/envoy/thread_local/thread_local.h

@@ -6,28 +6,13 @@
 
 #include "envoy/common/pure.h"
 #include "envoy/event/dispatcher.h"
+#include "envoy/thread_local/thread_local_object.h"
+
+#include "common/common/assert.h"
 
 namespace Envoy {
 namespace ThreadLocal {
 
-/**
- * All objects that are stored via the ThreadLocal interface must derive from this type.
- */
-class ThreadLocalObject {
-public:
-  virtual ~ThreadLocalObject() = default;
-
-  /**
-   * Return the object casted to a concrete type. See getTyped() below for comments on the casts.
-   */
-  template <class T> T& asType() {
-    ASSERT(dynamic_cast<T*>(this) != nullptr);
-    return *static_cast<T*>(this);
-  }
-};
-
-using ThreadLocalObjectSharedPtr = std::shared_ptr<ThreadLocalObject>;
-
 /**
  * An individual allocated TLS slot. When the slot is destroyed the stored thread local will
  * be freed on each thread.