graphite

Documentation

Index

• Constants
• func NewClientFromViper(v *viper.Viper) (gostatsd.Backend, error)
• type Client
  • func NewClient(config *Config) (*Client, error)
  • func (client *Client) Name() string
  • func (client *Client) Run(ctx context.Context)
  • func (client *Client) SendEvent(ctx context.Context, e *gostatsd.Event) error
  • func (client *Client) SendMetricsAsync(ctx context.Context, metrics *gostatsd.MetricMap, cb gostatsd.SendCallback)
• type Config

Constants

const (
	// BackendName is the name of this backend.
	BackendName = "graphite"
	// DefaultAddress is the default address of Graphite server.
	DefaultAddress = "localhost:2003"
	// DefaultDialTimeout is the default net.Dial timeout.
	DefaultDialTimeout = 5 * time.Second
	// DefaultWriteTimeout is the default socket write timeout.
	DefaultWriteTimeout = 30 * time.Second
	// DefaultGlobalPrefix is the default global prefix.
	DefaultGlobalPrefix = "stats"
	// DefaultPrefixCounter is the default counters prefix.
	DefaultPrefixCounter = "counters"
	// DefaultPrefixTimer is the default timers prefix.
	DefaultPrefixTimer = "timers"
	// DefaultPrefixGauge is the default gauges prefix.
	DefaultPrefixGauge = "gauges"
	// DefaultPrefixSet is the default sets prefix.
	DefaultPrefixSet = "sets"
	// DefaultGlobalSuffix is the default global suffix.
	DefaultGlobalSuffix = ""
	// DefaultLegacyNamespace controls whether legacy namespace should be used by default.
	DefaultLegacyNamespace = true
)

Functions

func NewClientFromViper

func NewClientFromViper(v *viper.Viper) (gostatsd.Backend, error)

NewClientFromViper constructs a GraphiteClient object by connecting to an address.

Types

type Client

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

Client is an object that is used to send messages to a Graphite server's TCP interface.

func NewClient

func NewClient(config *Config) (*Client, error)

NewClient constructs a Graphite backend object.

func (*Client) Name

func (client *Client) Name() string

Name returns the name of the backend.

func (*Client) Run

func (client *Client) Run(ctx context.Context)

func (*Client) SendEvent

func (client *Client) SendEvent(ctx context.Context, e *gostatsd.Event) error

SendEvent discards events.

func (*Client) SendMetricsAsync

func (client *Client) SendMetricsAsync(ctx context.Context, metrics *gostatsd.MetricMap, cb gostatsd.SendCallback)

SendMetricsAsync flushes the metrics to the Graphite server, preparing payload synchronously but doing the send asynchronously.

type Config

type Config struct {
	Address         *string
	DialTimeout     *time.Duration
	WriteTimeout    *time.Duration
	GlobalPrefix    *string
	PrefixCounter   *string
	PrefixTimer     *string
	PrefixGauge     *string
	PrefixSet       *string
	GlobalSuffix    *string
	LegacyNamespace *bool
}

Config holds configuration for the Graphite backend.