audit

Documentation

Index

• func SetDefault(audit *Audit)
• func WithAudit(ctx context.Context, audit *Audit) context.Context
• type Audit
  • func Default() *Audit
  • func NewAudit(opts ...Option) *Audit
  • func (a *Audit) Middleware(module string, getFields func(ctx *gin.Context) []zap.Field) gin.HandlerFunc
  • func (a *Audit) Module(module string) *Audit
  • func (a *Audit) Record(ctx context.Context, eventName string, fields ...zap.Field) error
  • func (a *Audit) With(fields ...zap.Field) *Audit
• type CtxAudit
  • func Ctx(ctx context.Context) *CtxAudit
  • func NewCtxAudit(ctx context.Context, audit *Audit) *CtxAudit
  • func (c *CtxAudit) Record(eventName string, fields ...zap.Field) error
• type Option
  • func WithStorage(storage Storage) Option
• type Options
• type Storage

Functions

func SetDefault

func SetDefault(audit *Audit)

func WithAudit

func WithAudit(ctx context.Context, audit *Audit) context.Context

Types

type Audit

type Audit struct {
	// contains filtered or unexported fields
}

func Default

func Default() *Audit

func NewAudit

func NewAudit(opts ...Option) *Audit

NewAudit 创建审计 你可以实现 Storage 接口来自定义审计存储 默认的话可以使用日志组件来存储审计日志

func (*Audit) Middleware

func (a *Audit) Middleware(module string, getFields func(ctx *gin.Context) []zap.Field) gin.HandlerFunc

Middleware 中间件 可以添加自定义的字段

func (*Audit) Module

func (a *Audit) Module(module string) *Audit

Module 设置模块

func (*Audit) Record

func (a *Audit) Record(ctx context.Context, eventName string, fields ...zap.Field) error

Record 记录审计日志

func (*Audit) With

func (a *Audit) With(fields ...zap.Field) *Audit

With 添加字段

type CtxAudit

type CtxAudit struct {
	context.Context
	*Audit
}

func Ctx

func Ctx(ctx context.Context) *CtxAudit

func NewCtxAudit

func NewCtxAudit(ctx context.Context, audit *Audit) *CtxAudit

func (*CtxAudit) Record

func (c *CtxAudit) Record(eventName string, fields ...zap.Field) error

type Option

type Option func(*Options)

func WithStorage

func WithStorage(storage Storage) Option

type Options

type Options struct {
	// contains filtered or unexported fields
}

type Storage

type Storage interface {
	Record(ctx context.Context, module, eventName string, fields ...zap.Field) error
}