monitor

Documentation

Index

• Constants
• Variables
• func ConfigureSentry(dsn, release, env string)
• func ErrorLoggingMiddleware(next http.Handler) http.Handler
• func ErrorToSentry(err error, params ...map[string]string)
• func LogMode() string
• func LogSuccessfulQuery(method string, time float64, params interface{}, response interface{})
• type ModuleLogger
  • func NewModuleLogger(moduleName string) ModuleLogger
  • func (m ModuleLogger) Disable()
  • func (m ModuleLogger) Log() *logrus.Entry
  • func (m ModuleLogger) WithFields(fields logrus.Fields) *logrus.Entry

Constants

const (
	// TokenF is a token field name that will be stripped from logs in production mode.
	TokenF = "token"
)

Variables

var IgnoredExceptions = []string{
	responses.AuthRequiredErrorMessage,
}

var IsProduction = false

Functions

func ConfigureSentry

func ConfigureSentry(dsn, release, env string)

func ErrorLoggingMiddleware

func ErrorLoggingMiddleware(next http.Handler) http.Handler

ErrorLoggingMiddleware intercepts panics and regular error responses from http handlers, handles them in a graceful way, logs and sends them to Sentry

func ErrorToSentry

func ErrorToSentry(err error, params ...map[string]string)

ErrorToSentry sends to Sentry general exception info with some extra provided detail (like user email, claim url etc)

func LogMode

func LogMode() string

func LogSuccessfulQuery

func LogSuccessfulQuery(method string, time float64, params interface{}, response interface{})

LogSuccessfulQuery takes a remote method name, execution time and params and logs it

Types

type ModuleLogger

type ModuleLogger struct {
	Entry *logrus.Entry
}

TODO: we could drop the custom struct completely. it doesnt add anything anymore ModuleLogger contains module-specific logger details.

func NewModuleLogger

func NewModuleLogger(moduleName string) ModuleLogger

NewModuleLogger creates a new ModuleLogger instance carrying module name for later `Log()` calls.

func (ModuleLogger) Disable

func (m ModuleLogger) Disable()

Disable turns off logging output for this module logger

func (ModuleLogger) Log

func (m ModuleLogger) Log() *logrus.Entry

Log returns a new log entry for the module which can be called upon with a corresponding logLevel. Example:

Log().Info("query error")

func (ModuleLogger) WithFields

func (m ModuleLogger) WithFields(fields logrus.Fields) *logrus.Entry

WithFields returns a new log entry containing additional info provided by fields, which can be called upon with a corresponding logLevel. Example:

logger.WithFields(F{"query": "..."}).Info("query error")