veneur

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(addr string) *Client
  • func NewClientGlobal(addr string) *Client
  • func NewClientWith(config ClientConfig) *Client
  • func (c *Client) HandleMeasures(time time.Time, measures ...stats.Measure)
• type ClientConfig

Constants

const (
	GlobalOnly = "veneurglobalonly"
	LocalOnly  = "veneurlocalonly"
	SinkOnly   = "veneursinkonly"

	SignalfxSink = "signalfx"
	DatadogSink  = "datadog"
	KafkaSink    = "kafka"
)

Const Sink Configuration types.

Variables

var (
	TagSignalfxOnly = stats.Tag{Name: SinkOnly, Value: SignalfxSink}
	TagDatadogOnly  = stats.Tag{Name: SinkOnly, Value: DatadogSink}
	TagKafkaOnly    = stats.Tag{Name: SinkOnly, Value: KafkaSink}
)

SinkOnly tags.

Types

type Client

type Client struct {
	*datadog.Client
	// contains filtered or unexported fields
}

Client represents an veneur client that implements the stats.Handler interface.

func NewClient

func NewClient(addr string) *Client

NewClient creates and returns a new veneur client publishing metrics to the server running at addr.

func NewClientGlobal

func NewClientGlobal(addr string) *Client

NewClientGlobal creates a client that sends all metrics to the Global Veneur Aggregator.

func NewClientWith

func NewClientWith(config ClientConfig) *Client

NewClientWith creates and returns a new veneur client configured with the given config.

func (*Client) HandleMeasures

func (c *Client) HandleMeasures(time time.Time, measures ...stats.Measure)

HandleMeasures satisfies the stats.Handler interface.

type ClientConfig

type ClientConfig struct {
	datadog.ClientConfig

	// Veneur Specific Configuration
	// If set true, all metrics will be sent with veneurglobalonly tag
	GlobalOnly bool

	// If set true, all metrics will be sent with veneurlocalonly tag
	// Cannot be set in conjunction with GlobalOnly
	LocalOnly bool

	// Adds veneursinkonly:<sink> tag to all metrics. Valid sinks can be
	// found here: https://github.com/stripe/veneur#routing-metrics
	SinksOnly []string
}

The ClientConfig type is used to configure veneur clients. It inherits the datadog config since the veneur client reuses the logic in the datadog client to emit metrics.