Add comment to LogFormatterParams struct's fields (#1711)
By https://github.com/gin-gonic/gin/issues/1701, I thought it's necessary.
This commit is contained in:
		
							
								
								
									
										25
									
								
								logger.go
									
									
									
									
									
								
							
							
						
						
									
										25
									
								
								logger.go
									
									
									
									
									
								
							@ -45,15 +45,24 @@ type LogFormatter func(params LogFormatterParams) string
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
// LogFormatterParams is the structure any formatter will be handed when time to log comes
 | 
					// LogFormatterParams is the structure any formatter will be handed when time to log comes
 | 
				
			||||||
type LogFormatterParams struct {
 | 
					type LogFormatterParams struct {
 | 
				
			||||||
	Request      *http.Request
 | 
						Request *http.Request
 | 
				
			||||||
	TimeStamp    time.Time
 | 
					
 | 
				
			||||||
	StatusCode   int
 | 
						// TimeStamp shows the time after the server returns a response.
 | 
				
			||||||
	Latency      time.Duration
 | 
						TimeStamp time.Time
 | 
				
			||||||
	ClientIP     string
 | 
						// StatusCode is HTTP response code.
 | 
				
			||||||
	Method       string
 | 
						StatusCode int
 | 
				
			||||||
	Path         string
 | 
						// 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
 | 
				
			||||||
 | 
						// ErrorMessage is set if error has occurred in processing the request.
 | 
				
			||||||
	ErrorMessage string
 | 
						ErrorMessage string
 | 
				
			||||||
	IsTerm       bool
 | 
						// IsTerm shows whether does gin's output descriptor refers to a terminal.
 | 
				
			||||||
 | 
						IsTerm bool
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
// defaultLogFormatter is the default log format function Logger middleware uses.
 | 
					// defaultLogFormatter is the default log format function Logger middleware uses.
 | 
				
			||||||
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user