nilgo

README

🐃 An opinionated minimalist Go application framework

Nilgo provides an out-of-the-box, cloud-native, production-ready, minimalist Go application framework with opinionated configuration, log, and telemetry for major Cloud providers.

Nilgo is Nilgai in brezhoneg. The nilgai (literally meaning "blue cow") is the largest Asian antelope and is ubiquitous across the northern Indian subcontinent.

Documentation

Overview

Package nilgo provides a simple way to bootstrap an production-ready application.

Index

• type Option
  • func WithLogger(logger *slog.Logger) Option
  • func WithMeterProvider(provider metric.MeterProvider) Option
  • func WithPostRun(runs ...func(context.Context) error) Option
  • func WithPreRun(runs ...func(context.Context) error) Option
  • func WithStartGate(gates ...func(context.Context) error) Option
  • func WithStopGate(gates ...func(context.Context) error) Option
  • func WithTraceProvider(provider trace.TracerProvider) Option
• type Runner
  • func New(opts ...Option) Runner
  • func (r Runner) Run(ctx context.Context, runs ...func(context.Context) error) error

Types

type Option

type Option func(*options)

Option configures the Runner with specific options.

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger provides a slog.Logger to handle logs.

func WithMeterProvider

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider provides OpenTelemetry metric provider.

func WithPostRun

func WithPostRun(runs ...func(context.Context) error) Option

WithPostRun provides runs to execute after the main runs provided in Runner.Run.

func WithPreRun

func WithPreRun(runs ...func(context.Context) error) Option

WithPreRun provides runs to execute before the main runs provided in Runner.Run.

It's guaranteed that all goroutines for pre-runs start before the main runs start, and end after the main runs end if it's blocking with context.Context.Done.

func WithStartGate

func WithStartGate(gates ...func(context.Context) error) Option

WithStartGate provides gates to block the start of main runs provided in Runner.Run, until all start gates returns without error.

All start gates must return in limited time to avoid blocking the main runs.

func WithStopGate

func WithStopGate(gates ...func(context.Context) error) Option

WithStopGate provides gates to block the stop of main runs provided in Runner.Run, until all stop gates returns.

All stop gates must return in limited time to avoid blocking the main runs.

func WithTraceProvider

func WithTraceProvider(provider trace.TracerProvider) Option

WithTraceProvider provides OpenTelemetry trace provider.

type Runner

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

Runner is a pre-configured runtime for executing runs in parallel.

To create an Runner, use New.

func New

func New(opts ...Option) Runner

New creates a new Runner with the given Option(s).

func (Runner) Run

func (r Runner) Run(ctx context.Context, runs ...func(context.Context) error) error

Run executes the given run in parallel with well-configured runtime, which includes logging, configuration, and telemetry.

The run running in parallel without any explicit order, which means it should not have temporal dependencies between each other.

The execution can be interrupted if any run returns non-nil error, or it receives an OS signal syscall.SIGINT or syscall.SIGTERM. It waits all run return unless it's forcefully terminated by OS.

The execution flow is as follows: 1. Starts all pre runs and start gates in parallel. 2. Waits for all pre runs start and start gates complete. 3. Starts all main runs. 4. Waits for OS interrupt or terminal signals or all main runs complete. 5. Waits for all stop gates complete. 6. Stop all main runs. 7. Waits for all post runs complete.