logger

package module

v0.1.2 Latest Latest Go to latest Published: Sep 15, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/wego/pkg

Links

Open Source Insights

Documentation ¶

Index ¶

func ContextWithRequest(ctx context.Context, req *Request) context.Context
func ContextWithRequestType(ctx context.Context, reqType RequestType) context.Context
func Init() error
func LogPartnerRequest(log *PartnerRequest)
func LogRequest(log *Request)
func LogUltronEx(msg *UltronExMsg)
func RedactJSON(json, replacement string, keys [][]string) string
func RedactXML(xml, replacement string, tags []string) string
func Sync()
type Headers
- func (h Headers) MarshalLogArray(enc zapcore.ArrayEncoder) error
type PartnerRequest
type Request
- func RequestFromContext(ctx context.Context) (req *Request)
type RequestType
- func RequestTypeFromContext(ctx context.Context) (reqType RequestType)
type UltronExMsg
- func (um UltronExMsg) MarshalLogObject(enc zapcore.ObjectEncoder) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ContextWithRequest ¶

func ContextWithRequest(ctx context.Context, req *Request) context.Context

ContextWithRequest returns a new context from a parent context with request added into it

func ContextWithRequestType ¶

func ContextWithRequestType(ctx context.Context, reqType RequestType) context.Context

ContextWithRequestType returns a new context from a parent context with request type added into it

func Init ¶

func Init() error

Init initializes loggers

func LogPartnerRequest ¶

func LogPartnerRequest(log *PartnerRequest)

LogPartnerRequest logs a partner request to local file

func LogRequest ¶

func LogRequest(log *Request)

LogRequest logs a request to local file

func LogUltronEx ¶

func LogUltronEx(msg *UltronExMsg)

LogUltronEx logs a msg to UltronEx local file

func RedactJSON ¶

func RedactJSON(json, replacement string, keys [][]string) string

RedactJSON replaces value of key paths from the input JSON with replacement or defaultReplacement when replacement is empty

Example:

input = `
{
	"first": "first value",
	"second": {
		"first": "1st of second",
		"second": "2nd of second",
		"third": {
			"first": "1st of second third",
			"second": "2nd of second third",
			"third": "3rd of second third",
		}
	}
}`
keys := [][]string{{"first"}, {"second", "second"}, {"second", "third", "first"}}
RedactJSON(input, "Wego", keys) will return
{
	"first": "Wego",
	"second": {
		"first": "1st of second",
		"second": "Wego",
		"third": {
			"first": "Wego",
			"second": "2nd of second third",
			"third": "3rd of second third",
		}
	}
}

func RedactXML ¶

func RedactXML(xml, replacement string, tags []string) string

RedactXML replaces inner text of tags from the input XML with replacement or defaultReplacement when replacement is empty

func Sync ¶

func Sync()

Sync syncs all loggers

Types ¶

type Headers ¶

type Headers map[string]string

Headers ...

func (Headers) MarshalLogArray ¶

func (h Headers) MarshalLogArray(enc zapcore.ArrayEncoder) error

MarshalLogArray marshal Headers to zap log array Need to implement this to log it with zap.Array

type PartnerRequest ¶

type PartnerRequest struct {
	PartnerCode string
	PartnerRef  string
	Request
}

PartnerRequest contains information of requests we sent to our partners

type Request ¶

type Request struct {
	Type            RequestType
	PaymentRef      string
	DeploymentRef   string
	ClientCode      string
	TransactionRef  string
	Method          string
	URL             string
	RequestHeaders  Headers
	RequestBody     string
	IP              string
	StatusCode      int32
	ResponseHeaders Headers
	ResponseBody    string
	RequestedAt     time.Time
	Duration        time.Duration
	Error           error
}

Request contains general information of a request

func RequestFromContext ¶

func RequestFromContext(ctx context.Context) (req *Request)

RequestFromContext gets the request from context

type RequestType ¶

type RequestType string

RequestType ...

const (
	RequestTypeValidateOrder         RequestType = "ValidateOrder"
	RequestTypeUpdatePostAuthResult  RequestType = "UpdatePostAuthResult"
	RequestTypeCompleteOrder         RequestType = "CompleteOrder"
	RequestTypeCancelOrderByCustomer RequestType = "CancelOrderByCustomer"
	RequestTypeCancelOrderByMerchant RequestType = "CancelOrderByMerchant"
	RequestTypeClaimChargeback       RequestType = "ClaimChargeback"

	RequestTypeFetchAccessToken RequestType = "FetchAccessToken"

	RequestTypeGetPaymentOptions      RequestType = "GetPaymentOptions"
	RequestTypeAuthorizePayment       RequestType = "AuthorizePayment"
	RequestTypeVoidPayment            RequestType = "VoidPayment"
	RequestTypeCapturePayment         RequestType = "CapturePayment"
	RequestTypeRefundPayment          RequestType = "RefundPayment"
	RequestTypeGetPaymentDetails      RequestType = "GetPaymentDetails"
	RequestTypeGetPaymentActions      RequestType = "GetPaymentActions"
	RequestTypeGetDisputes            RequestType = "GetDisputes"
	RequestTypeProcessDisputes        RequestType = "ProcessDisputes"
	RequestTypeGetDisputeDetails      RequestType = "GetDisputeDetails"
	RequestTypeQueryBIN               RequestType = "QueryBIN"
	RequestTypeRequestToken           RequestType = "RequestToken"
	RequestTypeRedirectPost3DS        RequestType = "RedirectPost3DS"
	RequestTypeProcessPendingPayments RequestType = "ProcessPendingPayments"

	RequestTypeDeployVirtualCard               RequestType = "DeployVirtualCard"
	RequestTypeUpdateVirtualCardDeployment     RequestType = "UpdateVirtualCardDeployment"
	RequestTypeGetVirtualCardDeploymentDetails RequestType = "GetVirtualCardDeploymentDetails"
	RequestTypeGetVirtualCardActivities        RequestType = "GetVirtualCardActivities"
	RequestTypeCancelVirtualCardDeployment     RequestType = "CancelVirtualCardDeployment"
	RequestTypeGetCardDetailsPublic            RequestType = "GetCardDetailsPublic"
	RequestTypeGetCardDetails                  RequestType = "GetCardDetails"

	RequestTypeSendDisputeEvent RequestType = "SendDisputeEvent"
	RequestTypeSendPaymentEvent RequestType = "SendPaymentEvent"

	RequestTypeUnknown RequestType = "Unknown"
)

PartnerRequestType list

func RequestTypeFromContext ¶

func RequestTypeFromContext(ctx context.Context) (reqType RequestType)

RequestTypeFromContext gets the request type from context

type UltronExMsg ¶

type UltronExMsg struct {
	Channel string
	Text    string
	Payload string
	Title   string
}

UltronExMsg ...

func (UltronExMsg) MarshalLogObject ¶

func (um UltronExMsg) MarshalLogObject(enc zapcore.ObjectEncoder) error

MarshalLogObject marshal UltronExMsg to zap log object The struct need to implement this, so we can log it with zap.Object

Source Files ¶

View all Source files

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