ginapp

README

ginapp

Documentation

Index

• type App
  • func (app *App) Start() error
  • func (app *App) StartAsync() *http.Server
• type Builder
  • func WithConfiguration(config Config) *Builder
  • func (builder *Builder) Build() (*App, error)
  • func (builder *Builder) ConfigureGinEngine(configure func(*gin.Engine, *zap.SugaredLogger) error) *Builder
  • func (builder *Builder) ConfigureMetrics(configure func(*ginmetrics.Monitor) error) *Builder
• type Config
• type LogConfig
• type LogFormat
• type LogLevel
• type MetricsConfig
  • func (metricsConfig *MetricsConfig) GetPath() string
• type ServerConfig
  • func (serverConfig *ServerConfig) GetHealthCheckPath() string
  • func (serverConfig *ServerConfig) GetMetrics() *MetricsConfig

Types

type App

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

func (*App) Start

func (app *App) Start() error

func (*App) StartAsync

func (app *App) StartAsync() *http.Server

type Builder

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

func WithConfiguration

func WithConfiguration(config Config) *Builder

func (*Builder) Build

func (builder *Builder) Build() (*App, error)

func (*Builder) ConfigureGinEngine

func (builder *Builder) ConfigureGinEngine(configure func(*gin.Engine, *zap.SugaredLogger) error) *Builder

func (*Builder) ConfigureMetrics

func (builder *Builder) ConfigureMetrics(configure func(*ginmetrics.Monitor) error) *Builder

type Config

type Config interface {
	GetServerConfig() *ServerConfig
	GetLogConfig() *LogConfig
}

type LogConfig

type LogConfig struct {
	Level  LogLevel  `json:"level,omitempty"`
	Format LogFormat `json:"format,omitempty"`
}

type LogFormat

type LogFormat string

const (
	LogJson    LogFormat = "json"
	LogConsole LogFormat = "console"
)

type LogLevel

type LogLevel string

const (
	LogNone  LogLevel = "none"
	LogDebug LogLevel = "debug"
	LogInfo  LogLevel = "info"
	LogWarn  LogLevel = "warn"
	LogError LogLevel = "error"
)

type MetricsConfig

type MetricsConfig struct {
	Enabled bool   `json:"enabled,omitempty"`
	Path    string `json:"path,omitempty"`
}

func (*MetricsConfig) GetPath

func (metricsConfig *MetricsConfig) GetPath() string

type ServerConfig

type ServerConfig struct {
	Mode            string         `json:"mode,omitempty"`
	Port            int            `json:"port,omitempty"`
	HealthcheckPath string         `json:"healthcheck_path,omitempty"`
	Metrics         *MetricsConfig `json:"metrics,omitempty"`
}

func (*ServerConfig) GetHealthCheckPath

func (serverConfig *ServerConfig) GetHealthCheckPath() string

func (*ServerConfig) GetMetrics

func (serverConfig *ServerConfig) GetMetrics() *MetricsConfig