Interface Module

internal/module/module.go:14–43

Module is the interface every event module must implement. Embed BaseModule to get no-op defaults for optional methods.

// Module is the interface every event module must implement.
// Embed BaseModule to get no-op defaults for optional methods.
type Module interface {
	// Name returns a human-readable module name (e.g., "Sentry").
	Name() string

	// Type returns the event type string stored in the events table.
	Type() string

	// RegisterRoutes adds module-specific API routes to the router.
	RegisterRoutes(mux *http.ServeMux, store event.Store)

	// HTTPHandler returns a handler that inspects an incoming request
	// and either claims it or returns nil. Return nil if this module
	// has no HTTP ingestion (e.g., TCP-only modules).
	HTTPHandler() HTTPIngestionHandler

	// TCPServers returns TCP server configurations this module needs.
	TCPServers() []tcp.ServerConfig

	// PreviewMapper returns the mapper for converting payloads to previews.
	PreviewMapper() event.PreviewMapper

	// RegisterMigrations registers module-specific SQL migration files.
	RegisterMigrations(migrator *storage.Migrator) error

	// OnInit is called once at startup after migrations are applied.
	OnInit(db *sql.DB) error

	// OnEventStored is called after any event is persisted.
	OnEventStored(ev event.Event)
}

// HTTPIngestionHandler decides if an HTTP request belongs to a module.
type HTTPIngestionHandler interface {