gondola

README

English 日本語

gondola

A golang reverse proxy.

This log was created by gopherize.me

Table of contents

• gondola
• Table of contents
• Features
• Install
  • Go
  • Binary
  • Docker
• Example
• Usage
• Projects
• ADR
• Wiki
• Contribution
• Sponsor
• License
• Stargazers
• Forkers
• Author

Features

• Virtual host
  • You can set up multiple hosts on upstream servers.
• Configuration file loader
  • You can use configuration files in YAML format.
• TLS
  • You can use TLS by preparing a TLS certificate.
• Serve static files
  • You can serve static files.
• Access log
  • Outputs Proxy access logs and Upstream servers access logs.
• Binary distribution
  • Distributing cross-compiled binaries.

Install

Go

go get -u github.com/bmf-san/gondola

Binary

You can download the binary from the release page, and you can use it.

Docker

bmfsan/gondola

Example

See below for how to use gondola.

• _examples

Usage

Run a binary with the option.

gondola -config config.yaml

Projects

• The gondola's board

ADR

• ADR

Wiki

• wiki

Contribution

Issues and Pull Requests are always welcome.

We would be happy to receive your contributions.

Please review the following documents before making a contribution.

• CODE_OF_CONDUCT
• CONTRIBUTING

Sponsor

If you like it, I would be happy to have you sponsor it!

Github Sponsors - bmf-san

Or I would be happy to get a STAR.

It motivates me to keep up with ongoing maintenance. :D

License

Based on the MIT License.

LICENSE

Stargazers

Forkers

Author

bmf-san

• Email
  • bmf.infomation@gmail.com
• Blog
  • bmf-tech.com
• Twitter
  • bmf-san

Documentation

Index

• func GetTraceID(ctx context.Context) string
• func WithTraceID(ctx context.Context) context.Context
• type Config
  • func (c *Config) Load(reader io.Reader) (*Config, error)
• type ConfigLoadError
  • func (e *ConfigLoadError) Error() string
  • func (e *ConfigLoadError) Unwrap() error
• type Gondola
  • func NewGondola(r io.Reader) (*Gondola, error)
  • func (g *Gondola) Run() error
• type LogRoundTripper
  • func NewLogRoundTripper(transport http.RoundTripper) *LogRoundTripper
  • func (lrt *LogRoundTripper) RoundTrip(r *http.Request) (*http.Response, error)
• type Logger
  • func NewLogger(level int) *Logger
• type Proxy
  • func (p *Proxy) IsEnableTLS() bool
• type ProxyHandler
  • func (h *ProxyHandler) Handler(w http.ResponseWriter, r *http.Request)
• type ProxyServerError
  • func (e *ProxyServerError) Error() string
  • func (e *ProxyServerError) Unwrap() error
• type Runner
• type StaticFile
• type TraceIDHandler
  • func (t TraceIDHandler) Handle(ctx context.Context, r slog.Record) error
• type Upstream

Functions

func GetTraceID

func GetTraceID(ctx context.Context) string

GetTraceID returns a trace ID from the context.

func WithTraceID

func WithTraceID(ctx context.Context) context.Context

WithTraceID adds a trace ID to the context.

Types

type Config

type Config struct {
	Proxy     Proxy      `yaml:"proxy"`
	Upstreams []Upstream `yaml:"upstreams"`
	LogLevel  int        `yaml:"log_level"` // Debug:-4 Info:0 Warn:4 Error:8
}

Config is a struct that represents the configuration of the proxy.

func (*Config) Load

func (c *Config) Load(reader io.Reader) (*Config, error)

Load reads the configuration from a reader and returns a Config struct.

type ConfigLoadError

type ConfigLoadError struct {
	Err error
}

ConfigLoadError is an error that occurs when loading the configuration.

func (*ConfigLoadError) Error

func (e *ConfigLoadError) Error() string

Error implements the error interface.

func (*ConfigLoadError) Unwrap

func (e *ConfigLoadError) Unwrap() error

Unwrap implements the errors.Wrapper interface.

type Gondola

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

Gondola is a proxy server.

func NewGondola

func NewGondola(r io.Reader) (*Gondola, error)

NewGondola returns a new Gondola.

func (*Gondola) Run

func (g *Gondola) Run() error

TODO: Need to dynamically load a configuration file. For now, we will limit the implementation to just loading the file at startup. Run starts the proxy server.

type LogRoundTripper

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

LogRoundTripper is a RoundTripper that logs the request and response.

func NewLogRoundTripper

func NewLogRoundTripper(transport http.RoundTripper) *LogRoundTripper

NewLogRoundTripper returns a new LogRoundTripper.

func (*LogRoundTripper) RoundTrip

func (lrt *LogRoundTripper) RoundTrip(r *http.Request) (*http.Response, error)

RoundTrip implements the RoundTripper interface. It logs the request and response.

type Logger

type Logger struct {
	*slog.Logger
}

Logger is a logger.

func NewLogger

func NewLogger(level int) *Logger

NewLogger creates a logger.

type Proxy

type Proxy struct {
	Port              string       `yaml:"port"`
	ReadHeaderTimeout int          `yaml:"read_header_timeout"`
	ShutdownTimeout   int          `yaml:"shutdown_timeout"`
	TLSCertPath       string       `yaml:"tls_cert_path"`
	TLSKeyPath        string       `yaml:"tls_key_path"`
	StaticFiles       []StaticFile `yaml:"static_files"`
}

Proxy is a struct that represents the proxy server. Port is the port that the proxy server will listen on. ShutdownTimeout is the timeout in milliseconds for the proxy server to shutdown.

func (*Proxy) IsEnableTLS

func (p *Proxy) IsEnableTLS() bool

IsEnableTLS returns true if the proxy server is configured to use TLS.

type ProxyHandler

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

ProxyHandler is a http.Handler that proxies the request.

func (*ProxyHandler) Handler

func (h *ProxyHandler) Handler(w http.ResponseWriter, r *http.Request)

Handler implements the http.Handler interface. It proxies the request.

type ProxyServerError

type ProxyServerError struct {
	Err error
}

ProxyServerError is an error that occurs when creating the server.

func (*ProxyServerError) Error

func (e *ProxyServerError) Error() string

Error implements the error interface.

func (*ProxyServerError) Unwrap

func (e *ProxyServerError) Unwrap() error

Unwrap implements the errors.Wrapper interface.

type Runner

type Runner interface {
	Run() error
}

Runner is an interface that defines the Run method.

type StaticFile

type StaticFile struct {
	Path string `yaml:"path"`
	Dir  string `yaml:"dir"`
}

StaticFile is a struct that represents a static file configuration.

type TraceIDHandler

type TraceIDHandler struct {
	slog.Handler
}

TraceIDHandler is a handler for trace ID.

func (TraceIDHandler) Handle

func (t TraceIDHandler) Handle(ctx context.Context, r slog.Record) error

Handle adds a trace ID to the record.

type Upstream

type Upstream struct {
	HostName string `yaml:"host_name"`
	Target   string `yaml:"target"`
}

Upstream is a struct that represents a backend server. HostName is the hostname that the proxy will listen for. Target is the target URL that the proxy will forward requests to.