metrics

Documentation

Overview

Package metrics provides a wrapper to interact with StatsD.

Index

• Constants
• Variables
• type Client
  • func NewClient(ctx context.Context, logger *slog.Logger, cfg config.MetricsConfig) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) Flush()
  • func (c *Client) Gauge(name string, value int, tags []string)
  • func (c *Client) ServiceCheck(status byte, message string, tags []string)

Constants

const (
	// DefaultMetricsClientAddr is the default metrics client address.
	DefaultMetricsClientAddr = "localhost:8125"
)

Variables

var (
	// ClientNotInitializedMsg is logged when the metrics client is not
	// initialized and metrics are enabled.
	ClientNotInitializedMsg = "metrics client not initialized"
)

Types

type Client

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

Client represents a metrics service client.

func NewClient

func NewClient(ctx context.Context, logger *slog.Logger, cfg config.MetricsConfig) (*Client, error)

NewClient creates a new metrics client based on environment variables config.

func (*Client) Close

func (c *Client) Close()

Close closes the metrics client.

func (*Client) Flush

func (c *Client) Flush()

Flush flushes the metrics client.

func (*Client) Gauge

func (c *Client) Gauge(name string, value int, tags []string)

Gauge sends a gauge metric to the metrics service.

func (*Client) ServiceCheck

func (c *Client) ServiceCheck(status byte, message string, tags []string)

ServiceCheck sends a service satus signal to the metrics service.