api

package

v0.0.0-...-511e509 Latest Latest Go to latest Published: Apr 11, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/caesium-cloud/caesium

Links

Open Source Insights

Documentation ¶

Index ¶

func Health(c *echo.Context) error
func RegisterUI(e *echo.Echo)
func Shutdown() error
func Start(ctx context.Context, bus event.Bus, authSvc *auth.Service, ...) error
type CheckResult
type HealthChecks
type HealthResponse
type Status

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Health ¶

func Health(c *echo.Context) error

Health is used to determine if Caesium is healthy.

func RegisterUI ¶

func RegisterUI(e *echo.Echo)

func Shutdown ¶

func Shutdown() error

func Start ¶

func Start(ctx context.Context, bus event.Bus, authSvc *auth.Service, auditor *auth.AuditLogger, limiter *auth.RateLimiter) error

Start launches Caesium's API.

Types ¶

type CheckResult ¶

type CheckResult struct {
	Status    Status `json:"status,omitempty"`
	LatencyMs int64  `json:"latency_ms,omitempty"`
	Count     int64  `json:"count,omitempty"`
}

CheckResult describes the outcome of an individual health check.

type HealthChecks ¶

type HealthChecks struct {
	Database   *CheckResult `json:"database"`
	ActiveRuns *CheckResult `json:"active_runs"`
	Triggers   *CheckResult `json:"triggers"`
}

HealthChecks holds all dependency check results.

type HealthResponse ¶

type HealthResponse struct {
	Status Status        `json:"status"`
	Uptime time.Duration `json:"uptime"`
	Checks *HealthChecks `json:"checks,omitempty"`
}

HealthResponse defines the data the Health REST endpoint returns.

type Status ¶

type Status string

Status enumerates the health statuses of Caesium.

const (
	Healthy  Status = "healthy"
	Degraded Status = "degraded"
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
gql
schema
middleware
rest
bind
controller/atom
controller/auth
controller/backfill
controller/database
controller/event
controller/job
controller/job/cache
controller/job/run
controller/jobdef
controller/logs
controller/node
controller/stats
controller/trigger
controller/webhook
service/atom
service/database
service/job
service/run
service/stats
service/task
service/taskedge
service/trigger
service/worker

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