Documentation
¶
Index ¶
- Variables
- func GetTX(c echo.Context) newrelic.Transaction
- func GetTopics(ctx context.Context, username string, _topics []string) ([]string, error)
- func HealthCheckHandler(app *App) func(c echo.Context) error
- func HistoriesHandler(app *App) func(c echo.Context) error
- func HistoryHandler(app *App) func(c echo.Context) error
- func IsNotFoundError(err error) bool
- func NotFoundHandler(app *App) func(c echo.Context) error
- func VersionMiddleware(next echo.HandlerFunc) echo.HandlerFunc
- func WithSegment(name string, c echo.Context, f func() error) error
- type ACL
- type App
- type LoggerMiddleware
- type NewRelicMiddleware
- type RecoveryMiddleware
- type SentryMiddleware
Constants ¶
This section is empty.
Variables ¶
var VERSION = "4.2.2"
VERSION is the current api version
Functions ¶
func HealthCheckHandler ¶
HealthCheckHandler is the handler responsible for validating that the app is still up
func HistoriesHandler ¶
HistoriesHandler is the handler responsible for sending multiples rooms history to the player
func HistoryHandler ¶
HistoryHandler is the handler responsible for sending the rooms history to the player
func IsNotFoundError ¶
IsNotFoundError returns true if error is of not found type
func NotFoundHandler ¶
NotFoundHandler is the handler responsible for responding when no resource was found
func VersionMiddleware ¶
func VersionMiddleware(next echo.HandlerFunc) echo.HandlerFunc
VersionMiddleware automatically adds a version header to response
Types ¶
type ACL ¶
type ACL struct {
ID bson.ObjectId `bson:"_id,omitempty"`
Username string `bson:"username"`
Pubsub []string `bson:"pubsub"`
}
ACL is the acl struct
type App ¶
type App struct {
Debug bool
Port int
Host string
API *echo.Echo
Engine engine.Server
ConfigPath string
Config *viper.Viper
NewRelic newrelic.Application
NumberOfDaysToSearch int
DDStatsD *extnethttpmiddleware.DogStatsD
Cassandra cassandra.DataStore
Defaults *models.Defaults
Bucket *models.Bucket
}
App is the struct that defines the application
func (*App) OnErrorHandler ¶
OnErrorHandler handles application panics
type LoggerMiddleware ¶
LoggerMiddleware is responsible for logging to Zap all requests
func NewLoggerMiddleware ¶
func NewLoggerMiddleware(theLogger zap.Logger) *LoggerMiddleware
NewLoggerMiddleware returns the logger middleware
func (LoggerMiddleware) Serve ¶
func (l LoggerMiddleware) Serve(next echo.HandlerFunc) echo.HandlerFunc
Serve serves the middleware
type NewRelicMiddleware ¶
NewRelicMiddleware is responsible for logging to Zap all requests
func NewNewRelicMiddleware ¶
func NewNewRelicMiddleware(app *App, theLogger zap.Logger) *NewRelicMiddleware
NewNewRelicMiddleware returns the logger middleware
func (*NewRelicMiddleware) Serve ¶
func (nr *NewRelicMiddleware) Serve(next echo.HandlerFunc) echo.HandlerFunc
Serve serves the middleware
type RecoveryMiddleware ¶
type RecoveryMiddleware struct {
OnError func(interface{}, []byte)
}
RecoveryMiddleware recovers from errors in Echo
func NewRecoveryMiddleware ¶
func NewRecoveryMiddleware(onError func(interface{}, []byte)) *RecoveryMiddleware
NewRecoveryMiddleware returns a configured middleware
func (RecoveryMiddleware) Serve ¶
func (r RecoveryMiddleware) Serve(next echo.HandlerFunc) echo.HandlerFunc
Serve executes on error handler when errors happen
type SentryMiddleware ¶
type SentryMiddleware struct {
App *App
}
SentryMiddleware is responsible for sending all exceptions to sentry
func NewSentryMiddleware ¶
func NewSentryMiddleware(app *App) *SentryMiddleware
NewSentryMiddleware returns a new sentry middleware
func (SentryMiddleware) Serve ¶
func (s SentryMiddleware) Serve(next echo.HandlerFunc) echo.HandlerFunc
Serve serves the middleware
Source Files