Skip to content

Commit

Permalink
Use StringFomat as default
Browse files Browse the repository at this point in the history
  • Loading branch information
@minhduc140583
minhduc140583 committed Aug 25, 2024
1 parent 298805f commit 060eeea
Show file tree
Hide file tree
Showing 9 changed files with 128 additions and 128 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Middleware logging is a technique used in software development, particularly in
### Middleware Integration
#### Features
- <b>Middleware Function</b>: Designed to integrate seamlessly with existing Go libraries: [Echo](https://github.com/labstack/echo), [Gin](https://github.com/gin-gonic/gin), or net/http ([Gorilla mux](https://github.com/gorilla/mux), [Go-chi](https://github.com/go-chi/chi)).
- Sample for [Echo](https://github.com/labstack/echo) is at [go-sql-echo-sample](https://github.com/go-tutorials/go-sql-echo-sample)
- Sample for [Gin](https://github.com/gin-gonic/gin) is at [go-sql-gin-sample](https://github.com/go-tutorials/go-sql-gin-sample)
- Sample for [Echo](https://github.com/labstack/echo) is at [go-echo-sql-sample](https://github.com/go-tutorials/go-echo-sql-sample)
- Sample for [Gin](https://github.com/gin-gonic/gin) is at [go-gin-sql-sample](https://github.com/go-tutorials/go-gin-sql-sample)
- Sample for [Gorilla mux](https://github.com/gorilla/mux) is at [go-sql-sample](https://github.com/go-tutorials/go-sql-sample)
- <b>Context Handling</b>: Pass context to handle request-specific data throughout the middleware chain.
#### Benefits
Expand All @@ -71,8 +71,8 @@ Middleware logging is a technique used in software development, particularly in
- <b>Consistency</b>: Ensures that sensitive data is consistently encrypted or masked across all logged requests and responses

#### Samples:
- Sample for [Echo](https://github.com/labstack/echo) is at [go-sql-echo-sample](https://github.com/go-tutorials/go-sql-echo-sample)
- Sample for [Gin](https://github.com/gin-gonic/gin) is at [go-sql-gin-sample](https://github.com/go-tutorials/go-sql-gin-sample)
- Sample for [Echo](https://github.com/labstack/echo) is at [go-echo-sql-sample](https://github.com/go-tutorials/go-echo-sql-sample)
- Sample for [Gin](https://github.com/gin-gonic/gin) is at [go-gin-sql-sample](https://github.com/go-tutorials/go-gin-sql-sample)
- Sample for [Gorilla mux](https://github.com/gorilla/mux) is at [go-sql-sample](https://github.com/go-tutorials/go-sql-sample)

### Enable/Disable Logging
Expand Down
32 changes: 16 additions & 16 deletions echo/mask_logger.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,57 +14,57 @@ type MaskLogger struct {
RequestKey string
MaskRequest func(map[string]interface{})
MaskResponse func(map[string]interface{})
StringFormat bool
JsonFormat bool
}

func NewMaskLogger(requestKey string, maskRequest func(map[string]interface{}), maskResponse func(map[string]interface{}), stringFormat bool) *MaskLogger {
return &MaskLogger{RequestKey: requestKey, MaskRequest: maskRequest, MaskResponse: maskResponse, StringFormat: stringFormat}
func NewMaskLogger(requestKey string, maskRequest func(map[string]interface{}), maskResponse func(map[string]interface{}), jsonFormat bool) *MaskLogger {
return &MaskLogger{RequestKey: requestKey, MaskRequest: maskRequest, MaskResponse: maskResponse, JsonFormat: jsonFormat}
}
func NewMaskLoggerWithSending(requestKey string, maskRequest func(map[string]interface{}), maskResponse func(map[string]interface{}), stringFormat bool, send func(context.Context, []byte, map[string]string) error, options ...map[string]string) *MaskLogger {
func NewMaskLoggerWithSending(requestKey string, maskRequest func(map[string]interface{}), maskResponse func(map[string]interface{}), jsonFormat bool, send func(context.Context, []byte, map[string]string) error, options ...map[string]string) *MaskLogger {
var keyMap map[string]string
if len(options) >= 1 {
keyMap = options[0]
}
return &MaskLogger{RequestKey: requestKey, MaskRequest: maskRequest, MaskResponse: maskResponse, StringFormat: stringFormat, send: send, KeyMap: keyMap}
return &MaskLogger{RequestKey: requestKey, MaskRequest: maskRequest, MaskResponse: maskResponse, JsonFormat: jsonFormat, send: send, KeyMap: keyMap}
}
func (l *MaskLogger) LogResponse(log func(context.Context, string, map[string]interface{}), r *http.Request, ww WrapResponseWriter,
c LogConfig, t1 time.Time, response string, fields map[string]interface{}, includeRequest bool) {
if includeRequest && len(c.Request) > 0 {
MaskRequest(c.Request, fields, l.MaskRequest, l.StringFormat)
MaskRequest(c.Request, fields, l.MaskRequest, l.JsonFormat)
}
MaskResponse(ww, c, t1, response, fields, l.MaskResponse, l.StringFormat)
MaskResponse(ww, c, t1, response, fields, l.MaskResponse, l.JsonFormat)
msg := r.Method + " " + r.RequestURI
log(r.Context(), msg, fields)
if l.send != nil {
go Send(r.Context(), l.send, msg, fields, l.KeyMap)
}
}
func (l *MaskLogger) LogRequest(log func(context.Context, string, map[string]interface{}), r *http.Request, fields map[string]interface{}) {
MaskRequest(l.RequestKey, fields, l.MaskRequest, l.StringFormat)
MaskRequest(l.RequestKey, fields, l.MaskRequest, l.JsonFormat)
msg := "Request " + r.Method + " " + r.RequestURI
log(r.Context(), msg, fields)
if l.send != nil {
go Send(r.Context(), l.send, msg, fields, l.KeyMap)
}
}

func MaskResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response string, fields map[string]interface{}, mask func(map[string]interface{}), isStringFormat bool) {
func MaskResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response string, fields map[string]interface{}, mask func(map[string]interface{}), isJsonFormat bool) {
if len(c.Response) > 0 {
fields[c.Response] = response
responseBody := response
responseMap := map[string]interface{}{}
json.Unmarshal([]byte(responseBody), &responseMap)
if len(responseMap) > 0 {
mask(responseMap)
if isStringFormat {
if isJsonFormat {
fields[c.Response] = responseMap
} else {
responseString, err := json.Marshal(responseMap)
if err != nil {
fmt.Printf("Error: %s", err.Error())
} else {
fields[c.Response] = string(responseString)
}
} else {
fields[c.Response] = responseMap
}
}
}
Expand All @@ -80,7 +80,7 @@ func MaskResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response str
fields[c.Size] = ww.BytesWritten()
}
}
func MaskRequest(request string, fields map[string]interface{}, mask func(map[string]interface{}), isStringFormat bool) {
func MaskRequest(request string, fields map[string]interface{}, mask func(map[string]interface{}), isJsonFormat bool) {
if len(request) > 0 {
req, ok := fields[request]
if ok {
Expand All @@ -90,15 +90,15 @@ func MaskRequest(request string, fields map[string]interface{}, mask func(map[st
json.Unmarshal([]byte(requestBody), &requestMap)
if len(requestMap) > 0 {
mask(requestMap)
if isStringFormat {
if isJsonFormat {
fields[request] = requestMap
} else {
requestString, err := json.Marshal(requestMap)
if err != nil {
fmt.Printf("Error: %s", err.Error())
} else {
fields[request] = string(requestString)
}
} else {
fields[request] = requestMap
}
}
}
Expand Down
30 changes: 15 additions & 15 deletions echo/structured_logger.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,30 @@ type Formatter interface {
LogResponse(log func(context.Context, string, map[string]interface{}), r *http.Request, ww WrapResponseWriter, c LogConfig, startTime time.Time, response string, fields map[string]interface{}, includeRequest bool)
}
type StructuredLogger struct {
send func(context.Context, []byte, map[string]string) error
KeyMap map[string]string
RequestKey string
StringFormat bool
send func(context.Context, []byte, map[string]string) error
KeyMap map[string]string
RequestKey string
JsonFormat bool
}

var fieldConfig FieldConfig

func NewLogger() *StructuredLogger {
return &StructuredLogger{}
}
func NewLoggerWithStringFormat(requestKey string, stringFormat bool) *StructuredLogger {
return &StructuredLogger{RequestKey: requestKey, StringFormat: stringFormat}
func NewLoggerWithStringFormat(requestKey string, jsonFormat bool) *StructuredLogger {
return &StructuredLogger{RequestKey: requestKey, JsonFormat: jsonFormat}
}
func NewLoggerWithSending(requestKey string, stringFormat bool, send func(context.Context, []byte, map[string]string) error, options ...map[string]string) *StructuredLogger {
func NewLoggerWithSending(requestKey string, jsonFormat bool, send func(context.Context, []byte, map[string]string) error, options ...map[string]string) *StructuredLogger {
var keyMap map[string]string
if len(options) >= 1 {
keyMap = options[0]
}
return &StructuredLogger{RequestKey: requestKey, StringFormat: stringFormat, send: send, KeyMap: keyMap}
return &StructuredLogger{RequestKey: requestKey, JsonFormat: jsonFormat, send: send, KeyMap: keyMap}
}
func (l *StructuredLogger) LogResponse(log func(context.Context, string, map[string]interface{}), r *http.Request, ww WrapResponseWriter,
c LogConfig, t1 time.Time, response string, fields map[string]interface{}, includeRequest bool) {
BuildResponse(ww, c, t1, response, fields, l.StringFormat)
BuildResponse(ww, c, t1, response, fields, l.JsonFormat)
msg := r.Method + " " + r.RequestURI
log(r.Context(), msg, fields)
if l.send != nil {
Expand All @@ -53,7 +53,7 @@ func Send(ctx context.Context, send func(context.Context, []byte, map[string]str
}
func (l *StructuredLogger) LogRequest(log func(context.Context, string, map[string]interface{}), r *http.Request, fields map[string]interface{}) {
msg := "Request " + r.Method + " " + r.RequestURI
if !l.StringFormat && len(l.RequestKey) > 0 {
if l.JsonFormat && len(l.RequestKey) > 0 {
req, ok := fields[l.RequestKey]
if ok {
requestBody, ok2 := req.(string)
Expand All @@ -72,11 +72,9 @@ func (l *StructuredLogger) LogRequest(log func(context.Context, string, map[stri
}
}

func BuildResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response string, fields map[string]interface{}, isStringFormat bool) {
func BuildResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response string, fields map[string]interface{}, jsonFormat bool) {
if len(c.Response) > 0 {
if isStringFormat {
fields[c.Response] = response
} else {
if jsonFormat {
responseBody := response
responseMap := map[string]interface{}{}
json.Unmarshal([]byte(responseBody), &responseMap)
Expand All @@ -85,9 +83,11 @@ func BuildResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response st
} else {
fields[c.Response] = response
}
} else {
fields[c.Response] = response
}
}
if !isStringFormat && len(c.Request) > 0 {
if jsonFormat && len(c.Request) > 0 {
req, ok := fields[c.Request]
if ok {
requestBody, ok2 := req.(string)
Expand Down
32 changes: 16 additions & 16 deletions echo/v3/mask_logger.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,57 +14,57 @@ type MaskLogger struct {
RequestKey string
MaskRequest func(map[string]interface{})
MaskResponse func(map[string]interface{})
StringFormat bool
JsonFormat bool
}

func NewMaskLogger(requestKey string, maskRequest func(map[string]interface{}), maskResponse func(map[string]interface{}), stringFormat bool) *MaskLogger {
return &MaskLogger{RequestKey: requestKey, MaskRequest: maskRequest, MaskResponse: maskResponse, StringFormat: stringFormat}
func NewMaskLogger(requestKey string, maskRequest func(map[string]interface{}), maskResponse func(map[string]interface{}), jsonFormat bool) *MaskLogger {
return &MaskLogger{RequestKey: requestKey, MaskRequest: maskRequest, MaskResponse: maskResponse, JsonFormat: jsonFormat}
}
func NewMaskLoggerWithSending(requestKey string, maskRequest func(map[string]interface{}), maskResponse func(map[string]interface{}), stringFormat bool, send func(context.Context, []byte, map[string]string) error, options ...map[string]string) *MaskLogger {
func NewMaskLoggerWithSending(requestKey string, maskRequest func(map[string]interface{}), maskResponse func(map[string]interface{}), jsonFormat bool, send func(context.Context, []byte, map[string]string) error, options ...map[string]string) *MaskLogger {
var keyMap map[string]string
if len(options) >= 1 {
keyMap = options[0]
}
return &MaskLogger{RequestKey: requestKey, MaskRequest: maskRequest, MaskResponse: maskResponse, StringFormat: stringFormat, send: send, KeyMap: keyMap}
return &MaskLogger{RequestKey: requestKey, MaskRequest: maskRequest, MaskResponse: maskResponse, JsonFormat: jsonFormat, send: send, KeyMap: keyMap}
}
func (l *MaskLogger) LogResponse(log func(context.Context, string, map[string]interface{}), r *http.Request, ww WrapResponseWriter,
c LogConfig, t1 time.Time, response string, fields map[string]interface{}, includeRequest bool) {
if includeRequest && len(c.Request) > 0 {
MaskRequest(c.Request, fields, l.MaskRequest, l.StringFormat)
MaskRequest(c.Request, fields, l.MaskRequest, l.JsonFormat)
}
MaskResponse(ww, c, t1, response, fields, l.MaskResponse, l.StringFormat)
MaskResponse(ww, c, t1, response, fields, l.MaskResponse, l.JsonFormat)
msg := r.Method + " " + r.RequestURI
log(r.Context(), msg, fields)
if l.send != nil {
go Send(r.Context(), l.send, msg, fields, l.KeyMap)
}
}
func (l *MaskLogger) LogRequest(log func(context.Context, string, map[string]interface{}), r *http.Request, fields map[string]interface{}) {
MaskRequest(l.RequestKey, fields, l.MaskRequest, l.StringFormat)
MaskRequest(l.RequestKey, fields, l.MaskRequest, l.JsonFormat)
msg := "Request " + r.Method + " " + r.RequestURI
log(r.Context(), msg, fields)
if l.send != nil {
go Send(r.Context(), l.send, msg, fields, l.KeyMap)
}
}

func MaskResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response string, fields map[string]interface{}, mask func(map[string]interface{}), isStringFormat bool) {
func MaskResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response string, fields map[string]interface{}, mask func(map[string]interface{}), isJsonFormat bool) {
if len(c.Response) > 0 {
fields[c.Response] = response
responseBody := response
responseMap := map[string]interface{}{}
json.Unmarshal([]byte(responseBody), &responseMap)
if len(responseMap) > 0 {
mask(responseMap)
if isStringFormat {
if isJsonFormat {
fields[c.Response] = responseMap
} else {
responseString, err := json.Marshal(responseMap)
if err != nil {
fmt.Printf("Error: %s", err.Error())
} else {
fields[c.Response] = string(responseString)
}
} else {
fields[c.Response] = responseMap
}
}
}
Expand All @@ -80,7 +80,7 @@ func MaskResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response str
fields[c.Size] = ww.BytesWritten()
}
}
func MaskRequest(request string, fields map[string]interface{}, mask func(map[string]interface{}), isStringFormat bool) {
func MaskRequest(request string, fields map[string]interface{}, mask func(map[string]interface{}), isJsonFormat bool) {
if len(request) > 0 {
req, ok := fields[request]
if ok {
Expand All @@ -90,15 +90,15 @@ func MaskRequest(request string, fields map[string]interface{}, mask func(map[st
json.Unmarshal([]byte(requestBody), &requestMap)
if len(requestMap) > 0 {
mask(requestMap)
if isStringFormat {
if isJsonFormat {
fields[request] = requestMap
} else {
requestString, err := json.Marshal(requestMap)
if err != nil {
fmt.Printf("Error: %s", err.Error())
} else {
fields[request] = string(requestString)
}
} else {
fields[request] = requestMap
}
}
}
Expand Down
30 changes: 15 additions & 15 deletions echo/v3/structured_logger.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,30 @@ type Formatter interface {
LogResponse(log func(context.Context, string, map[string]interface{}), r *http.Request, ww WrapResponseWriter, c LogConfig, startTime time.Time, response string, fields map[string]interface{}, includeRequest bool)
}
type StructuredLogger struct {
send func(context.Context, []byte, map[string]string) error
KeyMap map[string]string
RequestKey string
StringFormat bool
send func(context.Context, []byte, map[string]string) error
KeyMap map[string]string
RequestKey string
JsonFormat bool
}

var fieldConfig FieldConfig

func NewLogger() *StructuredLogger {
return &StructuredLogger{}
}
func NewLoggerWithStringFormat(requestKey string, stringFormat bool) *StructuredLogger {
return &StructuredLogger{RequestKey: requestKey, StringFormat: stringFormat}
func NewLoggerWithStringFormat(requestKey string, jsonFormat bool) *StructuredLogger {
return &StructuredLogger{RequestKey: requestKey, JsonFormat: jsonFormat}
}
func NewLoggerWithSending(requestKey string, stringFormat bool, send func(context.Context, []byte, map[string]string) error, options ...map[string]string) *StructuredLogger {
func NewLoggerWithSending(requestKey string, jsonFormat bool, send func(context.Context, []byte, map[string]string) error, options ...map[string]string) *StructuredLogger {
var keyMap map[string]string
if len(options) >= 1 {
keyMap = options[0]
}
return &StructuredLogger{RequestKey: requestKey, StringFormat: stringFormat, send: send, KeyMap: keyMap}
return &StructuredLogger{RequestKey: requestKey, JsonFormat: jsonFormat, send: send, KeyMap: keyMap}
}
func (l *StructuredLogger) LogResponse(log func(context.Context, string, map[string]interface{}), r *http.Request, ww WrapResponseWriter,
c LogConfig, t1 time.Time, response string, fields map[string]interface{}, includeRequest bool) {
BuildResponse(ww, c, t1, response, fields, l.StringFormat)
BuildResponse(ww, c, t1, response, fields, l.JsonFormat)
msg := r.Method + " " + r.RequestURI
log(r.Context(), msg, fields)
if l.send != nil {
Expand All @@ -53,7 +53,7 @@ func Send(ctx context.Context, send func(context.Context, []byte, map[string]str
}
func (l *StructuredLogger) LogRequest(log func(context.Context, string, map[string]interface{}), r *http.Request, fields map[string]interface{}) {
msg := "Request " + r.Method + " " + r.RequestURI
if !l.StringFormat && len(l.RequestKey) > 0 {
if l.JsonFormat && len(l.RequestKey) > 0 {
req, ok := fields[l.RequestKey]
if ok {
requestBody, ok2 := req.(string)
Expand All @@ -72,11 +72,9 @@ func (l *StructuredLogger) LogRequest(log func(context.Context, string, map[stri
}
}

func BuildResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response string, fields map[string]interface{}, isStringFormat bool) {
func BuildResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response string, fields map[string]interface{}, jsonFormat bool) {
if len(c.Response) > 0 {
if isStringFormat {
fields[c.Response] = response
} else {
if jsonFormat {
responseBody := response
responseMap := map[string]interface{}{}
json.Unmarshal([]byte(responseBody), &responseMap)
Expand All @@ -85,9 +83,11 @@ func BuildResponse(ww WrapResponseWriter, c LogConfig, t1 time.Time, response st
} else {
fields[c.Response] = response
}
} else {
fields[c.Response] = response
}
}
if !isStringFormat && len(c.Request) > 0 {
if jsonFormat && len(c.Request) > 0 {
req, ok := fields[c.Request]
if ok {
requestBody, ok2 := req.(string)
Expand Down
Loading

0 comments on commit 060eeea

Please sign in to comment.