dashboard

Documentation

Overview

Package dashboard embeds the kyu web UI and serves it next to a JSON API backed by a live kyu.Queue. Live updates are pushed to the browser over Server-Sent Events (GET /api/stream).

Typical usage:

q := kyu.New(kyu.Config{...})
// register handlers, q.Connect(ctx), then q.Start(ctx) in a goroutine
srv := &http.Server{Addr: ":8080", Handler: dashboard.Handler(q)}
srv.ListenAndServe()

Index

• Variables
• func Handler(q *kyu.Queue) http.Handler

Variables

var Version = "dev"

Version is the kyu version rendered in the dashboard footer. It defaults to "dev" and is set either programmatically by the embedding program or at build time via -ldflags "-X github.com/codetesla51/kyu/dashboard.Version=v1.0.0".

Functions

func Handler

func Handler(q *kyu.Queue) http.Handler

Handler builds an http.Handler that serves the embedded dashboard UI and its JSON API for the given queue.