metrics

package
v1.8.0-fossa.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 7, 2024 License: AGPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MetricsSubsystem

type MetricsSubsystem struct {
	Server  *server.Server
	Options *Options
	// contains filtered or unexported fields
}

Metrics Subsystem uses dogstatsd to submit metrics for queues middleware is used to send metrics for suceeded/failed job count and time to complete a task is used to track the count of each queue and how long the next job has been waiting

func (*MetricsSubsystem) Name

func (m *MetricsSubsystem) Name() string

Name - returns the name of the subsystem or plugin

func (*MetricsSubsystem) PrefixMetricName

func (m *MetricsSubsystem) PrefixMetricName(metricName string) string

PrefixMetricName - adds configured namespace to the metric

func (*MetricsSubsystem) Reload

func (m *MetricsSubsystem) Reload(s *server.Server) error

Reload - the config is reloaded by faktory hot reload is currently unsupported

func (*MetricsSubsystem) Shutdown

func (m *MetricsSubsystem) Shutdown(s *server.Server) error

Shutdown - nothing needs to be done but the function must exist for subsystems

func (*MetricsSubsystem) Start

func (m *MetricsSubsystem) Start(s *server.Server) error

Start starts the subsystem get options from global config "metrics"

func (*MetricsSubsystem) StatsDClient

func (m *MetricsSubsystem) StatsDClient() statsd.ClientInterface

StatsDClient returns the statsd client

type Options

type Options struct {
	// Enabled controls whether or not the plugin will function
	Enabled bool
	// Tags sent to datdog
	Tags []string
	// Prefix for metrics
	Namespace string
}

Options for the plugin

Directories

Path Synopsis
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL