internal

Documentation

Overview

Package internal offers helper interfaces that are internal to the Wavefront Go SDK. Interfaces within this package are not guaranteed to be backwards compatible between releases.

Index

• Constants
• func DeltaCounterName(name string) string
• func GetBuffer() *bytes.Buffer
• func GetHostname(defaultVal string) string
• func GetSemVer(version string) (float64, error)
• func HasDeltaPrefix(name string) bool
• func PutBuffer(buf *bytes.Buffer)
• func Sanitize(str string) string
• func SanitizeValue(str string) string
• type ConnectionHandler
• type Flusher
• type LineHandler
• type LineHandlerOption
  • func SetHandlerPrefix(prefix string) LineHandlerOption
  • func SetLockOnThrottledError(lock bool) LineHandlerOption
  • func SetRegistry(registry sdkmetrics.Registry) LineHandlerOption
• type RealLineHandler
  • func NewLineHandler(reporter Reporter, format string, flushInterval time.Duration, ...) *RealLineHandler
  • func (lh *RealLineHandler) Flush() error
  • func (lh *RealLineHandler) FlushAll() error
  • func (lh *RealLineHandler) GetFailureCount() int64
  • func (lh *RealLineHandler) GetThrottledCount() int64
  • func (lh *RealLineHandler) HandleLine(line string) error
  • func (lh *RealLineHandler) Start()
  • func (lh *RealLineHandler) Stop()
• type Reporter
  • func NewReporter(server string, tokenService auth.Service, client *http.Client) Reporter

Constants

const (
	DeltaPrefix    = "\u2206"
	AltDeltaPrefix = "\u0394"
)

const (
	MetricFormat    = "wavefront"
	HistogramFormat = "histogram"
	TraceFormat     = "trace"
	SpanLogsFormat  = "spanLogs"
	EventFormat     = "event"
)

Functions

func DeltaCounterName

func DeltaCounterName(name string) string

Gets a delta counter name prefixed with ∆.

func GetBuffer

func GetBuffer() *bytes.Buffer

GetBuffer fetches a buffers from the pool

func GetHostname

func GetHostname(defaultVal string) string

func GetSemVer

func GetSemVer(version string) (float64, error)

func HasDeltaPrefix

func HasDeltaPrefix(name string) bool

func PutBuffer

func PutBuffer(buf *bytes.Buffer)

PutBuffer returns a buffers to the pool

func Sanitize

func Sanitize(str string) string

Sanitize sanitizes string of metric name, source and key of tags according to the rule of Wavefront proxy.

func SanitizeValue

func SanitizeValue(str string) string

SanitizeValue sanitizes string of tags value, etc.

Types

type ConnectionHandler

type ConnectionHandler interface {
	Connect() error
	Connected() bool
	Close()
	SendData(lines string) error

	Flusher
}

type Flusher

type Flusher interface {
	Flush() error
	GetFailureCount() int64
	Start()
}

type LineHandler

type LineHandler interface {
	HandleLine(line string) error
	Start()
	Stop()
	Flush() error
	GetFailureCount() int64
}

type LineHandlerOption

type LineHandlerOption func(*RealLineHandler)

func SetHandlerPrefix

func SetHandlerPrefix(prefix string) LineHandlerOption

func SetLockOnThrottledError

func SetLockOnThrottledError(lock bool) LineHandlerOption

func SetRegistry

func SetRegistry(registry sdkmetrics.Registry) LineHandlerOption

type RealLineHandler

type RealLineHandler struct {
	Reporter      Reporter
	BatchSize     int
	MaxBufferSize int
	Format        string
	// contains filtered or unexported fields
}

func NewLineHandler

func NewLineHandler(reporter Reporter, format string, flushInterval time.Duration, batchSize, maxBufferSize int, setters ...LineHandlerOption) *RealLineHandler

func (*RealLineHandler) Flush

func (lh *RealLineHandler) Flush() error

func (*RealLineHandler) FlushAll

func (lh *RealLineHandler) FlushAll() error

func (*RealLineHandler) GetFailureCount

func (lh *RealLineHandler) GetFailureCount() int64

func (*RealLineHandler) GetThrottledCount

func (lh *RealLineHandler) GetThrottledCount() int64

GetThrottledCount returns the number of Throttled errors received.

func (*RealLineHandler) HandleLine

func (lh *RealLineHandler) HandleLine(line string) error

func (*RealLineHandler) Start

func (lh *RealLineHandler) Start()

func (*RealLineHandler) Stop

func (lh *RealLineHandler) Stop()

type Reporter

type Reporter interface {
	Report(format string, pointLines string) (*http.Response, error)
	ReportEvent(event string) (*http.Response, error)
}

Reporter is an interface for reporting data to a Wavefront service.

func NewReporter

func NewReporter(server string, tokenService auth.Service, client *http.Client) Reporter

NewReporter creates a metrics Reporter