publisher

Documentation

Overview

Package publisher manages the publishing of metrics.

Index

• Constants
• type Collector
• type Publish
  • func New(log *logger.Logger, collector Collector, interval time.Duration, ...) (*Publish, error)
  • func (p *Publish) Stop()
• type Publisher
• type Stdout
  • func NewStdout(log *logger.Logger) *Stdout
  • func (s *Stdout) Publish(data map[string]any)

Constants

const (
	TypeStdout  = "stdout"
	TypeDatadog = "datadog"
)

Set of possible publisher types.

Types

type Collector

type Collector interface {
	Collect() (map[string]any, error)
}

Collector defines a contract a collector must support so a consumer can retrieve metrics.

type Publish

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

Publish provides the ability to receive metrics on an interval.

func New

func New(log *logger.Logger, collector Collector, interval time.Duration, publisher ...Publisher) (*Publish, error)

New creates a Publish for consuming and publishing metrics.

func (*Publish) Stop

func (p *Publish) Stop()

Stop is used to shut down the goroutine collecting metrics.

type Publisher

type Publisher func(map[string]any)

Publisher defines a handler function that will be called on each interval.

type Stdout

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

Stdout provide our basic publishing.

func NewStdout

func NewStdout(log *logger.Logger) *Stdout

NewStdout initializes stdout for publishing metrics.

func (*Stdout) Publish

func (s *Stdout) Publish(data map[string]any)

Publish publishers for writing to stdout.