statsd

Documentation

Overview

Package statsd implements a component to get a statsd client.

Index

• func Module() fxutil.Module
• type Component

Functions

func Module

func Module() fxutil.Module

Module defines the fx options for this component.

Types

type Component

type Component interface {
	// Get a pre-configured and shared statsd client (requires STATSD_URL to be set)
	// The client gets created uppon the first Get() call
	Get() (ddgostatsd.ClientInterface, error)

	// Create a pre-configured statsd client
	Create(options ...ddgostatsd.Option) (ddgostatsd.ClientInterface, error)

	// CreateForAddr returns a pre-configured statsd client that defaults to `addr` if no env var is set
	CreateForAddr(addr string, options ...ddgostatsd.Option) (ddgostatsd.ClientInterface, error)

	// CreateForHostPort returns a pre-configured statsd client that defaults to `host:port` if no env var is set
	CreateForHostPort(host string, port int, options ...ddgostatsd.Option) (ddgostatsd.ClientInterface, error)
}

Component is the component type.