hedzr / rate

rate limit library in golang

go-rate

go-rate provides the rate limiters generally.

Features

History

• v0.5.0

  • BREAK: To decrease unecessary dependants, we removed middleware subpackage. It has been moved into supports/ and taged with ignore.
    • You must copy its codes to use it.
  • the codes reviewed
  • no any third-party deps now, even from mine.

• v0.1.x

  • as is

Usages

Simple

package main

import (
	"fmt"
	"github.com/hedzr/rate"
	"time"
)

func main() {
	l := rate.New(rate.LeakyBucket, 100, time.Second)
	for i := 0; i < 120; i++ {
		ok := l.Take(1)
		if !ok {
			fmt.Printf("#%d Take() returns not ok, counter: %v\n", i, rate.CountOf(l))
			time.Sleep(50 * time.Millisecond)
		}
	}
}

As a gin middleware

package main

import (
   "github.com/gin-gonic/gin"
   "github.com/hedzr/rate"
   "github.com/hedzr/rate/middleware"
   "time"
)

func webserver() {
	r := engine()
	r.Run(":3000")
}

func engine() *gin.Engine {
	config := &middleware.Config{
		Name:          "...",
		Description:   "...",
		Algorithm:     string(rate.TokenBucket),
		Interval:      time.Second,
		MaxRequests:   1000,
		HeaderKeyName: "X-API-TOKEN",
		ExceptionKeys: nil,
		Routes:        nil,
	}
	r := gin.Default()
	r.Use(middleware.ForGin(config))
	return r
}

Load limit config with cmdr Option Store

While integrated with hedzr/cmdr, the short loading is available:

import "github.com/hedzr/rate/middleware"

func BuildRoutes(rg *gin.Engine) *gin.Engine {
    buildRoutes(rg.Group("/prefix"), rg)
}
func buildRoutes(rg Router, root *gin.Engine) {
    middleware.LoadConfigForGin("server.rate-limits", rg)
    rg.Get("/echo/*action", echoHandler)
}
func echoGinHandler(c *gin.Context) {
    action := c.Param("action")
    if action == "" || action == "/" {
        action = "<no action>"
    }
    _, _ = io.WriteString(c.Writer, fmt.Sprintf("action: %v\n", action))
}

A config file (eg. rate-limit.yml) should be put in cmdr-standard conf.d directory, so it can be loaded automatically:

app:
  your-app: # <- replace it with your app name, the further KB in cmdr docs.
    server:
      rate-limits:
        - name: by-api-key
          interval: 1ms
          max-requests: 30
          header-key-name: X-API-KEY
          exception-keys: [voxr-apps-test-api-key-fndsfjn]

License

MIT