workerplugin

README

Worker Plugin Template

This package provides a starting point for plugins that expose load-balanced workers. Copy the directory and implement your own logic:

1. Update ID() with a unique identifier.
2. Register any HTTP routes and WebSocket endpoints in RegisterRoutes.
3. Add Prometheus collectors via RegisterMetrics.
4. Publish state elements in RegisterState.
5. Provide a scheduler that dispatches tasks in Scheduler.

The server will automatically detect the WorkerProvider capability when the plugin is loaded.

Documentation

Index

• type Plugin
  • func New() *Plugin
  • func (p *Plugin) ID() string
  • func (p *Plugin) RegisterMetrics(reg spi.MetricsRegistry)
  • func (p *Plugin) RegisterRoutes(r spi.Router)
  • func (p *Plugin) RegisterState(reg spi.StateRegistry)
  • func (p *Plugin) Scheduler() spi.Scheduler

Types

type Plugin

type Plugin struct{}

Plugin is a minimal example implementing plugin.Plugin and plugin.WorkerProvider.

func New

func New() *Plugin

New returns a new instance of the plugin.

func (*Plugin) ID

func (p *Plugin) ID() string

ID returns the plugin identifier.

func (*Plugin) RegisterMetrics

func (p *Plugin) RegisterMetrics(reg spi.MetricsRegistry)

RegisterMetrics adds Prometheus collectors.

func (*Plugin) RegisterRoutes

func (p *Plugin) RegisterRoutes(r spi.Router)

RegisterRoutes installs HTTP routes served by this plugin.

func (*Plugin) RegisterState

func (p *Plugin) RegisterState(reg spi.StateRegistry)

RegisterState exposes values under /state.

func (*Plugin) Scheduler

func (p *Plugin) Scheduler() spi.Scheduler

Scheduler returns the dispatch scheduler for this plugin.