Skip to content

Latest commit

 

History

History
135 lines (93 loc) · 4.85 KB

README.md

File metadata and controls

135 lines (93 loc) · 4.85 KB
Raw

Go Rate Limiter

This project, implementing rate limit functionality using Golang, PostgreSQL, Redis, Prometheus Docker, Kubernetes, and Chi framework with gRPC and HTTP endpoints.

Also, as a go learner, project architecture was initiated with inspiration from and based on the https://github.com/gmhafiz/go8 project. Thanks to this good starter pack.

I kept the Authentication layer so that I could save some configuration files in the future. But it wasn't necessary here. An extra module.

Getting Started

Follow these steps to get the project up and running in your local environment.

TODOs

  • Improve logging mechanisms / Add opentelemetry
  • Add rate limit unit/functional tests

Prerequisites

  • Golang
  • PostgreSQL
  • Redis
  • (Optional-Recommended) Docker
  • (Optional) Kubernetes/Minikube

Installation

  1. Navigate to the project directory:

     git clone https://github.com/isikhi/go-rate-limiter.git
 cd ./go-rate-limiter

  2. Configuration(Environment)

     cp ./env.example .env

  3. Install dependencies:

    go mod download

  4. (Optionally) If you run task check command for it will check general things like schemas, test, lint, swagger etc.(take a look: Taskfile.yml)

  5. Run Migrations and Seed DB

    go run cmd/migrate/main.go
go run cmd/seed/main.go

  6. Run App

    go run cmd/app/main.go

Install & Run with docker(compose)

  1. Clone the repository:

    git clone https://github.com/isikhi/go-rate-limiter.git
cd ./go-rate-limiter

  2. Configuration(Environment)

     cp ./env.example .env

  3. Docker Compose up!

    docker compose -f docker-compose.yml up --build

Install & Run with kubernetes(minikube)

  1. Push to repository to docker hub or use mine.

    • App: isikhi/go-rate-limiter:app-0.1.0
    • Migrator: isikhi/go-rate-limiter:migrate-0.1.0
    • Seeder: isikhi/go-rate-limiter:seed-0.1.0

    If you want to build your image follow this steps

    docker build -t your_username/your_repository:app-0.1.0 --build-arg MAIN_GO_FILE_PATH=./cmd/app/main.go .
docker push your_username/your_repository:app-0.1.0

docker build -t your_username/your_repository:migrator-0.1.0 --build-arg MAIN_GO_FILE_PATH=./cmd/migrate/main.go .
docker push your_username/your_repository:migrator-0.1.0

docker build -t your_username/your_repository:seeder-0.1.0 --build-arg MAIN_GO_FILE_PATH=./cmd/seed/main.go .
docker push your_username/your_repository:seeder-0.1.0

    Then change k8s yaml's inside image tags.

  2. Run: This script will reload everything with kubectl. kubectl alias should have been set

    /bin/bash /{main_directory/path}/go-rate-limiter/k8s/deploy.sh

    PS: In database deployments, I added a sleep time of approximately 30 seconds to wait until the containers stand up, so that there will be no problems until the containers that do not have health checks stand up.

How it works ? Test and Example Usage

If you deploy to the minikube minikube service list take url's and use as base domain on below instructions

  1. Define Rate Limit Options Define rate limit options by referring to the example in POST Rate Limit Example Http. You can find an HTTP request example that creates a client, token, and duration(in seconds).

  2. Define Rate Limit Options Use the RPC client found in Rate Limit Example RPC Client to make a request and determine whether rate limiting is applied or not.

  3. Monitor Prometheus Metrics Retrieve Prometheus metrics from the endpoint http://{{BASE_URL}}/metric.

  4. Update/Throttle Limits by Client Load You can change your rate limit options by patch endpoint in Rate Limit Example Http. This will update latest rate limit options that provided.

How throttling work?

For example, the client has a limit of 100 tokens. However, the client's load is high and it notified us through the patch endpoint. If the load is 40%, and it sends throttle_percentage as 40, the latest rate limit option of the relevant client will be restricted by 40% in the background. If this value is not sent during the patch request, the default will be updated to 0. For each new rate limit options, the default value is 0 and then a restriction must be made regarding the patch request. It takes values between 0-100.

Tasks - Taskfile (Lint, test, ent generators and etc.)

Many generators, test runners, and installers in this repo are included in the Taskfile. The end user will not use these, but those who want to develop the repo can look at Taskfile.yml.

Project Statement and Basic Architectural drawings

Project Statements