{"id":13794083,"url":"https://github.com/axiaoxin-com/ratelimiter","last_synced_at":"2025-04-12T13:33:51.245Z","repository":{"id":40286177,"uuid":"262307037","full_name":"axiaoxin-com/ratelimiter","owner":"axiaoxin-com","description":"token bucket ratelimiter for nginx-lua/go/gin-middleware","archived":false,"fork":false,"pushed_at":"2023-07-05T06:14:04.000Z","size":260,"stargazers_count":25,"open_issues_count":1,"forks_count":8,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-30T01:01:46.200Z","etag":null,"topics":["gin-middleware","go","lua","ratelimiter"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/axiaoxin-com.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-05-08T11:35:26.000Z","updated_at":"2024-12-27T07:47:08.000Z","dependencies_parsed_at":"2024-01-13T10:13:47.321Z","dependency_job_id":"dc0268c5-58cc-4ee8-868a-78c08a6318f4","html_url":"https://github.com/axiaoxin-com/ratelimiter","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axiaoxin-com%2Fratelimiter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axiaoxin-com%2Fratelimiter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axiaoxin-com%2Fratelimiter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axiaoxin-com%2Fratelimiter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/axiaoxin-com","download_url":"https://codeload.github.com/axiaoxin-com/ratelimiter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248573649,"owners_count":21126876,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gin-middleware","go","lua","ratelimiter"],"created_at":"2024-08-03T23:00:35.574Z","updated_at":"2025-04-12T13:33:46.236Z","avatar_url":"https://github.com/axiaoxin-com.png","language":"Lua","readme":"# ratelimiter\n\n[![Build Status](https://travis-ci.org/axiaoxin-com/ratelimiter.svg?branch=master)](https://travis-ci.org/axiaoxin-com/ratelimiter)\n[![go report card](https://goreportcard.com/badge/github.com/axiaoxin-com/ratelimiter)](https://goreportcard.com/report/github.com/axiaoxin-com/ratelimiter)\n\n[中文 README](./README_CN.md)\n\nSimple version implementation of token bucket request frequency limiting.\n\nratelimiter library that supports in-memory and distributed eventually consistent redis stores (includes Gin middleware)\n\n- [lua-ngx-ratelimiter](./lua-ngx-ratelimiter): a token bucket frequency limiting implementation of lua + nginx + redis\n- [MemRatelimiter](./mem_ratelimiter.go): a process memory limiter implemented with [rate](https://github.com/golang/time/tree/master/rate) + [go-cache](https://github.com/patrickmn/go-cache)\n- [RedisRatelimiter](./redis_ratelimiter.go): a distributed limiter implemented with redis + lua\n- [GinMemRatelimiter](./gin_mem_ratelimiter.go): encapsulating the MemRatelimiter as a gin middleware\n- [GinRedisRatelimiter](./gin_redis_ratelimiter.go): encapsulating the RedisRatelimiter as a gin middleware\n\n## Go PKG Installation\n\n```\ngo get -u github.com/axiaoxin-com/ratelimiter\n```\n\n## Gin Middleware Example\n\n**[GinMemRatelimiter](./example/gin_mem_ratelimiter.go)**\n\n```\npackage main\n\nimport (\n\t\"time\"\n\n\t\"github.com/axiaoxin-com/ratelimiter\"\n\t\"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n\tr := gin.New()\n\t// Put a token into the token bucket every 1s\n\t// Maximum 1 request allowed per second\n\tr.Use(ratelimiter.GinMemRatelimiter(ratelimiter.GinRatelimiterConfig{\n\t\t// config: how to generate a limit key\n\t\tLimitKey: func(c *gin.Context) string {\n\t\t\treturn c.ClientIP()\n\t\t},\n\t\t// config: how to respond when limiting\n\t\tLimitedHandler: func(c *gin.Context) {\n\t\t\tc.JSON(200, \"too many requests!!!\")\n\t\t\tc.Abort()\n\t\t\treturn\n\t\t},\n\t\t// config: return ratelimiter token fill interval and bucket size\n\t\tTokenBucketConfig: func(*gin.Context) (time.Duration, int) {\n\t\t\treturn time.Second * 1, 1\n\t\t},\n\t}))\n\tr.GET(\"/\", func(c *gin.Context) {\n\t\tc.JSON(200, \"hi\")\n\t})\n\tr.Run()\n}\n```\n\n**[GinRedisRatelimiter](./example/gin_redis_ratelimiter.go)**\n\n```\npackage main\n\nimport (\n\t\"time\"\n\n\t\"github.com/axiaoxin-com/goutils\"\n\t\"github.com/axiaoxin-com/ratelimiter\"\n\t\"github.com/gin-gonic/gin\"\n\t\"github.com/go-redis/redis/v8\"\n)\n\nfunc main() {\n\tr := gin.New()\n\t// Put a token into the token bucket every 1s\n\t// Maximum 1 request allowed per second\n\trdb, err := goutils.NewRedisClient(\u0026redis.Options{})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tr.Use(ratelimiter.GinRedisRatelimiter(rdb, ratelimiter.GinRatelimiterConfig{\n\t\t// config: how to generate a limit key\n\t\tLimitKey: func(c *gin.Context) string {\n\t\t\treturn c.ClientIP()\n\t\t},\n\t\t// config: how to respond when limiting\n\t\tLimitedHandler: func(c *gin.Context) {\n\t\t\tc.JSON(200, \"too many requests!!!\")\n\t\t\tc.Abort()\n\t\t\treturn\n\t\t},\n\t\t// config: return ratelimiter token fill interval and bucket size\n\t\tTokenBucketConfig: func(*gin.Context) (time.Duration, int) {\n\t\t\treturn time.Second * 1, 1\n\t\t},\n\t}))\n\tr.GET(\"/\", func(c *gin.Context) {\n\t\tc.JSON(200, \"hi\")\n\t})\n\tr.Run()\n}\n```\n\n## Ratelimiter can be directly used in golang program. Examples:\n\n**[MemRatelimiter](./example/mem_ratelimiter.go)**\n\n```\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/axiaoxin-com/ratelimiter\"\n)\n\nfunc main() {\n\tlimiter := ratelimiter.NewMemRatelimiter()\n\tlimitKey := \"uniq_limit_key\"\n\ttokenFillInterval := time.Second * 1\n\tbucketSize := 1\n\tfor i := 0; i \u003c 3; i++ {\n\t\t// 1st and 3nd is allowed\n\t\tif i == 2 {\n\t\t\ttime.Sleep(time.Second * 1)\n\t\t}\n\t\tisAllow := limiter.Allow(context.TODO(), limitKey, tokenFillInterval, bucketSize)\n\t\tfmt.Println(i, time.Now(), isAllow)\n\t}\n}\n```\n\n**[RedisRatelimiter](./example/redis_ratelimiter.go)**\n\n```\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/axiaoxin-com/goutils\"\n\t\"github.com/axiaoxin-com/ratelimiter\"\n\t\"github.com/go-redis/redis/v8\"\n)\n\nfunc main() {\n\trdb, err := goutils.NewRedisClient(\u0026redis.Options{})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tlimiter := ratelimiter.NewRedisRatelimiter(rdb)\n\tlimitKey := \"uniq_limit_key\"\n\ttokenFillInterval := time.Second * 1\n\tbucketSize := 1\n\tfor i := 0; i \u003c 3; i++ {\n\t\t// 1st and 3nd is allowed\n\t\tif i == 2 {\n\t\t\ttime.Sleep(time.Second * 1)\n\t\t}\n\t\tisAllow := limiter.Allow(context.TODO(), limitKey, tokenFillInterval, bucketSize)\n\t\tfmt.Println(i, time.Now(), isAllow)\n\t}\n}\n```\n","funding_links":[],"categories":["Lua","Middlewares"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxiaoxin-com%2Fratelimiter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faxiaoxin-com%2Fratelimiter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxiaoxin-com%2Fratelimiter/lists"}