vulcan

package module

v0.0.0-...-68da624 Latest Latest Go to latest Published: Dec 17, 2014 License: Apache-2.0 Imports: 9 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mailgun/vulcan

Links

Open Source Insights

README ¶

Status

This library has been refactored into: https://github.com/mailgun/oxy and is being deprecated

OXY is compatible with HTTP standard library, provides the same features as Vulcan and is simpler to use. Please consider using it instead.

Vulcan library will stay there for a while in case if you are using it, but I would suggest consider migrating. Vulcand project is currently migrating to oxy library.

Documentation ¶

Overview ¶

This package contains the reverse proxy that implements http.HandlerFunc

Index ¶

type Options
type Proxy
- func NewProxy(router route.Router) (*Proxy, error)
- func NewProxyWithOptions(router route.Router, o Options) (*Proxy, error)
- func (p *Proxy) GetRouter() route.Router
- func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	// Takes a status code and formats it into proxy response
	ErrorFormatter errors.Formatter
}

type Proxy ¶

type Proxy struct {
	// contains filtered or unexported fields
}

func NewProxy ¶

func NewProxy(router route.Router) (*Proxy, error)

Creates a proxy with a given router

func NewProxyWithOptions ¶

func NewProxyWithOptions(router route.Router, o Options) (*Proxy, error)

Creates reverse proxy that acts like http request handler

func (*Proxy) GetRouter ¶

func (p *Proxy) GetRouter() route.Router

func (*Proxy) ServeHTTP ¶

func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request)

Accepts requests, round trips it to the endpoint, and writes back the response.

Source Files ¶

View all Source files

proxy.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
circuitbreaker Circuit breakers start in the Standby state first, observing responses and watching location metrics.	Circuit breakers start in the Standby state first, observing responses and watching location metrics.
endpoint Endpoints - final destination of the http request	Endpoints - final destination of the http request
errors Utility functions for producing errorneous http responses	Utility functions for producing errorneous http responses
headers Constants with common HTTP headers	Constants with common HTTP headers
limit Interfaces for request limiting	Interfaces for request limiting
connlimit Simultaneous connection limiter	Simultaneous connection limiter
tokenbucket Tokenbucket based request rate limiter	Tokenbucket based request rate limiter
loadbalance Load balancers control how requests are distributed among multiple endpoints.	Load balancers control how requests are distributed among multiple endpoints.
roundrobin Dynamic weighted round robin load balancer	Dynamic weighted round robin load balancer
location Interfaces for location - round trip the http request to backends	Interfaces for location - round trip the http request to backends
httploc HTTP location with load balancing and pluggable middlewares	HTTP location with load balancing and pluggable middlewares
metrics In memory request performance metrics	In memory request performance metrics
middleware Middlewares can modify or intercept requests and responses	Middlewares can modify or intercept requests and responses
netutils Network related utilities	Network related utilities
request Wrapper around http.Request with additional features	Wrapper around http.Request with additional features
route Route the request to a location	Route the request to a location
exproute see http://godoc.org/github.com/mailgun/route for documentation on the language	see http://godoc.org/github.com/mailgun/route for documentation on the language
hostroute Route the request by hostname	Route the request by hostname
pathroute Route the request by path	Route the request by path
template Package template consolidates various templating utilities used throughout different parts of vulcan.	Package template consolidates various templating utilities used throughout different parts of vulcan.
testutils
threshold Package threshold contains predicates that can define various request thresholds Examples: * RequestMethod() == "GET" triggers action when request method equals "GET" * IsNetworkError() - triggers action on network errors * RequestMethod() == "GET" && Attempts <= 2 && (IsNetworkError() \|\| ResponseCode() == 408) This predicate triggers for GET requests with maximum 2 attempts on network errors or when upstream returns special http response code 408	Package threshold contains predicates that can define various request thresholds Examples: * RequestMethod() == "GET" triggers action when request method equals "GET" * IsNetworkError() - triggers action on network errors * RequestMethod() == "GET" && Attempts <= 2 && (IsNetworkError() \|\| ResponseCode() == 408) This predicate triggers for GET requests with maximum 2 attempts on network errors or when upstream returns special http response code 408