pubsub

Documentation

Overview

Package pubsub provides a notifier that subscribes to an PubSub topic that watches change of configuration on GCP.

It requires following roles on the target project:

• roles/pubsub.editor

Index

• type Notifier
  • func NewNotifier(topic string, opts ...Option) *Notifier
  • func (n *Notifier) Register(loaders ...loader)
  • func (n *Notifier) Start(ctx context.Context) error
• type Option
  • func WithLogHandler(handler slog.Handler) Option
  • func WithProject(project string) Option

Types

type Notifier

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

Notifier that watches change events on given PubSub topic.

To create a new Notifier, call NewNotifier.

func NewNotifier

func NewNotifier(topic string, opts ...Option) *Notifier

NewNotifier creates a Notifier with the given PubSub topic.

func (*Notifier) Register

func (n *Notifier) Register(loaders ...loader)

Register registers a loader to the Notifier.

func (*Notifier) Start

func (n *Notifier) Start(ctx context.Context) error

Start starts watching events on given PubSub topic and fanout to registered loaders. It blocks until ctx is done, or it returns an error.

type Option

type Option = option.ClientOption

Option configures the Notifier with specific options.

func WithLogHandler

func WithLogHandler(handler slog.Handler) Option

WithLogHandler provides the slog.Handler for logs from notifier.

By default, it uses handler from slog.Default().

func WithProject

func WithProject(project string) Option

WithProject provides GCP project ID.

By default, it fetches project ID from metadata server.