cluster

package module
v1.0.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 23, 2026 License: MIT Imports: 9 Imported by: 0

README

Compogo Cluster

Go Reference

Встроенный, легковесный механизм кластеризации для фреймворка Compogo.

Предоставляет:

  • Обнаружение узлов (Discovery)
  • Выбор лидера (Leader Election) на основе алгоритма, похожего на Raft
  • Синхронизацию состояния между узлами
  • Сборщик мёртвых узлов (Reaper)
  • Учёт нагрузки узлов при выборе лидера (Resource-aware)

Установка

go get github.com/Compogo/cluster

Быстрый старт

package main

import (
    "github.com/Compogo/cluster"
    "github.com/Compogo/compogo"
)

func main() {
    app := compogo.NewApp("myapp",
        compogo.WithComponents(&cluster.Component),
    )

    if err := app.Serve(); err != nil {
        panic(err)
    }
}

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

Discovery (Обнаружение узлов)
# Список хостов для обнаружения
--cluster.discovery.hosts=10.0.0.1:9090,10.0.0.2:9090,10.0.0.3:9090
Election (Выборы лидера)
# Таймаут синхронизации term
--cluster.delay.election.age=5s

# Таймаут голосования
--cluster.delay.election.vote=30s
Reaper (Сборщик мёртвых узлов)
# Время ожидания перед удалением
--cluster.delay.reaper.wait=5m

# Интервал проверки
--cluster.delay.reaper=1s
Sync (Синхронизация хостов)
# Интервал синхронизации
--cluster.delay.sync.host=30s
Manager (Менеджер кластера)
# Интервал переподключения
--cluster.delay.reconnect=10s

# Интервал синхронизации состояния
--cluster.delay.sync.state=5s

# ID реплики (генерируется автоматически)
--cluster.replica.id=

# Имя реплики
--cluster.replica.name=

# Хост реплики
--cluster.replica.host=

# Доступные роли
--cluster.replica.roles=Master,Slave

# Вес реплики для выборов
--cluster.replica.score=1.0
GRPC (Настройки межрепликового общения)
# Разрешать keepalive без стримов
--cluster.client.grpc.permit_without_stream=true

# Интервал keepalive пингов
--cluster.client.grpc.keepalive.time=10s

# Таймаут keepalive
--cluster.client.grpc.keepalive.timeout=20s

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

Получение менеджера кластера
var m cluster.Manager
container.Invoke(func(manager cluster.Manager) { m = manager })

// Получение текущего мастера
master := m.Master()

// Получение текущей реплики
me := m.Me()
Подписка на события
// Смена мастера
m.OnChangeMaster().Subscribe(func(ctx context.Context, replica cluster.Replica) {
    log.Printf("Master changed: %s", replica.GetHost())
})

// Добавление новой реплики
m.OnAddPeer().Subscribe(func(ctx context.Context, peer cluster.Peer) {
    log.Printf("Peer added: %s", peer.GetHost())
})

// Удаление реплики
m.OnDeletingPeer().Subscribe(func(ctx context.Context, peer cluster.Peer) {
    log.Printf("Peer deleted: %s", peer.GetHost())
})

// Кластер готов
m.OnClusterReady().Subscribe(func(ctx context.Context, replicas set.Set[cluster.Replica]) {
    log.Printf("Cluster ready: %d replicas", replicas.Len())
})

// Кластер болен
m.OnClusterSick().Subscribe(func(ctx context.Context, replicas set.Set[cluster.Replica]) {
    log.Printf("Cluster sick: %d replicas", replicas.Len())
})
Фильтрация реплик
// Все Ready-реплики
readyReplicas := m.Filter(cluster.StatusFilter(domain.Ready))

// Реплики с ролью Master
masters := m.Filter(cluster.RoleFilter(domain.Master))

// Реплики без роли Master
slaves := m.Filter(cluster.NotRoleFilter(domain.Master))

// Реплики, которые могут стать Master
candidates := m.Filter(cluster.AvailableRoleFilter(domain.Master))
Управление ролями
me := m.Me()

// Добавить роль
me.AddRole(domain.Master)

// Удалить роль
me.RemoveRole(domain.Master)

// Проверить наличие роли
if me.GetRoles().Contains(domain.Master) {
    log.Println("I am the master!")
}
Управление весом (Score)
me.SetScore(1.5) // увеличиваем вес для выборов

Пример кластера из трёх узлов

Узел 1
./app --cluster.replica.host=10.0.0.1:9090 \
      --cluster.discovery.hosts=10.0.0.1:9090,10.0.0.2:9090,10.0.0.3:9090
Узел 2
./app --cluster.replica.host=10.0.0.2:9090 \
      --cluster.discovery.hosts=10.0.0.1:9090,10.0.0.2:9090,10.0.0.3:9090
Узел 3
./app --cluster.replica.host=10.0.0.3:9090 \
      --cluster.discovery.hosts=10.0.0.1:9090,10.0.0.2:9090,10.0.0.3:9090

Ограничения

  • Рассчитан на кластеры до 20 реплик
  • Не использует persistent storage (состояние хранится в памяти)
  • Не поддерживает кросс-датацентровую репликацию

Зависимости

Лицензия

MIT License

Copyright (c) 2026 Compogo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Overview

Package cluster реализует встроенный легковесный механизм кластеризации, основанный на обмене сообщениями через gRPC. Предназначен для создания отказоустойчивых групп из 3-20 экземпляров приложения.

Основные функции:

  • Выбор лидера (Master) на основе "возраста" (term) и голосования;
  • Обнаружение новых узлов (Discovery);
  • Синхронизация списка активных хостов (Sync);
  • Автоматическое удаление "мёртвых" узлов (Reaper).

Index

Constants

This section is empty.

Variables

Component — главный компонент кластера для Compogo. Включает в себя все подкомпоненты (менеджер, выборы, синхронизацию, reaper, grpc-интерфейсы).

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
application
discovery
Package discovery отвечает за начальное обнаружение узлов кластера.
Package discovery отвечает за начальное обнаружение узлов кластера.
election
Package election реализует алгоритм выборов лидера.
Package election реализует алгоритм выборов лидера.
manager
Package manager содержит ядро управления кластером: менеджер (Manager), текущую реплику (Me) и удалённую (Peer).
Package manager содержит ядро управления кластером: менеджер (Manager), текущую реплику (Me) и удалённую (Peer).
reaper
Package reaper реализует сборщик "мёртвых" реплик.
Package reaper реализует сборщик "мёртвых" реплик.
sync
Package sync отвечает за синхронизацию списка активных хостов между репликами.
Package sync отвечает за синхронизацию списка активных хостов между репликами.
infrastructure
interface
grpc/election
Package election предоставляет gRPC-сервис для выборов лидера.
Package election предоставляет gRPC-сервис для выборов лидера.
grpc/manager
Package manager предоставляет gRPC-сервис для обмена состоянием между репликами.
Package manager предоставляет gRPC-сервис для обмена состоянием между репликами.
grpc/sync
Package sync предоставляет gRPC-сервис для синхронизации хостов.
Package sync предоставляет gRPC-сервис для синхронизации хостов.
protobuf
model/helper
Package helper содержит вспомогательные функции для преобразования типов между domain и protobuf моделями.
Package helper содержит вспомогательные функции для преобразования типов между domain и protobuf моделями.
Package sdk предоставляет клиентские обёртки для вызова gRPC-методов других реплик.
Package sdk предоставляет клиентские обёртки для вызова gRPC-методов других реплик.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL