monitor

README

monitor

Documentation

Index

• Constants
• Variables
• func EnabledTracing()
• func LogOutbound(rt http.RoundTripper) http.RoundTripper
• func SubscribeMonitor(logger *zap.Logger, item MonitorService)
• func ToByte(obj any) []byte
• type AppSettings
• type ConsoleTracing
  • func InitConsoleTracingService(log *zap.Logger) *ConsoleTracing
  • func (tr *ConsoleTracing) LogBody(req *TracingDetails) error
• type GinTracingService
  • func (tr *GinTracingService) LogfullRequestDetails(c *gin.Context)
  • func (tr *GinTracingService) OnEngineInited(r *gin.Engine) error
  • func (tr *GinTracingService) Priority() int
• type MonitorService
• type RespLogging
  • func (w RespLogging) Write(b []byte) (int, error)
• type TracingDetails
• type TracingRequestService
  • func (tr *TracingRequestService) ShouldLogReq(ctx context.Context, uri string) bool

Constants

const (
	KeyTracingID = "tracingID"
)

Variables

var InitTracingService = func(logger *zap.Logger) *TracingRequestService {
	sr := &TracingRequestService{
		Log: logger,
	}

	settings := viper.Sub("tracing")
	if settings == nil {
		logger.Warn("tracing module loaded, but disabled.")
		return sr
	}

	settings.Unmarshal(sr)

	logger.Info("tracing service is enabled.")
	if (sr.Request || sr.Resp) && sr.Console {
		c := InitConsoleTracingService(sr.Log)
		TracingAdaptor.Subscripter("console", c.LogBody)
	}

	return sr
}

var TracingAdaptor = core.NewChanAdaptor[*TracingDetails](math.MaxInt16)

Functions

func EnabledTracing

func EnabledTracing()

func LogOutbound

func LogOutbound(rt http.RoundTripper) http.RoundTripper

func SubscribeMonitor

func SubscribeMonitor(logger *zap.Logger, item MonitorService)

func ToByte

func ToByte(obj any) []byte

Types

type AppSettings

type AppSettings struct {
	Appname string
	Version string
	Details bool
}

type ConsoleTracing

type ConsoleTracing struct {
	Log *zap.Logger
}

func InitConsoleTracingService

func InitConsoleTracingService(log *zap.Logger) *ConsoleTracing

func (*ConsoleTracing) LogBody

func (tr *ConsoleTracing) LogBody(req *TracingDetails) error

type GinTracingService

type GinTracingService struct {
	Service *TracingRequestService
}

func (*GinTracingService) LogfullRequestDetails

func (tr *GinTracingService) LogfullRequestDetails(c *gin.Context)

func (*GinTracingService) OnEngineInited

func (tr *GinTracingService) OnEngineInited(r *gin.Engine) error

func (*GinTracingService) Priority

func (tr *GinTracingService) Priority() int

type MonitorService

type MonitorService interface {
	ReportTracing(tr *TracingDetails) error
	ReportError(core.ErrorReport) error
	ReportScheduleJob(req *schedule.JobHistory) error
}

type RespLogging

type RespLogging struct {
	gin.ResponseWriter
	// contains filtered or unexported fields
}

func (RespLogging) Write

func (w RespLogging) Write(b []byte) (int, error)

type TracingDetails

type TracingDetails struct {
	Optionname string
	Uri        string
	Method     string
	Body       any
	Durtion    time.Duration
	Status     int
	TargetID   uint
	Resp       any
	ClientIP   string
	UserAgent  string
	Device     string
	Tenant     string
	Operator   string
}

type TracingRequestService

type TracingRequestService struct {
	Log      *zap.Logger
	Console  bool
	Request  bool
	Resp     bool
	Included []string
	Excluded []string
}

func (*TracingRequestService) ShouldLogReq

func (tr *TracingRequestService) ShouldLogReq(ctx context.Context, uri string) bool