Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

56 Commits

Folders and files

Repository files navigation

go-load-balancer

Go Version License: MIT

Простой и эффективный HTTP load balancer на Go с round-robin балансировкой, автоматическими health checks и гибким rate limiting на основе API ключей.

✨ Возможности

  • 🔄 Round-robin балансировка - равномерное распределение запросов между бэкендами
  • 💓 Health checks - автоматическое отключение недоступных бэкендов
  • 🚦 Rate limiting - гибкое ограничение частоты запросов на основе API ключей
  • 🔌 Graceful shutdown - корректное завершение работы сервера и бэкендов
  • 🎛️ REST API - управление клиентами через HTTP endpoints
  • 📊 Structured logging - детальное логирование с помощью zerolog
  • ⚡ Быстрый и легковесный - минимальные накладные расходы

📋 Требования

  • Go 1.24 или выше

🚀 Установка и запуск

# Клонировать репозиторий
git clone <repo-url>
cd go-load-balancer

# Скачать зависимости
go mod download

# Создать конфигурационный файл
cp app.env.example app.env
# Отредактируйте app.env под ваши нужды

# Запустить
go run cmd/loadbalancer/main.go

⚙️ Конфигурация

Создайте файл app.env в корне проекта (используйте app.env.example как шаблон):

# Адрес для прослушивания
LISTEN_ADDRESS=:8080

# Бэкенд серверы (через запятую)
BACKENDS=localhost:9001,localhost:9002,localhost:9003

# Rate limiting: максимальный размер корзины токенов
RATE_LIMIT_CAPACITY=5

# Rate limiting: скорость пополнения токенов в секунду
RATE_LIMIT_REFILL_RATE=1

Если файл не найден, используются значения по умолчанию. Переменные окружения имеют приоритет над значениями из файла.

📖 Использование

Создание клиента

Сначала создайте клиента для получения API ключа:

curl -X POST http://localhost:8080/clients \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "user1",
    "capacity": 10,
    "rate_per_sec": 2,
    "api_key": "secret-key-123"
  }'

Если не указать api_key, он будет сгенерирован автоматически.

Параметры:

  • client_id - уникальный идентификатор клиента (обязательно)
  • capacity - размер корзины токенов (burst capacity)
  • rate_per_sec - количество токенов добавляемых в секунду
  • api_key - API ключ для аутентификации (опционально)

Отправка запросов

Используйте полученный API ключ в заголовке X-API-Key:

curl http://localhost:8080/ \
  -H "X-API-Key: secret-key-123"

Запрос будет проксирован на один из доступных бэкендов согласно round-robin стратегии.

Управление клиентами

# Получить список всех клиентов
curl http://localhost:8080/clients

# Получить клиента по ID
curl http://localhost:8080/clients/user1

# Обновить клиента
curl -X PUT http://localhost:8080/clients/user1 \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "user1",
    "capacity": 20,
    "rate_per_sec": 5,
    "api_key": "secret-key-123"
  }'

# Удалить клиента
curl -X DELETE http://localhost:8080/clients/user1

🏗️ Структура проекта

.
├── cmd/loadbalancer/     # Точка входа приложения
├── internal/
│   ├── backend/          # Управление бэкенд серверами
│   ├── balancer/         # Стратегии балансировки нагрузки
│   ├── client/           # Управление клиентами и API ключами
│   ├── config/           # Загрузка и валидация конфигурации
│   ├── health/           # Health check механизм
│   └── server/           # HTTP сервер и middleware
├── app.env.example       # Пример конфигурации
├── go.mod                # Go модули
├── go.sum
└── README.md

🧪 Тесты

Запустите тесты:

# Запустить все тесты
go test ./...

# С покрытием кода
go test ./... -cover

# Детальный вывод
go test ./... -v

Проверка кода:

# Статический анализ
go vet ./...

# Форматирование
go fmt ./...

🔧 Как это работает

  1. Load Balancer получает входящий запрос
  2. Rate Limiter проверяет API ключ и лимиты клиента
  3. Balancer выбирает следующий доступный бэкенд (round-robin)
  4. Reverse Proxy перенаправляет запрос на выбранный бэкенд
  5. Health Checker периодически проверяет доступность бэкендов

📝 Лицензия

Этот проект распространяется под лицензией MIT. Подробности в файле LICENSE.

🤝 Вклад

Проект создан в качестве учебного задания. Предложения по улучшению приветствуются!

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages