Documentation
¶
Index ¶
- func FilterHeaders(h http.Header) string
- func FilterHeadersWithAdditionalSensitiveHeaders(h http.Header, headers ...string) string
- func FilterHeadersWithSensitiveHeaders(h http.Header, headers ...string) string
- func GetRequestBody(c *gin.Context) (map[string]interface{}, error)
- func GetRequestHeaders(c *gin.Context) map[string]interface{}
- func GetRequestQuery(c *gin.Context) map[string]interface{}
- func IsSkipped(c *gin.Context) bool
- func Middleware(source string, opts ...MiddlewareOption) gin.HandlerFunc
- func RequestInputs(c *gin.Context) (map[string]interface{}, error)
- func Skip(c *gin.Context)
- type Actor
- type ActorResolver
- type Config
- type Entry
- type Logger
- type MiddlewareOption
- func WithActorResolver(resolver ActorResolver) MiddlewareOption
- func WithAdditionalSensitiveFields(fields ...string) MiddlewareOption
- func WithAdditionalSensitiveHeaders(headers ...string) MiddlewareOption
- func WithLogger(logger *Logger) MiddlewareOption
- func WithSensitiveFields(fields ...string) MiddlewareOption
- func WithSensitiveHeaders(headers ...string) MiddlewareOption
- func WithSkipIPs(values ...string) MiddlewareOption
- func WithSkipMethods(methods ...string) MiddlewareOption
- func WithSkipper(skipper Skipper) MiddlewareOption
- type Skipper
- type Writer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FilterHeaders ¶
FilterHeaders filters sensitive request headers and returns a JSON string.
func FilterHeadersWithAdditionalSensitiveHeaders ¶
FilterHeadersWithAdditionalSensitiveHeaders filters default sensitive headers plus custom headers.
func FilterHeadersWithSensitiveHeaders ¶
FilterHeadersWithSensitiveHeaders filters the specified sensitive headers.
func GetRequestBody ¶
GetRequestBody 提取请求体,按 Content-Type 解析为 map
func GetRequestHeaders ¶
GetRequestHeaders 提取请求头为 map
func GetRequestQuery ¶
GetRequestQuery 提取 URL 查询参数为 map
func Middleware ¶
func Middleware(source string, opts ...MiddlewareOption) gin.HandlerFunc
Middleware records HTTP request and response metadata. The logger is optional so services can opt in with WithLogger.
func RequestInputs ¶
RequestInputs 分离 GET 查询参数和 POST 请求体
Types ¶
type ActorResolver ¶
type Entry ¶
type Entry struct {
Source string
TrackID string
TraceID string
RequestID string
UID string
Method string
Path string
Query string
IP string
UserAgent string
Headers []byte
ReqBody []byte
StatusCode int
ErrCode int
ErrMsg string
RespBody []byte
Latency int64
CreatedAt int64
}
Entry is a generic HTTP access log record. It intentionally has no dependency on any concrete database model.
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger asynchronously buffers access log entries and writes them in batches.
type MiddlewareOption ¶
type MiddlewareOption func(*middlewareConfig)
func WithActorResolver ¶
func WithActorResolver(resolver ActorResolver) MiddlewareOption
func WithAdditionalSensitiveFields ¶
func WithAdditionalSensitiveFields(fields ...string) MiddlewareOption
WithAdditionalSensitiveFields appends body field keywords to the default redaction list.
func WithAdditionalSensitiveHeaders ¶
func WithAdditionalSensitiveHeaders(headers ...string) MiddlewareOption
WithAdditionalSensitiveHeaders appends request header names to the default filter list.
func WithLogger ¶
func WithLogger(logger *Logger) MiddlewareOption
func WithSensitiveFields ¶
func WithSensitiveFields(fields ...string) MiddlewareOption
WithSensitiveFields replaces body field redaction keywords. Passing no fields disables body field redaction for this middleware.
func WithSensitiveHeaders ¶
func WithSensitiveHeaders(headers ...string) MiddlewareOption
WithSensitiveHeaders replaces request header filter names. Passing no headers disables header filtering for this middleware.
func WithSkipIPs ¶
func WithSkipIPs(values ...string) MiddlewareOption
WithSkipIPs skips access logging for matched client IPs. Values support exact IPs such as "127.0.0.1" and CIDR ranges such as "10.0.0.0/8".
func WithSkipMethods ¶
func WithSkipMethods(methods ...string) MiddlewareOption
WithSkipMethods skips access logging for matched HTTP methods.
func WithSkipper ¶
func WithSkipper(skipper Skipper) MiddlewareOption