humus

README

humus

humus one stop shop framework for all Z5Labs projects in Go.

Documentation

Overview

Package humus provides a base config and abstraction for running apps.

Index

• Variables
• func DefaultConfig() bedrockcfg.Source
• func Logger(name string) *slog.Logger
• type Config
  • func (cfg Config) InitializeOTel(ctx context.Context) error
• type ErrorHandler
• type ErrorHandlerFunc
  • func (f ErrorHandlerFunc) HandleError(err error)
• type Runner
  • func NewRunner[T any](builder bedrock.AppBuilder[T], opts ...RunnerOption) Runner[T]
  • func (r Runner[T]) Run(ctx context.Context, cfg T)
• type RunnerOption
  • func OnError(eh ErrorHandler) RunnerOption
• type RunnerOptions

Variables

var ErrOTLPMustBeEnabled = errors.New("missing otlp client conn")

Functions

func DefaultConfig

func DefaultConfig() bedrockcfg.Source

DefaultConfig

func Logger

func Logger(name string) *slog.Logger

Logger

Types

type Config

type Config struct {
	OTel config.OTel `config:"otel"`
}

Config

func (Config) InitializeOTel

func (cfg Config) InitializeOTel(ctx context.Context) error

InitializeOTel implements the [appbuilder.OTelInitializer] interface.

type ErrorHandler

type ErrorHandler interface {
	HandleError(error)
}

ErrorHandler allows custom error handling logic to be defined for when the Runner encounters an error while building or running a bedrock.App.

type ErrorHandlerFunc

type ErrorHandlerFunc func(error)

ErrorHandlerFunc is a func type of the ErrorHandler interface.

func (ErrorHandlerFunc) HandleError

func (f ErrorHandlerFunc) HandleError(err error)

HandleError implements the ErrorHandler inteface.

type Runner

type Runner[T any] struct {
	// contains filtered or unexported fields
}

Runner orchestrates the building of a bedrock.App and running it.

func NewRunner

func NewRunner[T any](builder bedrock.AppBuilder[T], opts ...RunnerOption) Runner[T]

NewRunner initializes a Runner.

func (Runner[T]) Run

func (r Runner[T]) Run(ctx context.Context, cfg T)

Run builds a bedrock.App, runs it, and handles any error returned from either of those steps.

type RunnerOption

type RunnerOption interface {
	ApplyRunnerOption(*RunnerOptions)
}

RunnerOption sets a value on RunnerOptions.

func OnError

func OnError(eh ErrorHandler) RunnerOption

OnError registers the given ErrorHandler with the Runner.

type RunnerOptions

type RunnerOptions struct {
	// contains filtered or unexported fields
}

RunnerOptions are configurable parameters of a Runner.