lxAudit

Documentation

Index

• Constants
• Variables
• func NewQueue(clientHost, auditHost, auditHostAuthKey string, logEntry *logrus.Entry, ...) *queue
• func RequestAudit(elem interface{}, auditHost, auditAuthKey string, timeout ...time.Duration) error
• type AuditEntries
• type AuditEntry
• type IAudit

Constants

const (
	// Actions
	Insert = "insert"
	Update = "update"
	Delete = "delete"

	// Timeout for cancel request
	DefaultTimeout = time.Second * 15

	// Route paths
	PathLogEntry   = "/v1/log"
	PathLogEntries = "/v1/bulk/log"
)

Variables

var (
	ErrAuditEntryType = errors.New("must be AuditEntry or []AuditEntry type")
	ErrRespContent    = errors.New("response shouldn't have any content")
	ErrStatus         = errors.New("status must have 200")
)

Errors

Functions

func NewQueue

func NewQueue(clientHost, auditHost, auditHostAuthKey string, logEntry *logrus.Entry, workerThrottle ...time.Duration) *queue

NewQueue create instance of queue Example: queue := lxAudit.NewQueue(

"test-host",
server.URL,
"<auth key for host>",
lxLog.GetLogger().WithFields(logrus.Fields{}),
10 * time.Millisecond)

optional workerThrottle is time.Sleep after job

func RequestAudit

func RequestAudit(elem interface{}, auditHost, auditAuthKey string, timeout ...time.Duration) error

RequestAudit send entry or entries to audit service. This function can also be used independently of the worker. Example: err := lxAudit.RequestAudit(...)

Types

type AuditEntries

type AuditEntries []AuditEntry

AuditEntries transport type for service

type AuditEntry

type AuditEntry struct {
	Host       string      `json:"host"`
	Collection string      `json:"collection"`
	Action     string      `json:"action"`
	User       interface{} `json:"user"`
	Data       interface{} `json:"data"`
}

AuditEntry transport type for service

type IAudit

type IAudit interface {
	Send(elem interface{})
	IsActive() bool
}