reverseproxy

Jun 5, 2025

Changes in this version

+ var ErrCircuitOpen = errors.New("circuit breaker is open")

+ var ErrMaxRetriesReached = errors.New("maximum number of retries reached")

+ var ErrNoAvailableBackend = errors.New("no available backend")

+ var ErrRequestTimeout = errors.New("request timed out")

+ func RetryWithPolicy(ctx context.Context, policy RetryPolicy, fn RetryFunc, ...) (interface{}, int, error)

+ type BackendConfig struct

+ CircuitBreaker *CircuitBreakerConfig

+ IdleConnTimeout time.Duration

+ MaxConnsPerHost int

+ MaxIdleConns int

+ MaxIdleConnsPerHost int

+ Retry *RetryConfig

+ TLSSkipVerify bool

+ Timeout time.Duration

+ URL string

type CircuitBreaker

+ func NewCircuitBreakerWithConfig(backendName string, config CircuitBreakerConfig, ...) *CircuitBreaker

+ func (cb *CircuitBreaker) Execute(req *http.Request, fn func(*http.Request) (*http.Response, error)) (*http.Response, error)

+ func (cb *CircuitBreaker) WithFailureThreshold(threshold int) *CircuitBreaker

+ func (cb *CircuitBreaker) WithMetricsCollector(collector *MetricsCollector) *CircuitBreaker

+ func (cb *CircuitBreaker) WithRequestTimeout(timeout time.Duration) *CircuitBreaker

+ func (cb *CircuitBreaker) WithResetTimeout(timeout time.Duration) *CircuitBreaker

type CircuitBreakerConfig

+ HalfOpenAllowedRequests int

+ OpenTimeout time.Duration

+ SuccessRateThreshold float64

+ SuccessThreshold int

+ WindowSize int

type CircuitState

+ const StateClosed

+ const StateHalfOpen

+ const StateOpen

+ func (s CircuitState) String() string

+ type Config struct

+ Backends map[string]BackendConfig

+ CircuitBreaker CircuitBreakerConfig

+ ExactMapping map[string]string

+ MetricsEnabled bool

+ MetricsPath string

+ PrefixMapping map[string]string

+ Retry RetryConfig

+ type MetricsCollector struct

+ func NewMetricsCollector() *MetricsCollector

+ func (m *MetricsCollector) GetMetrics() map[string]interface{}

+ func (m *MetricsCollector) MetricsHandler() http.HandlerFunc

+ func (m *MetricsCollector) RecordRequest(backend string, start time.Time, statusCode int, err error, ...)

+ func (m *MetricsCollector) SetCircuitBreakerStateString(backend string, state string)

+ func (m *MetricsCollector) SetCircuitBreakerStatus(backend string, isOpen bool)

+ type RetryConfig struct

+ BaseDelay time.Duration

+ Enabled bool

+ Jitter float64

+ MaxDelay time.Duration

+ MaxRetries int

+ RetryableStatusCodes []int

+ Timeout time.Duration

+ type RetryFunc func(ctx context.Context) (interface{}, int, error)

+ type RetryPolicy struct

+ BaseDelay time.Duration

+ Jitter float64

+ MaxDelay time.Duration

+ MaxRetries int

+ RetryableStatusCodes map[int]bool

+ Timeout time.Duration

+ func DefaultRetryPolicy() RetryPolicy

+ func (p RetryPolicy) CalculateBackoff(attempt int) time.Duration

+ func (p RetryPolicy) ShouldRetry(statusCode int) bool

+ func (p RetryPolicy) WithBaseDelay(baseDelay time.Duration) RetryPolicy

+ func (p RetryPolicy) WithJitter(jitter float64) RetryPolicy

+ func (p RetryPolicy) WithMaxDelay(maxDelay time.Duration) RetryPolicy

+ func (p RetryPolicy) WithMaxRetries(maxRetries int) RetryPolicy

+ func (p RetryPolicy) WithRetryableStatusCodes(codes ...int) RetryPolicy

+ func (p RetryPolicy) WithTimeout(timeout time.Duration) RetryPolicy

type ReverseProxyConfig

+ MetricsEnabled bool

+ MetricsEndpoint string

+ MetricsPath string

+ RequestTimeout time.Duration

May 1, 2025

Changes in this version

+ type HandleFuncService interface

+ HandleFunc func(pattern string, handler func(http.ResponseWriter, *http.Request))

Apr 26, 2025

Changes in this version

+ func ProvideConfig() interface

+ func TenantIDFromRequest(tenantIDHeader string, req *http.Request) (string, bool)

+ type Backend struct

+ Client *http.Client

+ ID string

+ URL string

+ type BackendEndpointRequest struct

+ Backend string

+ Headers map[string]string

+ Method string

+ Path string

+ QueryParams map[string]string

+ type CachedResponse struct

+ Body []byte

+ ExpirationTime time.Time

+ Headers http.Header

+ LastAccessed time.Time

+ StatusCode int

+ type CircuitBreaker struct

+ func NewCircuitBreaker(failureThreshold int, resetTimeout time.Duration) *CircuitBreaker

+ func (cb *CircuitBreaker) GetState() CircuitState

+ func (cb *CircuitBreaker) IsOpen() bool

+ func (cb *CircuitBreaker) RecordFailure()

+ func (cb *CircuitBreaker) RecordSuccess()

+ func (cb *CircuitBreaker) Reset()

+ type CircuitBreakerConfig struct

+ Enabled bool

+ FailureThreshold int

+ ResetTimeoutSeconds int

+ type CircuitState int

+ const CircuitClosed

+ const CircuitHalfOpen

+ const CircuitOpen

+ type CompositeHandler struct

+ func NewCompositeHandler(backends []*Backend, parallel bool, responseTimeout time.Duration) *CompositeHandler

+ func (h *CompositeHandler) ConfigureCircuitBreakers(globalConfig CircuitBreakerConfig, ...)

+ func (h *CompositeHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (h *CompositeHandler) SetResponseCache(cache *responseCache)

+ type CompositeResponse struct

+ Body []byte

+ Headers http.Header

+ StatusCode int

+ type CompositeRoute struct

+ Backends []string

+ Pattern string

+ Strategy string

+ type EndpointMapping struct

+ Endpoints []BackendEndpointRequest

+ ResponseTransformer func(ctx context.Context, req *http.Request, responses map[string]*http.Response) (*CompositeResponse, error)

+ type PathMatcher struct

+ func NewPathMatcher() *PathMatcher

+ func (pm *PathMatcher) AddRoutePattern(backendID, pattern string)

+ func (pm *PathMatcher) MatchBackend(path string) string

+ type ReverseProxyConfig struct

+ BackendCircuitBreakers map[string]CircuitBreakerConfig

+ BackendServices map[string]string

+ CacheEnabled bool

+ CacheTTL int

+ CircuitBreakerConfig CircuitBreakerConfig

+ CompositeRoutes map[string]CompositeRoute

+ DefaultBackend string

+ RequireTenantID bool

+ Routes map[string]string

+ TenantIDHeader string

+ func (c *ReverseProxyConfig) Validate() error

+ type ReverseProxyModule struct

+ func NewModule() (*ReverseProxyModule, error)

+ func (m *ReverseProxyModule) AddBackendRoute(backendID, pattern string)

+ func (m *ReverseProxyModule) AddCompositeRoute(pattern string, backends []string, strategy string)

+ func (m *ReverseProxyModule) Constructor() modular.ModuleConstructor

+ func (m *ReverseProxyModule) GetConfig() *ReverseProxyConfig

+ func (m *ReverseProxyModule) Init(app modular.Application) error

+ func (m *ReverseProxyModule) Name() string

+ func (m *ReverseProxyModule) OnTenantRegistered(tenantID modular.TenantID)

+ func (m *ReverseProxyModule) OnTenantRemoved(tenantID modular.TenantID)

+ func (m *ReverseProxyModule) ProvidesServices() []modular.ServiceProvider

+ func (m *ReverseProxyModule) RegisterConfig(app modular.Application) error

+ func (m *ReverseProxyModule) RegisterCustomEndpoint(pattern string, mapping EndpointMapping)

+ func (m *ReverseProxyModule) RequiresServices() []modular.ServiceDependency

+ func (m *ReverseProxyModule) SetHttpClient(client *http.Client)

+ func (m *ReverseProxyModule) Start(context.Context) error

+ func (m *ReverseProxyModule) Stop(context.Context) error