reststats

Documentation

Index

• Variables
• func RegisterGetDatabaseStatsHandler(n *Namespace) error
• func RegisterGlobalStatusHandler(n *Namespace) error
• type GlobalStatus
• type Namespace
  • func NewNamespace(server *rest.Server, db db.Adapter, pool *clients.ClientPool, nats *nats.Conn, ...) *Namespace
  • func (s *Namespace) GetName() rest.ServiceName
  • func (s *Namespace) RegisterHandlers() error

Variables

var StatsServiceName rest.ServiceName = "stats"

StatsServiceName defines the service name for the Stats service.

Functions

func RegisterGetDatabaseStatsHandler

func RegisterGetDatabaseStatsHandler(n *Namespace) error

RegisterGetDatabaseStatsHandler registers the endpoint to retrieve database statistics

func RegisterGlobalStatusHandler

func RegisterGlobalStatusHandler(n *Namespace) error

RegisterGlobalStatusHandler registers the endpoint to retrieve global service statuses

Types

type GlobalStatus

type GlobalStatus struct {
	Status bool `json:"status" doc:"Global service status"`
}

type Namespace

type Namespace struct {
	*rest.Server
	// contains filtered or unexported fields
}

Namespace represents a service namespace containing configuration and dependencies for the Stats service.

func NewNamespace

func NewNamespace(server *rest.Server, db db.Adapter, pool *clients.ClientPool, nats *nats.Conn, cache *cache.Redis) *Namespace

NewNamespace creates a new instance of Namespace with the provided server, database adapter, client pool, NATS connection, and Redis cache.

func (*Namespace) GetName

func (s *Namespace) GetName() rest.ServiceName

GetName returns the service name for the Stats namespace.

func (*Namespace) RegisterHandlers

func (s *Namespace) RegisterHandlers() error

RegisterHandlers registers all the necessary handlers for the Stats namespace.