README
¶
Hertz-accessLog
Hertz middleware to get access log.
Usage
Start using it
Download hertz-accessLog by using:
go get -u github.com/FlameMida/accessLog
Import following in your code:
import "github.com/FlameMida/accessLog" // hertz-accessLog middleware
Quick start
Run a default logger print in terminal
func main() {
h := server.Default()
h.Use(accessLog.Logger())
h.Spin()
}
Documentation
¶
Index ¶
- Variables
- func DisableConsoleColor()
- func ForceConsoleColor()
- func Logger() app.HandlerFunc
- func LoggerWithConfig(conf LoggerConfig) app.HandlerFunc
- func LoggerWithFormatter(f LogFormatter) app.HandlerFunc
- func LoggerWithWriter(out io.Writer, notLogged ...string) app.HandlerFunc
- type LogFormatter
- type LogFormatterParams
- type LoggerConfig
Constants ¶
This section is empty.
Variables ¶
var DefaultWriter io.Writer = os.Stdout
Functions ¶
func DisableConsoleColor ¶
func DisableConsoleColor()
DisableConsoleColor disables color output in the console.
func ForceConsoleColor ¶
func ForceConsoleColor()
ForceConsoleColor force color output in the console.
func Logger ¶
func Logger() app.HandlerFunc
Logger instances a Logger middleware that will write the logs to DefaultWriter. By default,os.Stdout.
func LoggerWithConfig ¶
func LoggerWithConfig(conf LoggerConfig) app.HandlerFunc
LoggerWithConfig instance a Logger middleware with config.
func LoggerWithFormatter ¶
func LoggerWithFormatter(f LogFormatter) app.HandlerFunc
LoggerWithFormatter instance a Logger middleware with the specified log format function.
func LoggerWithWriter ¶
func LoggerWithWriter(out io.Writer, notLogged ...string) app.HandlerFunc
LoggerWithWriter instance a Logger middleware with the specified writer buffer. Example: os.Stdout, a file opened in write mode, a socket...
Types ¶
type LogFormatter ¶
type LogFormatter func(params LogFormatterParams) string
LogFormatter gives the signature of the formatter function passed to LoggerWithFormatter
type LogFormatterParams ¶
type LogFormatterParams struct {
Request *protocol.Request
// TimeStamp shows the time after the server returns a response.
TimeStamp time.Time
// StatusCode is HTTP response code.
StatusCode int
// Latency is how much time the server cost to process a certain request.
Latency time.Duration
// ClientIP equals Context's ClientIP method.
ClientIP string
// Method is the HTTP method given to the request.
Method string
// Path is a path the client requests.
Path string
// Host is a Host the client requests.
Host string
// ErrorMessage is set if error has occurred in processing the request.
ErrorMessage string
// BodySize is the size of the Response Body
BodySize int
// Keys are the keys set on the request's context.
Keys map[string]any
// contains filtered or unexported fields
}
LogFormatterParams is the structure any formatter will be handed when time to log comes
func (*LogFormatterParams) IsOutputColor ¶
func (p *LogFormatterParams) IsOutputColor() bool
IsOutputColor indicates whether can colors be outputted to the log.
func (*LogFormatterParams) MethodColor ¶
func (p *LogFormatterParams) MethodColor() string
MethodColor is the ANSI color for appropriately logging http method to a terminal.
func (*LogFormatterParams) ResetColor ¶
func (p *LogFormatterParams) ResetColor() string
ResetColor resets all escape attributes.
func (*LogFormatterParams) StatusCodeColor ¶
func (p *LogFormatterParams) StatusCodeColor() string
StatusCodeColor is the ANSI color for appropriately logging http status code to a terminal.
type LoggerConfig ¶
type LoggerConfig struct {
// Optional. Default value is defaultLogFormatter
Formatter LogFormatter
// Output is a writer where logs are written.
// Optional. Default value is os.Stdout.
Output io.Writer
// SkipPaths is an url path array which logs are not written.
// Optional.
SkipPaths []string
}
LoggerConfig defines the config for Logger middleware.
Source Files