Documentation
¶
Overview ¶
Package resource defines the abstractions nexus uses to know about databases, caches, message queues, and other external dependencies so they show up in the dashboard's Architecture view with health status.
nexus does not ship concrete DB/cache implementations — users keep their own (GORM+failsafe, Redis/go-cache hybrid, etc.) and register them as Resources in one line:
app.Register(resource.NewDatabase("main", "Primary PG", nil, dbm.IsConnected, resource.AsDefault()))
app.Register(resource.NewCache("session", "Redis hybrid", nil, cache.IsRedisConnected, resource.AsDefault()))
Services then reference resources by name, not by instance:
app.Service("adverts").Using("").MountGraphQL(...) // default DB
app.Service("qb").Using("questions", "session").MountGraphQL(...) // explicit
app.Service("uaa").UsingDefaults().MountGraphQL(...) // default of every kind
Index ¶
- type DependsOnResource
- type Kind
- type Option
- type Resource
- func NewCache(name, desc string, details map[string]any, healthy func() bool, opts ...Option) Resource
- func NewDatabase(name, desc string, details map[string]any, healthy func() bool, opts ...Option) Resource
- func NewQueue(name, desc string, details map[string]any, healthy func() bool, opts ...Option) Resource
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DependsOnResource ¶ added in v0.27.0
type DependsOnResource interface {
DependsOn() []string
}
DependsOnResource is the optional contract a Resource implements when it has hard dependencies on other resources. The dashboard reads it via type assertion and draws an edge from this resource to each named target. Cycles are an authoring bug; the dashboard renders them as-is and the layout engine handles the visual mess.
type Option ¶
type Option func(*simple)
Option tweaks a resource at construction time.
func AsDefault ¶
func AsDefault() Option
AsDefault marks a resource as the default for its Kind. When a Service calls .Using("") (database) or .UsingDefaults() (all kinds), nexus picks the one flagged AsDefault. If none is flagged, the lexically-first resource of the kind wins.
func DependsOn ¶ added in v0.27.0
DependsOn declares this resource's hard dependencies on OTHER resources by name — the dashboard renders an edge from this resource to each. Typical pairings: a cache fronting a database, a queue whose consumers persist into Postgres, an object store whose CDN cache invalidates on writes.
Names must match the Name() of an already-registered resource; unknown names render as dangling edges (also surfaced as a console warning so authoring bugs are obvious).
Multiple DependsOn calls accumulate — each appends rather than replaces — so a builder can layer deps from different sources.
func WithDetails ¶
WithDetails replaces the static details map with a function called on every dashboard snapshot. Use for live-varying metadata — the canonical case is a cache reporting "redis" vs "memory" as its backend flips on Redis outage.
type Resource ¶
type Resource interface {
Name() string // unique identifier, e.g. "main-db"
Kind() Kind // database / cache / queue / other
Describe() string // short human description
Healthy() bool // called each time the registry snapshots
Details() map[string]any // free-form (engine, host, version); shown in UI
IsDefault() bool // registry's DefaultOfKind picks this first
}
Resource is anything whose health the dashboard should surface.
Implementations may optionally satisfy DependsOnResource (declared in this same package) so the dashboard renders a resource→resource edge — e.g. a cache that falls back to a database, a queue whose consumers persist into Postgres. Implementations that don't declare deps simply omit the method; the registry's snapshot detects DependsOnResource via type assertion.
Source Files