metrics

Documentation

Overview

Package metrics implements the metrics.core microservice.

The Metrics service is a core microservice that aggregates metrics from other microservices and makes them available for collection.

Index

• Constants
• type Mock
  • func NewMock() *Mock
• type Service
  • func NewService() *Service
  • func (svc *Service) Collect(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Service) Init(initializer func(svc *Service)) *Service
  • func (svc *Service) OnShutdown(ctx context.Context) (err error)
  • func (svc *Service) OnStartup(ctx context.Context) (err error)

Constants

const Hostname = "metrics.core"

Hostname is the default hostname of the microservice: metrics.core.

const SourceCodeSHA256 = "fa26a2a78b68327051b1401a423f0a6962bd8ebd25fc05556c032aab5ab0a938"

const Timestamp = "2024-08-01T15:49:25.026412Z"

const Version = 143

Types

type Mock

type Mock = intermediate.Mock

Mock is a mockable version of the metrics.core microservice, allowing functions, event sinks and web handlers to be mocked.

func NewMock

func NewMock() *Mock

New creates a new mockable version of the microservice.

type Service

type Service struct {
	*intermediate.Intermediate // DO NOT REMOVE
}

Service implements the metrics.core microservice.

The Metrics service is a core microservice that aggregates metrics from other microservices and makes them available for collection.

func NewService

func NewService() *Service

NewService creates a new metrics.core microservice.

func (*Service) Collect

func (svc *Service) Collect(w http.ResponseWriter, r *http.Request) (err error)

Collect returns the latest aggregated metrics.

func (*Service) Init

func (svc *Service) Init(initializer func(svc *Service)) *Service

Init enables a single-statement pattern for initializing the microservice.

svc.Init(func(svc Service) {
	svc.SetGreeting("Hello")
})

func (*Service) OnShutdown

func (svc *Service) OnShutdown(ctx context.Context) (err error)

OnShutdown is called when the microservice is shut down.

func (*Service) OnStartup

func (svc *Service) OnStartup(ctx context.Context) (err error)

OnStartup is called when the microservice is started up.