monitor

Documentation

Index

• Constants
• Variables
• func CaptureException(err error, params ...map[string]string)
• func CaptureRequestError(err error, r *http.Request, w http.ResponseWriter, ...)
• func ErrorLoggingMiddleware(next http.Handler) http.Handler
• func LogCachedQuery(method string)
• func LogFailedQuery(method string, query interface{}, errorResponse interface{})
• func LogSuccessfulQuery(method string, time float64, params interface{}, response interface{})
• func SetupLogging()
• type F
• type ModuleLogger
  • func NewModuleLogger(moduleName string) ModuleLogger
  • func (l ModuleLogger) Disable()
  • func (l ModuleLogger) Log() *logrus.Entry
  • func (l ModuleLogger) LogF(fields F) *logrus.Entry
  • func (l ModuleLogger) WithField(key string, value interface{}) *logrus.Entry
  • func (l ModuleLogger) WithFields(fields F) *logrus.Entry
• type ProxyLogger
  • func NewProxyLogger() *ProxyLogger
  • func (l *ProxyLogger) Error(message string)
  • func (l *ProxyLogger) Errorf(message string, args ...interface{})
  • func (l *ProxyLogger) LogFailedQuery(method string, params interface{}, errorResponse interface{})
  • func (l *ProxyLogger) LogSuccessfulQuery(method string, time float64, params interface{}, response interface{})
  • func (l *ProxyLogger) Logger() *logrus.Logger
• type QueryMonitor

Constants

const TokenF = "token"

TokenF is a token field name that will be stripped from logs in production mode.

const ValueMask = "****"

ValueMask is what replaces sensitive fields contents in logs.

Variables

var IgnoredExceptions = []string{
	"account identificator required",
}

var Logger = logrus.New()

Logger is a global instance of logrus object.

Functions

func CaptureException

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

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

func CaptureRequestError

func CaptureRequestError(err error, r *http.Request, w http.ResponseWriter, params ...map[string]interface{})

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 LogCachedQuery

func LogCachedQuery(method string)

LogCachedQuery logs a cache hit for a given method

func LogFailedQuery

func LogFailedQuery(method string, query interface{}, errorResponse interface{})

LogFailedQuery takes a method name, query params, response error object and logs it

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

func SetupLogging

func SetupLogging()

SetupLogging initializes and sets a few parameters for the logging subsystem.

Types

type F

type F map[string]interface{}

F can be supplied to ModuleLogger's Log function for providing additional log context.

type ModuleLogger

type ModuleLogger struct {
	ModuleName string
	Logger     *logrus.Logger
	Level      logrus.Level
}

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 (l ModuleLogger) Disable()

Disable turns off logging output for this module logger

func (ModuleLogger) Log

func (l 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) LogF

func (l ModuleLogger) LogF(fields F) *logrus.Entry

LogF is a deprecated method, an equivalent WithFields/WithField should be used.

func (ModuleLogger) WithField

func (l ModuleLogger) WithField(key string, value interface{}) *logrus.Entry

WithField is a shortcut for when a single log entry field is needed.

func (ModuleLogger) WithFields

func (l ModuleLogger) WithFields(fields F) *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")

type ProxyLogger

type ProxyLogger struct {
	Level logrus.Level
	// contains filtered or unexported fields
}

func NewProxyLogger

func NewProxyLogger() *ProxyLogger

func (*ProxyLogger) Error

func (l *ProxyLogger) Error(message string)

func (*ProxyLogger) Errorf

func (l *ProxyLogger) Errorf(message string, args ...interface{})

func (*ProxyLogger) LogFailedQuery

func (l *ProxyLogger) LogFailedQuery(method string, params interface{}, errorResponse interface{})

func (*ProxyLogger) LogSuccessfulQuery

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

func (*ProxyLogger) Logger

func (l *ProxyLogger) Logger() *logrus.Logger

type QueryMonitor

type QueryMonitor interface {
	LogSuccessfulQuery(method string, time float64, params interface{}, response interface{})
	LogFailedQuery(method string, params interface{}, errorResponse interface{})
	Error(message string)
	Errorf(message string, args ...interface{})
	Logger() *logrus.Logger
}