observability

Documentation

Index

• func GenerateAllGluonMetrics() []map[string]interface{}
• func GenerateAllHeartbeatMetricPermutations() []proton.ObservabilityMetric
• func GenerateAllUsedDistinctionMetricPermutations() []proton.ObservabilityMetric
• func ModifyThrottlePeriod(duration time.Duration)
• func ModifyUserMetricInterval(duration time.Duration)
• func VerifyAndParseGenericMetrics(metric map[string]interface{}) (bool, proton.ObservabilityMetric)
• type Adapter
  • func NewAdapter(sender Sender) *Adapter
  • func (adapter *Adapter) AddDistinctMetrics(errType interface{}, metrics ...map[string]interface{})
  • func (adapter *Adapter) AddMetrics(metrics ...map[string]interface{})
• type DistinctionErrorTypeEnum
• type Sender
• type Service
  • func NewService(ctx context.Context, panicHandler async.PanicHandler) *Service
  • func (s *Service) AddDistinctMetrics(errType DistinctionErrorTypeEnum, metrics ...proton.ObservabilityMetric)
  • func (s *Service) AddMetrics(metrics ...proton.ObservabilityMetric)
  • func (s *Service) DeregisterUserClient(userID string)
  • func (s *Service) ModifyHeartbeatInterval(duration time.Duration)
  • func (s *Service) RegisterUserClient(userID string, protonClient *proton.Client, ...)
  • func (s *Service) Run(settingsGetter settingsGetter)
  • func (s *Service) Stop()

Functions

func GenerateAllGluonMetrics

func GenerateAllGluonMetrics() []map[string]interface{}

func GenerateAllHeartbeatMetricPermutations

func GenerateAllHeartbeatMetricPermutations() []proton.ObservabilityMetric

func GenerateAllUsedDistinctionMetricPermutations

func GenerateAllUsedDistinctionMetricPermutations() []proton.ObservabilityMetric

func ModifyThrottlePeriod

func ModifyThrottlePeriod(duration time.Duration)

ModifyThrottlePeriod - used for testing.

func ModifyUserMetricInterval

func ModifyUserMetricInterval(duration time.Duration)

func VerifyAndParseGenericMetrics

func VerifyAndParseGenericMetrics(metric map[string]interface{}) (bool, proton.ObservabilityMetric)

VerifyAndParseGenericMetrics parses a metric provided as an interface into a proton.ObservabilityMetric type. It's exported as it is also used in integration tests.

Types

type Adapter

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

func NewAdapter

func NewAdapter(sender Sender) *Adapter

func (*Adapter) AddDistinctMetrics

func (adapter *Adapter) AddDistinctMetrics(errType interface{}, metrics ...map[string]interface{})

func (*Adapter) AddMetrics

func (adapter *Adapter) AddMetrics(metrics ...map[string]interface{})

type DistinctionErrorTypeEnum

type DistinctionErrorTypeEnum int

DistinctionErrorTypeEnum - maps to the specific error schema for which we want to send a user update.

const (
	SyncError DistinctionErrorTypeEnum = iota
	GluonImapError
	GluonMessageError
	GluonOtherError
	SMTPError
	EventLoopError // EventLoopError - should always be kept last when inserting new keys.
)

type Sender

type Sender interface {
	AddMetrics(metrics ...proton.ObservabilityMetric)
	AddDistinctMetrics(errType DistinctionErrorTypeEnum, metrics ...proton.ObservabilityMetric)
}

Sender - interface maps to the observability service methods, so we can easily pass them down to relevant components.

type Service

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

func NewService

func NewService(ctx context.Context, panicHandler async.PanicHandler) *Service

func (*Service) AddDistinctMetrics

func (s *Service) AddDistinctMetrics(errType DistinctionErrorTypeEnum, metrics ...proton.ObservabilityMetric)

AddDistinctMetrics - sends an additional metric related to the user, so we can determine what number of events come from what number of users. As the binning interval is what allows us to do this we should not send these if there are no logged-in users at that moment.

func (*Service) AddMetrics

func (s *Service) AddMetrics(metrics ...proton.ObservabilityMetric)

func (*Service) DeregisterUserClient

func (s *Service) DeregisterUserClient(userID string)

func (*Service) ModifyHeartbeatInterval

func (s *Service) ModifyHeartbeatInterval(duration time.Duration)

ModifyHeartbeatInterval - should only be used for testing. Resets the heartbeat ticker.

func (*Service) RegisterUserClient

func (s *Service) RegisterUserClient(userID string, protonClient *proton.Client, telemetryService *telemetry.Service)

func (*Service) Run

func (s *Service) Run(settingsGetter settingsGetter)

Run starts the observability service goroutine. The function also sets some utility functions to a helper struct aimed at differentiating the amount of users sending metric updates.

func (*Service) Stop

func (s *Service) Stop()