logging

Documentation

Index

• Constants
• func AuditLog() *log.Logger
• func InitAuditLog(cfg *LogConfig) error
• func InitLog(cfg *LogConfig) error
• func InitLogInstance(logger *log.Logger, cfg *LogConfig) error
• func SetTenantID(tid string)
• func WriteFailedAuditLog(apiName string, reqFields map[string]interface{}, reason string)
• func WriteSimpleFailedAuditLog(apiName string, reqField interface{}, reason string)
• func WriteSimpleSucceededAuditLog(apiName string, reqField interface{}, respField interface{})
• func WriteSucceededAuditLog(apiName string, reqFields map[string]interface{}, ...)
• type LogConfig

Constants

const (
	Response_Succeeded string = "succeeded"
	Response_Failed    string = "failed"

	Request_default_key  string = "requestValue"
	Response_default_key string = "responseValue"

	Audit_Prefix string = "[AUDIT]"

	TenantID_key     = "tenantid"
	Target_Index_Key = "target_index"
)

const (
	FORMATTER_TEXT = "text"
	FORMATTER_JSON = "json"
)

Functions

func AuditLog

func AuditLog() *log.Logger

func InitAuditLog

func InitAuditLog(cfg *LogConfig) error

Initialize Audit Logger

func InitLog

func InitLog(cfg *LogConfig) error

InitLog initializes the standard logger instance

func InitLogInstance

func InitLogInstance(logger *log.Logger, cfg *LogConfig) error

InitLogInstance initializes the specific logger instance

func SetTenantID

func SetTenantID(tid string)

func WriteFailedAuditLog

func WriteFailedAuditLog(apiName string, reqFields map[string]interface{}, reason string)

The request may have multiple contextual fields

func WriteSimpleFailedAuditLog

func WriteSimpleFailedAuditLog(apiName string, reqField interface{}, reason string)

The request has only one contextual field

func WriteSimpleSucceededAuditLog

func WriteSimpleSucceededAuditLog(apiName string, reqField interface{}, respField interface{})

The request or response have only one contextual field

func WriteSucceededAuditLog

func WriteSucceededAuditLog(apiName string, reqFields map[string]interface{}, respFields map[string]interface{})

The request or response may have multiple contextual fields

Types

type LogConfig

type LogConfig struct {
	Level           string             `json:"level,omitempty"`
	Formatter       string             `json:"formatter,omitempty"`
	SetReportCaller bool               `json:"setReportCaller,omitempty"`
	RotationConfig  *lumberjack.Logger `json:"rotationConfig,omitempty"`
}

LogConfig is the struct for the logger