tracing

Documentation

Index

• Constants
• Variables
• func EnabledTracing()
• func SubEventToDB(tr *TracingRequestServiceDBImpl, bus EventBus.Bus)
• type ConsoleTracing
  • func InitConsoleTracingService(log *zap.Logger) *ConsoleTracing
  • func (tr *ConsoleTracing) LogBody(req *TracingDetails)
• type FullRequestDetails
• type RespLogging
  • func (w RespLogging) Write(b []byte) (int, error)
• type TracingDetails
• type TracingRequestService
  • func (tr *TracingRequestService) LogfullRequestDetails(c *gin.Context)
  • func (tr *TracingRequestService) OnEngineInited(r *gin.Engine) error
  • func (tr *TracingRequestService) Priority() int
• type TracingRequestServiceDBImpl
  • func NewTracingRequestService(db *gorm.DB, logger *zap.Logger) (*TracingRequestServiceDBImpl, error)

Constants

const (
	KeyTracingID = "tracingID"
)

Variables

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

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

	settings.Unmarshal(sr)

	logger.Info("tracing service is enabled.")
	if (sr.Request || sr.Resp) && sr.Console {
		c := InitConsoleTracingService(sr.Log)
		sr.Bus.SubscribeAsync(event.EventTracing, c.LogBody, false)
	}
	core.RegisterComponent(sr)
	return sr
}

Functions

func EnabledTracing

func EnabledTracing()

func SubEventToDB

func SubEventToDB(tr *TracingRequestServiceDBImpl, bus EventBus.Bus)

Types

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)

type FullRequestDetails

type FullRequestDetails struct {
	gorm.Model
	TracingDetails
}

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 `gorm:"size:64"`
	Uri        string `gorm:"size:256"`
	Method     string `gorm:"size:16"`
	Body       string
	Durtion    time.Duration
	Status     int
	TargetID   uint
	Resp       string
	ClientIP   string `gorm:"size:64"`
	UserAgent  string `gorm:"size:256"`
	Device     string `gorm:"size:64"`
}

type TracingRequestService

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

func (*TracingRequestService) LogfullRequestDetails

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

func (*TracingRequestService) OnEngineInited

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

func (*TracingRequestService) Priority

func (tr *TracingRequestService) Priority() int

type TracingRequestServiceDBImpl

type TracingRequestServiceDBImpl struct {
	DB     *gorm.DB
	Logger *zap.Logger
}

func NewTracingRequestService

func NewTracingRequestService(db *gorm.DB, logger *zap.Logger) (*TracingRequestServiceDBImpl, error)