gooseneck

package module

v0.1.33 Latest Latest Go to latest Published: Nov 17, 2023 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/vements/gooseneck

Links

Open Source Insights

README ¶

Gooseneck

Because trashy is better than copy and paste.

Documentation ¶

Index ¶

Constants
Variables
func HealthCheck(w http.ResponseWriter, r *http.Request)
func InitLog()
func MakeCounter(namespace string, subsystem string, name string, help string, ...) prometheus.Counter
func MakeCounterFunc(namespace string, subsystem string, name string, help string, ...) prometheus.CounterFunc
func MakeCounterVec(namespace string, subsystem string, name string, help string, ...) *prometheus.CounterVec
func MakeGauge(namespace string, subsystem string, name string, help string, ...) prometheus.Gauge
func MakeGaugeFunc(namespace string, subsystem string, name string, help string, ...) prometheus.GaugeFunc
func MakeGaugeVec(namespace string, subsystem string, name string, help string, ...) *prometheus.GaugeVec
func MakeHistogram(namespace string, subsystem string, name string, help string, ...) prometheus.Histogram
func MakeHistogramVec(namespace string, subsystem string, name string, help string, ...) *prometheus.HistogramVec
func MakeResponseFunc(status int, body string) func(w http.ResponseWriter)
func MakeSummary(namespace string, subsystem string, name string, help string, ...) prometheus.Summary
func MakeSummaryVec(namespace string, subsystem string, name string, help string, ...) *prometheus.SummaryVec
func MakeUntypedFunc(namespace string, subsystem string, name string, help string, ...) prometheus.UntypedFunc
func NewHttpRouter() *httprouter.Router
func NewRedisClient() *redis.Client
type Cache
type Database
- func NewDatabase(options *DatabaseOptions) *Database
- func (db *Database) Connection() *sql.DB
type DatabaseOptions
type Env
- func (e Env) MustDefine(key string) string
- func (e Env) Optional(key string, defaultValue string) string
- func (e Env) Port() string
type MetricLabelNames
type MetricLabels
type RedisEnv
- func (e RedisEnv) Addr() string
- func (e RedisEnv) Database() int
- func (e RedisEnv) Password() string
- func (e RedisEnv) Username() string

Constants ¶

View Source

const (
	AUTHORIZATION = "Authorization"
	BEARER        = "Bearer "
	X_API_KEY     = "X-Api-Key"
)

View Source

const (
	DATABASE_URL = "DATABASE_URL"
	JWT_SECRET   = "JWT_SECRET"
	LOG_LEVEL    = "LOG_LEVEL"
	PORT         = "PORT"
	UPSTREAM     = "UPSTREAM"
)

View Source

const (
	REDIS_ADDR     = "REDIS_ADDR"
	REDIS_DATABASE = "REDIS_DATABASE"
	REDIS_PASSWORD = "REDIS_PASSWORD"
	REDIS_USERNAME = "REDIS_USERNAME"
)

Variables ¶

View Source

var (
	Trace = log.Trace
	Debug = log.Debug
	Info  = log.Info
	Warn  = log.Warn
	Error = log.Error
	Fatal = log.Fatal
	Panic = log.Panic

	//
	Log = log.Log
)

View Source

var (
	MetricsHandler = promhttp.Handler
)

View Source

var NewCache = cache.New

Functions ¶

func HealthCheck ¶

func HealthCheck(w http.ResponseWriter, r *http.Request)

func InitLog ¶

func InitLog()

func MakeCounter ¶

func MakeCounter(namespace string, subsystem string, name string, help string, constLabels MetricLabels) prometheus.Counter

func MakeCounterFunc ¶

func MakeCounterFunc(namespace string, subsystem string, name string, help string, constLabels MetricLabels, fn func() float64) prometheus.CounterFunc

func MakeCounterVec ¶

func MakeCounterVec(namespace string, subsystem string, name string, help string, constLabels MetricLabels, labelNames MetricLabelNames) *prometheus.CounterVec

func MakeGauge ¶

func MakeGauge(namespace string, subsystem string, name string, help string, constLabels MetricLabels) prometheus.Gauge

func MakeGaugeFunc ¶

func MakeGaugeFunc(namespace string, subsystem string, name string, help string, constLabels MetricLabels, fn func() float64) prometheus.GaugeFunc

func MakeGaugeVec ¶

func MakeGaugeVec(namespace string, subsystem string, name string, help string, constLabels MetricLabels, labelNames MetricLabelNames) *prometheus.GaugeVec

func MakeHistogram ¶

func MakeHistogram(namespace string, subsystem string, name string, help string, constLabels MetricLabels) prometheus.Histogram

func MakeHistogramVec ¶

func MakeHistogramVec(namespace string, subsystem string, name string, help string, constLabels MetricLabels, labelNames MetricLabelNames) *prometheus.HistogramVec

func MakeResponseFunc ¶

func MakeResponseFunc(status int, body string) func(w http.ResponseWriter)

func MakeSummary ¶

func MakeSummary(namespace string, subsystem string, name string, help string, constLabels MetricLabels) prometheus.Summary

func MakeSummaryVec ¶

func MakeSummaryVec(namespace string, subsystem string, name string, help string, constLabels MetricLabels, labelNames MetricLabelNames) *prometheus.SummaryVec

func MakeUntypedFunc ¶

func MakeUntypedFunc(namespace string, subsystem string, name string, help string, constLabels MetricLabels, fn func() float64) prometheus.UntypedFunc

func NewHttpRouter ¶

func NewHttpRouter() *httprouter.Router

func NewRedisClient ¶

func NewRedisClient() *redis.Client

Types ¶

type Cache ¶

type Cache = cache.Cache

type Database ¶

type Database struct {
	Options *DatabaseOptions
	// contains filtered or unexported fields
}

func NewDatabase ¶

func NewDatabase(options *DatabaseOptions) *Database

func (*Database) Connection ¶

func (db *Database) Connection() *sql.DB

type DatabaseOptions ¶

type DatabaseOptions struct {
	DSN               string
	MaxOpenConns      int
	MaxIdleConns      int
	ConnMaxLifetime   time.Duration
	ReconnectInterval time.Duration
}

type Env ¶

type Env struct {
}

func (Env) MustDefine ¶

func (e Env) MustDefine(key string) string

func (Env) Optional ¶

func (e Env) Optional(key string, defaultValue string) string

func (Env) Port ¶

func (e Env) Port() string

type MetricLabelNames ¶

type MetricLabelNames = []string

type MetricLabels ¶

type MetricLabels = prometheus.Labels

type RedisEnv ¶

type RedisEnv struct {
	Env
}

func (RedisEnv) Addr ¶

func (e RedisEnv) Addr() string

func (RedisEnv) Database ¶

func (e RedisEnv) Database() int

func (RedisEnv) Password ¶

func (e RedisEnv) Password() string

func (RedisEnv) Username ¶

func (e RedisEnv) Username() string

Source Files ¶

View all Source files

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