middleware

Documentation

Index

• func DetectUserAgentLanguage() gin.HandlerFunc
• func LogTrace() gin.HandlerFunc
• func PrintRequestPayload() gin.HandlerFunc
• func PrometheusExporter() gin.HandlerFunc
• func RateLimiter(limiter *Limiter) gin.HandlerFunc
• func SetDiskPath(path string)
• func SetSampleInterval(interval string)
• func SystemMetricsSample()
• func WithCors(headers map[string]string) gin.HandlerFunc
• func WithCorsOnlyOptions(headers map[string]string) gin.HandlerFunc
• type Limiter
  • func NewLimiter(reqs int, window time.Duration) *Limiter
  • func (l *Limiter) Allow(ip string) (bool, int, time.Time)

Functions

func DetectUserAgentLanguage

func DetectUserAgentLanguage() gin.HandlerFunc

DetectUserAgentLanguage 检测客户端语言

通过解析请求头中的`Accept-Language`字段得到

默认为`en`

func LogTrace

func LogTrace() gin.HandlerFunc

LogTrace 日志追踪

作用是在请求入口注入必要的内容到上下文，供后续的请求调用链使用，一般用于日志追踪、链路追踪

注入内容：

1.请求id

2.请求到来那一刻的纳秒时间戳

3.包装了请求id的日志组件实例

Example:

requestId, ok := ginContext.Get("requestId").(string)

spanId, ok := ginContext.Get("spanId").(string)

entryAt, ok := ginContext.Get("entryAt").(int64)

logger, ok := ginContext.Get("logger").(*zap.Logger)

func PrintRequestPayload

func PrintRequestPayload() gin.HandlerFunc

PrintRequestPayload 打印请求载荷

func PrometheusExporter

func PrometheusExporter() gin.HandlerFunc

PrometheusExporter 导出Prometheus指标

func RateLimiter

func RateLimiter(limiter *Limiter) gin.HandlerFunc

RateLimiter 是一个限流器中间件，用于对HTTP请求进行IP限流，并添加X-Rate-Limit相关的响应头

func SetDiskPath

func SetDiskPath(path string)

SetDiskPath 设置磁盘监控路径

func SetSampleInterval

func SetSampleInterval(interval string)

SetSampleInterval 设置采样间隔(频率)

func SystemMetricsSample

func SystemMetricsSample()

SystemMetricsSample 系统指标采样

采样周期为每分钟一次，覆盖上一次记录值

采集对象：

- cpu，多核 -> 使用率

- 内存 -> 使用数值和使用率

- 硬盘使用率，根路径 -> 使用数值和使用率

- 硬盘io，遍历设备 -> 读写次数、字节数、时间

- 网卡，多网卡 -> 出入站数值

func WithCors

func WithCors(headers map[string]string) gin.HandlerFunc

WithCors 允许浏览器跨域请求

func WithCorsOnlyOptions

func WithCorsOnlyOptions(headers map[string]string) gin.HandlerFunc

WithCorsOnlyOptions 允许浏览器跨域请求

仅对options探测请求注入放行headers

Types

type Limiter

type Limiter struct {
	// contains filtered or unexported fields
}

Limiter 是一个基于滑动时间窗口和IP限制的限流器

func NewLimiter

func NewLimiter(reqs int, window time.Duration) *Limiter

NewLimiter 返回一个新的基于滑动时间窗口和IP限制的Limiter实例

func (*Limiter) Allow

func (l *Limiter) Allow(ip string) (bool, int, time.Time)

Allow 方法返回指定IP的请求是否被允许，同时返回剩余的请求数和窗口重置时间