status

Documentation

Index

• Constants
• func Debug(message string, opts ...StatusOption)
• func Error(message string, opts ...StatusOption)
• func Info(message string, opts ...StatusOption)
• func InitService() error
• func Subscribe(ctx context.Context) <-chan pubsub.Event[StatusMessage]
• func Warn(message string, opts ...StatusOption)
• type Level
• type Service
  • func GetService() Service
• type StatusMessage
• type StatusOption
  • func WithCritical(critical bool) StatusOption
  • func WithDuration(duration time.Duration) StatusOption

Constants

const (
	EventStatusPublished pubsub.EventType = "status_published"
)

Functions

func Debug

func Debug(message string, opts ...StatusOption)

func Error

func Error(message string, opts ...StatusOption)

func Info

func Info(message string, opts ...StatusOption)

func InitService

func InitService() error

func Subscribe

func Subscribe(ctx context.Context) <-chan pubsub.Event[StatusMessage]

func Warn

func Warn(message string, opts ...StatusOption)

Types

type Level

type Level string

const (
	LevelInfo  Level = "info"
	LevelWarn  Level = "warn"
	LevelError Level = "error"
	LevelDebug Level = "debug"
)

type Service

type Service interface {
	pubsub.Subscriber[StatusMessage]

	Info(message string, opts ...StatusOption)
	Warn(message string, opts ...StatusOption)
	Error(message string, opts ...StatusOption)
	Debug(message string, opts ...StatusOption)
}

func GetService

func GetService() Service

type StatusMessage

type StatusMessage struct {
	Level     Level         `json:"level"`
	Message   string        `json:"message"`
	Timestamp time.Time     `json:"timestamp"`
	Critical  bool          `json:"critical"`
	Duration  time.Duration `json:"duration"`
}

type StatusOption

type StatusOption func(*StatusMessage)

StatusOption is a function that configures a status message

func WithCritical

func WithCritical(critical bool) StatusOption

WithCritical marks a status message as critical, causing it to be displayed immediately

func WithDuration

func WithDuration(duration time.Duration) StatusOption

WithDuration sets a custom display duration for a status message