logging

package

v0.0.0-...-1643d90 Latest Latest Go to latest Published: Jan 26, 2020 License: UPL-1.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitee.com/mirrors/Speedle

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 ¶

View Source

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"
)

View Source

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

Variables ¶

This section is empty.

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
demo

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL